API Key

Introspect current API key

Changed on

Returns the API key resource for the key authenticating this request. Useful for verifying which key is in use and discovering its current authorization context without inferring it from rejected requests.

get/v1/api_key

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/api_key
  • Auth
    HTTP bearer

Response

The authenticated API key

type'api_key' required

Resource type discriminator.

idstring required

Unique identifier of the API key.

merchant_idstring required

Identifier of the merchant the key belongs to.

scopesstring[] required

The effective set of scopes for this key. Stored aliases (e.g. full_access, read_only) are always expanded to concrete resource:action scopes against the current registry before they appear here.

ip_allow_liststring[] required

IP addresses or CIDR ranges this key is permitted to authenticate from. An empty array means the key is not IP-restricted.

expires_atstring date-time nullable required

ISO 8601 UTC timestamp at which this key expires. null if the key has no expiry.

created_atstring date-time required

ISO 8601 UTC timestamp at which this key was created.

updated_atstring date-time nullable required

ISO 8601 UTC timestamp of the last update to this key (e.g. roll, IP allowlist change, revoke). null if the key has not been updated since creation.

api_versionstring required

Effective API version for the request (header value or merchant pin).

Example response

{
  "id": "550e8400-e29b-41d4-a716-44665544000e",
  "merchant_id": "68e0a1b2c3d4e5f607182940",
  "ip_allow_list": [
    "203.0.113.0/24"
  ],
  "expires_at": "2027-01-15T10:30:00Z",
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:35:00Z",
  "api_version": "2026-05-01"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • 79d607871de9Revision changes
    • warning

      added the new counterparties:read enum value to the / response property for the response status

    • warning

      added the new counterparties:write enum value to the / response property for the response status

    • warning

      added the new simulations:write enum value to the / response property for the response status