Skip to main content
PATCH
Update Credential

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

credential_id
string
required

Body

application/json
name
string | null

User-friendly name for the credential

description
string | null

Optional description

type
string | null

Type of credential: key or json

payload
string<password> | null

The credential payload to be encrypted

credential_metadata
Credential Metadata · object | null

Optional unencrypted credential_metadata

Response

Successful Response

id
string
required
created_by_user_id
string | null
required
created_by_identity_type
string | null
required
type
string
required
name
string
required
description
string | null
required
credential_metadata
Credential Metadata · object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
object
string
default:credential