STstellar
API Keys

Update API Key

Changed on

Updates an existing API key's permissions and IP restrictions. The API key name and expiration date cannot be modified after creation.

patch/api-keys/{id}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Path parameters

idstring required

The unique identifier of the API key to update

Request body

permissionsstring[] required

List of permissions granted to this API key

distribution_wallet_idsstring[]

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.

Response

API key updated successfully

idstring

Unique identifier for the API key

namestring

Human-readable name for the API key

permissionsstring[]

List of permissions granted to this API key

allowed_ipsstring[]

List of allowed IP addresses or CIDR ranges

distribution_wallet_idsstring[]

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

expiry_datestring date-time

Expiration date of the API key

created_atstring date-time

When the API key was created

created_bystring

User who created the API key

updated_atstring date-time

When the API key was last updated

updated_bystring

User who last updated the API key

last_used_atstring date-time

When the API key was last used

Changes

  • 2db2e948a476Revision changes
    • info

      added the new read:reports enum value to the request property /

  • 7588d8d2a3c7Revision changes
    • info

      added the new optional request property

    • info

      added the new read:distribution_wallets enum value to the request property /

    • info

      added the new write:distribution_wallets enum value to the request property /

    • info

      added the optional property to the response with the status