credentials

Update an upstream API credential — rotate a secret or fix its API binding

Update a credential's label, secret value, identity field, API binding, or auth_type.

Common use cases:

  • Rotate an expired token or password (update value)
  • Fix incorrect API binding (update api_id)
  • Add username to existing credential (update identity)
  • Relabel for clarity (update label)

Only changed fields need to be included in the request body. Omitted fields are left unchanged.

Auth: Requires human session OR agent key with explicit PATCH /credentials allow rule on jentic-mini credential.

patch/credentials/{cid}

Path parameters

cidstring required

Credential ID to update

Credential ID to update

Request body

labelstring nullable

New credential label (optional)

valuestring nullable

New credential value for rotation (optional, encrypted before storage)

identitystring nullable

New identity value (optional)

api_idstring nullable

New API ID to rebind this credential (optional)

auth_type'bearer' | 'basic' | 'apiKey' nullable

Update the auth type for this credential. See POST /credentials for valid values and semantics.

Response

Successful Response

idstring required

Credential ID

labelstring required

Human-readable label for this credential

identitystring nullable

Identity field (username, client ID, etc.) for basic auth or compound API key schemes

api_idstring nullable

API this credential is bound to

auth_typestring nullable

Auth type: bearer, basic, or apiKey

created_atnumber nullable

Unix timestamp when created

updated_atnumber nullable

Unix timestamp of last update

account_idstring nullable

OAuth broker account ID (if from OAuth broker)

app_slugstring nullable

OAuth app slug (if from OAuth broker)

synced_atnumber nullable

Unix timestamp of last OAuth sync

Example response

{
  "id": "cred_abc123xyz",
  "label": "GitHub PAT for jentic-mini",
  "identity": "alice",
  "api_id": "api.github.com",
  "auth_type": "bearer",
  "created_at": 1672531200,
  "updated_at": 1672531200,
  "account_id": "oauth_abc123",
  "app_slug": "pipedream",
  "synced_at": 1672531200
}

Changes