Get a Space's diagnostics

Returns the diagnostics recorded against the Space’s versions, newest first, ahead of them current entries for a disabled Space, for a runtime that is still provisioning or has failed, and for every attached domain that is neither active nor unassigned. A disabled Space still answers.

GET /v1/spaces/{spaceId}/diagnostics

Authorization

Authorization Bearer token · header required

Authorization: Bearer <key> with the Space key (sfc_ prefix) of an unclaimed Space. The same key is the fragment of the claim URL and the token in the Space's /_/<key> sign-in URL.

or

Authorization Bearer token · header required

Authorization: Bearer <token> with an API key (sfa_ prefix), an OAuth access token, a session token, or a Space machine credential (sfm_ prefix).

Path parameters

spaceId string required

min length 1

Responses

200 Response for status 200

$schema string

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

data object[] required

Show propertiesHide properties

Array of object

• code string required

  Stable snake_case code for this diagnostic.

• severity string required

How serious the diagnostic is.

Allowed: info, warning, error

• message string required

What happened, in a sentence a person can act on.

• path string | any

File or artifact path the diagnostic refers to, with a line number when known, for example _headers:12. Absent when it applies to the whole resource.

Show propertiesHide properties

Any of:

• string

• any

• provider string | any

Upstream system that raised the diagnostic. Absent when Spacefast raised it.

Show propertiesHide properties

Any of:

• string

• any

• details object | any

Machine-readable context keyed by the diagnostic code.

Show propertiesHide properties

Any of:

• object

• any

• fix string | any

What to change to clear the diagnostic. Absent when there is no known fix.

Show propertiesHide properties

Any of:

• string

• any

• retryable boolean | any

True when repeating the same operation unchanged can clear the diagnostic.

Show propertiesHide properties

Any of:

• boolean

• any

• id string required

Identifier of the stored diagnostic, stable across reads.

• versionId string required

Version this diagnostic was raised against.

• createdAt string required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$

default Error

Every 4xx and 5xx response is one RFC 9457 problem document served as application/problem+json.

• $schema string

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

• type string required

URL of the documentation page for this error. Derived from code.

• title string required

Human-readable name of the error type. Derived from code.

• status integer required

HTTP status of the response, repeated in the body.

min -9007199254740991 · max 9007199254740991

• detail string required

What went wrong in this request.

• code string required

Stable snake_case error code. Match on this, not on detail.

• pointer string

RFC 6901 JSON Pointer to the request field or batch entry that failed, for example /files/37/path. Present on validation failures.

• details object

Machine-readable context keyed by the error code.

• suggestions string[]

Recovery steps safe to show to a person.

• next string[]

Commands or API requests to run next, usable as written.

• requestId string required

ID of this request, from the X-Request-Id header or generated. Quote it when contacting support.

Try it

Server

Base URL https://api.spacefast.com

Custom base URL Overrides the selected server when set.

Authorization

Bearer token Remember on this device Include my values in samples

Parameters

spaceId path*

Send

Request

cURL

curl -X GET "https://api.spacefast.com/v1/spaces/string/diagnostics" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.spacefast.com/v1/spaces/string/diagnostics", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Python

import requests

response = requests.get(
    "https://api.spacefast.com/v1/spaces/string/diagnostics",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

200 default

{
  "$schema": "http://example.com",
  "data": [
    {
      "code": "string",
      "severity": "info",
      "message": "string",
      "path": "string",
      "provider": "infra",
      "details": {
        "property1": null,
        "property2": null
      },
      "fix": "string",
      "retryable": true,
      "id": "string",
      "versionId": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "$schema": "http://example.com",
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "pointer": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "suggestions": [
    "string"
  ],
  "next": [
    "string"
  ],
  "requestId": "string"
}