Skip to navigation

Revoke Current API Key

View as Markdown
Revokes the aVenture API key authenticating this request and returns its metadata so the CLI can confirm revocation before deleting its saved copy.

Authentication

AuthorizationBearer

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
createdAtdatetime
Provider creation timestamp
idstringformat: "^ak_[0-9A-Fa-f]{32}$"
API key identifier
namestring

User-visible key name

scopeslist of strings
Scopes assigned to this key
statusenum

Provider-derived current lifecycle state

Allowed values:
subjectstring
Account that owns the key
updatedAtdatetime
Provider metadata update timestamp
descriptionstring or nullOptional

Optional user-visible key description

expiresAtdatetime or nullOptional
Provider expiry timestamp
lastUsedAtdatetime or nullOptional

Most recent provider-recorded use timestamp

revocationReasonstring or nullOptional
Provider revocation explanation

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error