Skip to main content
GET
Validate API Key
Read only Validate an API key before a configuration test, SDK initialization, or deployment. The request checks credentials and returns key and workspace metadata without creating resources or placing calls.

Before you begin

  • Create a workspace API key.
  • Use the complete key_id:secret value in the Bearer header. A dashboard cookie session is not accepted.

Validate API Key Request

Verify the result

A 200 response contains data.valid: true, data.key, data.organization.id, and data.access_type: "private". Confirm the workspace ID matches your intended workspace. The key secret is never returned. The response uses Cache-Control: no-store.

Errors and recovery

401 means the credential is missing, malformed, unknown, expired, or revoked. Replace the credential or regenerate the key, then repeat this read-only request. An invalid key produces an error, not a successful response with valid: false.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response.

success
boolean
required
error
boolean
required
statusCode
integer
required
message
string
required
data
object
required
timestamp
string<date-time>
required