Probe a connection

Runs the connector’s declared health check against the stored credential and reports what came back. It only reports: an expired token refreshes on its own.

POST /v1/connectors/connections/{connectionId}/health

Authorization

Authorization Bearer token · header required

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

or

Authorization OAuth2 access token · header required

OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.

Scopes: connectors:read

Path parameters

connectionId string required

min length 1

Query parameters

team string

min length 1 · max length 255

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

A live probe of one connection. Token refresh happens automatically; this only reports.

Show properties Hide properties

connectionId string required

status string required

State after this probe.

Allowed: pending_authorization active degraded needs_reauth revoked

reachable boolean required

Whether the provider answered.

latencyMs integer | any required

Round trip of the probe; null when it never got an answer.

Show properties Hide properties

Any of:

integer

integer

any

any

detail string | any required

What went wrong, when something did.

Show properties Hide properties

Any of:

string

string

any

any

toolCount integer required

Tools reachable right now.

min -9007199254740991 · max 9007199254740991

checkedAt 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 Problem details (RFC 9457). Any 4xx/5xx response is one application/problem+json document.

$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

connectionId path* team query

Send

Request

curl -X POST "https://api.spacefast.com/v1/connectors/connections/string/health" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.spacefast.com/v1/connectors/connections/string/health", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://api.spacefast.com/v1/connectors/connections/string/health",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

200 default

{
  "$schema": "http://example.com",
  "data": {
    "connectionId": "string",
    "status": "pending_authorization",
    "reachable": true,
    "latencyMs": -9007199254740991,
    "detail": "string",
    "toolCount": -9007199254740991,
    "checkedAt": "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"
}