Get Active API Key

Return metadata for the active API key

GET

Overview

Returns metadata for the active API key.

The secret is not returned.

Authentication

Authenticated account access required.

Common errors

Code
Description

200

OK — Request succeeded

201

Created — Resource created successfully

204

No Content — Success with no response body

400

Bad Request — Invalid parameters

401

Unauthorized — Missing or invalid authentication

403

Forbidden — Operation not allowed

404

Not Found — Resource does not exist

429

Too Many Requests — Rate limit exceeded

500

Internal Server Error

Request

  • Method: GET

  • Path: /auth/api-key

  • Query parameters: None

Response

Response 200 OK

Field
Type
Description

id

string

API key record ID

key

string

Public API key

createdAt

string

Creation timestamp (ISO 8601)

expiresAt

string

Expiration timestamp or null

Last updated

Was this helpful?