STstellar
API Keys

Create API Key

Changed on

Creates a new API Key to access SDP endpoints. API Key can be configured to have a granular read/write access, also API key can be restricted to the specific IP or range of the IPs.

post/api-keys

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

Request body

namestring required

Human-readable name for the API key

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 inherit the accounts its creator can reach at that moment. An empty array grants no account access. A key cannot be scoped to an account its creator cannot reach.

expiry_datestring date-time

Optional expiration date for the API key (must be in the future)

Response

API key created successfully

idstring

Unique identifier for the API key

namestring

Human-readable name for the API key

keystring

The actual API key (only returned once at creation)

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