Sign in
Credentials

Update or rotate credential

Update or rotate a credential.

patch/credentials/{credential_id}

Path parameters

credential_idstring required

Request body

OR
OR
OR
OR

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' | 'sigv4' 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"
}

Changes

Changed in 5 of the 85 revisions of this API.161129

  • 4d30025450c712See the full diff
    • ●

      added the new sigv4 enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added sigv4 mapping keys to the request discriminator

      request-body-discriminator-mapping-added

    • ○

      added Sigv4UpdateRequest to the request body oneOf list

      request-body-one-of-added

  • 3746d110464c1See the full diff
    • ○

      added the optional property catalog_api_id to the response with the 200 status

      response-optional-property-added

  • 7f8d4d76abcd1See the full diff
    • ●

      added the new no_auth enum value to the type response property for the response status 200

      response-property-enum-value-added

  • e7b87904bdbb1See the full diff
    • ○

      added the optional property created_by to the response with the 200 status

      response-optional-property-added

  • 76e8f606372816925See the full diff
    • ▲

      removed BearerTokenUpdateRequest ApiKeyUpdateRequest BasicAuthUpdateRequest OAuth2UpdateRequest from the request body oneOf list

      request-body-one-of-removed

    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ▲

      media type application/problem+json was changed to a more general media type application/json for the response status 422

      response-media-type-name-generalized

    • ▲

      the response property created_at became optional for the status 200

      response-property-became-optional

    • ▲

      the response property detail became optional for the status 422

      response-property-became-optional

    • ▲

      response property created_at list-of-types was widened by adding types null and number to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property updated_at list-of-types was widened by adding types number to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      the detail response property's maxLength was unset from 4096 for the response status 422

      response-property-max-length-unset

    • ▲

      the detail response's property type/format changed from string/ to array/ for status 422

      response-property-type-changed

    • ▲

      the updated_at/anyOf[subschema #1]/ response's property type/format changed from string/date-time to number/ for status 200

      response-property-type-changed

    • ▲

      removed the required property active from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property api from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property credential_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property name from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property provider from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property type from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property code from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property errors from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property instance from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property provider_account_ref from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property server_variables from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property title from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property type from the response with the 422 status

      response-optional-property-removed

    • ○

      api operation id updateCredential removed and replaced with patch_credentials__cid__patch

      api-operation-id-removed

    • ○

      the endpoint scheme security HumanLogin was added to the API

      api-security-added

    • ○

      the endpoint scheme security BearerAuth was removed from the API

      api-security-removed

    • ○

      api tag credentials added

      api-tag-added

    • ○

      api tag Credentials removed

      api-tag-removed

    • ○

      added the new optional request property api_id

      new-optional-request-property

    • ○

      added the new optional request property auth_type

      new-optional-request-property

    • ○

      added the new optional request property identity

      new-optional-request-property

    • ○

      added the new optional request property label

      new-optional-request-property

    • ○

      added the new optional request property value

      new-optional-request-property

    • ○

      removed request discriminator

      request-body-discriminator-removed

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 503

      response-non-success-status-removed

    • ○

      added the optional property account_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property api_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property app_slug to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property auth_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property identity to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property synced_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property label to the response with the 200 status

      response-required-property-added

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog