Documentation menu

Auth

1 operations.

MethodEndpointDescription
POST/api/v1/api-keys/validateValidate API key

Validate API key

POST /api/v1/api-keys/validate

Checks the API key used in the Authorization header and returns its user, Organization, declared grants, and expiry.

Purpose

  • Validates API key via Authorization header
  • Returns Organization, Project, Environment, and Agent grants
  • Resource operations still check current user permissions and key scope

Authentication

  • Requires valid API key via Authorization: Bearer header
  • The API key being validated is the one used for authentication

Responses

StatusDescriptionBody
200Response for status 200application/json — object — valid: true (required); data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)