Skip to main content
POST
Verify a key for a given workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
key
string
required
requestedScopes
object[]
required
route
string
billing
object
rateLimitConfig
object

Response

The verification result

apiKeyId
string
required
expiresAt
integer | null
required
Required range: x > 0
requestedScopes
object[]
required
status
enum<string>
required
Available options:
VALID,
EXPIRED,
DISABLED,
DELETED,
RATE_LIMITED,
USAGE_LIMITED,
INVALID_SCOPES,
INVALID
billing
object | null
required
externalMeterId
string | null
required
customerId
string | null
required
scopes
object[]
required
rateLimit
object
metadata
object