v50

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-01147180956.9 KB

Credentials

Update or rotate credential

Update or rotate a credential.

patch/credentials/{credential_id}

Path parameters

credential_idstring required

Request body

Response

Successful Response

activeboolean required

Whether the credential is enabled for injection.

catalog_api_idstring nullable

Catalog identity slug of the target API (domain[/sub-api]), when recorded at create time. Display-only; null for older credentials.

created_atstring date-time required

Creation timestamp (UTC).

created_bystring nullable

Identity that created the credential (its owner).

credential_idstring required

Stable credential identifier, prefixed cred_.

detailsobject nullable

Redacted, type-specific projection (hints/last-N chars; never the secret). For oauth2: client_id, token_url, grant_type (authorization_code | client_credentials), scopes, and — for authorization_code only — connected, whether the interactive sign-in completed and is still usable (null for other grants).

namestring required

Human-readable label.

providerstring required

Credential provider; 'static' for stored secrets.

provider_account_refstring nullable

Opaque reference to the provider account, when applicable.

server_variablesobject nullable

OpenAPI server-variable values for URL template substitution.

type'bearer_token' | 'api_key' | 'basic' | 'oauth2' | 'no_auth' required

Wire-level credential type used by the provider abstraction.

updated_atstring date-time nullable

Last update timestamp (UTC).

Example response

{
  "active": true,
  "api": {
    "name": "stripe",
    "vendor": "stripe.com",
    "version": "2024-04-10"
  },
  "created_at": "2026-01-15T09:30:00Z",
  "credential_id": "cred_01HZX9...",
  "details": {
    "field_name": "Authorization",
    "hint": "…live_abcd",
    "location": "header"
  },
  "name": "Stripe live key",
  "provider": "static",
  "type": "api_key"
}