Skip to main content
POST
Check a connection against the provider and try minting a token

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Path Parameters

connection_id
string<uuid>
required

Integration connection id (UUID) as returned by listIntegrationConnections.

Response

Result of a live health check against one integration connection: its refreshed state at the provider, whether a token could be minted, and what is missing if not. A failed check is reported here rather than as an HTTP error.

Result of a live health check against one integration connection: its refreshed state at the provider, whether a token could be minted, and what is missing if not. A failed check is reported here rather than as an HTTP error.

ok
boolean
required

True only when the connection is active at the provider and a scoped token was successfully minted during this probe. False means the connection cannot currently be used; read failure for why. A probe that fails this way is still an HTTP 200.

resource_count
integer
required

Number of provider resources the connection can authorize, for example selected GitHub repositories. The live probe credential may be narrower when the provider cannot represent the entire connection scope in one token. Zero when no token could be minted.

state
string
required

Lifecycle of the connection as of this probe: pending (registered, waiting for the customer to grant trust), active (usable), suspended (paused at the provider), or revoked (uninstalled or deleted). Refreshed here, so it can differ from the previously stored value: a pending connection whose trust proved usable is reported active.

token_minted
boolean
required

Whether a scoped credential could actually be issued during this probe. This is the check that predicts whether a session using the connection will work.

activated
boolean

True when this probe moved a pending connection to active by proving its trust with a successful mint. Omitted (false) on every later probe of the same connection.

failure
string

Human-readable reason the probe did not succeed, such as a suspended install or a rejected mint. Empty when ok is true.

missing_permissions
string[]

Permissions this service requires that the install has not granted at the required level. Reported, not enforced: accept the provider's pending permission request to clear them.