Skip to main content
GET
Read a provider key

Authorizations

X-API-Key
string
header
required

Path Parameters

integration_type
string
required
Required string length: 1 - 64

Response

Successful Response

A workspace's key with one provider. Never the key: its last four characters.

checked_at
string<date-time> | null
required

When the provider last answered a check.

created_at
string<date-time>
required
created_by_user_id
string | null
required
credits_remaining
integer | null
required

The provider's own balance on the key at the last check, in the provider's units; null for a provider that does not report one.

health
enum<string>
required

unchecked (saved while the provider could not be reached), healthy, out_of_credits or invalid (the provider refused it).

Available options:
unchecked,
healthy,
out_of_credits,
invalid
health_detail
string | null
required

Why the key is not healthy, when it is not.

id
string<uuid>
required
integration_type
string
required

The provider.

key_hint
string
required

The key's last four characters.

provider_name
string
required

The provider's name.

running_low
boolean
required

Whether a working key has fewer of the provider's own credits left than the mark at which the workspace is told it is running low.

updated_at
string<date-time>
required
updated_by_user_id
string | null
required