STstellar
API Keys

Get API Key Details

Changed on

Retrieves a specific API key by its ID. Returns the API key details including permissions and restrictions, but does not include the actual key value for security reasons.

get/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

Response

API key retrieved 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

  • 7588d8d2a3c7Revision changes
    • info

      added the optional property to the response with the status

  • b6f8a6e65559Revision changes
    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status