Skip to content

Get an API key

GET
/v1/keys/{id}
curl --request GET \
--url https://api.disasm.dev/v1/keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Get details for a specific API key including balance, usage, and service info.

id
required
string format: uuid

The API key ID (UUID).

The API key.

Media typeapplication/json
object
id
string
service_id
integer
service_name
string
key_hint

Masked key, for identification only.

string
label
string
status

Key state, e.g. active, revoked.

string
request_balance

Subscription requests remaining on this key.

integer
requests_used

Total requests made with this key.

integer
payg_overflow

Whether requests beyond the subscription balance draw from the PAYG wallet.

boolean
last_used_at
string format: date-time
nullable
created_at
string format: date-time

Example

{
"id": "key-uuid-1",
"service_id": 1,
"service_name": "Incapsula",
"key_hint": "dk_live_****abcd",
"label": "Production",
"status": "active",
"request_balance": 5000,
"requests_used": 12400,
"payg_overflow": true,
"last_used_at": "2026-04-14T12:30:00Z",
"created_at": "2026-01-15T09:00:00Z"
}
X-RateLimit-Limit
integer
Example
60

Maximum requests per minute (60).

X-RateLimit-Remaining
integer
Example
59

Requests remaining in the current window.

X-RateLimit-Reset
integer
Example
1718000000

Unix timestamp when the rate limit resets.

Missing or invalid API key.

Media typeapplication/json
object
error

A human-readable message describing what went wrong.

string

Example

{
"error": "Missing or invalid API key"
}

The requested resource does not exist or does not belong to you.

Media typeapplication/json
object
error

A human-readable message describing what went wrong.

string

Example

{
"error": "API key not found"
}

Rate limit exceeded. See the X-RateLimit-* response headers.

Media typeapplication/json
object
error

A human-readable message describing what went wrong.

string

Example

{
"error": "Rate limit exceeded"
}
X-RateLimit-Limit
integer
Example
60

Maximum requests per minute (60).

X-RateLimit-Remaining
integer
Example
59

Requests remaining in the current window.

X-RateLimit-Reset
integer
Example
1718000000

Unix timestamp when the rate limit resets.