Skip to main content
Update API Key

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Path Parameters

id
string
required

The unique identifier of the API key to update

Body

application/json
permissions
enum<string>[]
required

List of permissions granted to this API key

Minimum array length: 1
Available options:
read:all,
write:all,
read:disbursements,
write:disbursements,
read:receivers,
write:receivers,
read:payments,
write:payments,
read:organization,
write:organization,
read:users,
write:users,
read:wallets,
write:wallets,
read:distribution_wallets,
write:distribution_wallets,
read:statistics,
read:exports
distribution_wallet_ids
string[]

IDs of the distribution accounts this key may act on. Omit the field to leave the key's current accounts unchanged; providing a list replaces them. An empty array removes all account access. A key cannot be scoped to an account the caller cannot reach.

allowed_ips

IP restrictions for the API key. If not provided, existing restrictions remain unchanged

Response

API key updated successfully

id
string

Unique identifier for the API key

name
string

Human-readable name for the API key

permissions
string[]

List of permissions granted to this API key

allowed_ips
string[]

List of allowed IP addresses or CIDR ranges

distribution_wallet_ids
string[]

IDs of the distribution accounts this API key may act on.

expiry_date
string<date-time>

Expiration date of the API key

created_at
string<date-time>

When the API key was created

created_by
string

User who created the API key

updated_at
string<date-time>

When the API key was last updated

updated_by
string

User who last updated the API key

last_used_at
string<date-time>

When the API key was last used