Skip to content

Rotate an API token (issue new secret, revoke old)

POST
/v1/tokens/{id}/rotate
curl --request POST \
--url https://example.com/v1/tokens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate \
--header 'Authorization: Bearer <token>'

Issues a new token with the same specification and revokes the old one in the same step. The new secret is returned once.

id
required
string format: uuid

Resource identifier (UUIDv7).

OK

Media type application/json
object
id
string format: uuid
token

The new opaque API key (olvk_…). Shown only once.

string
Example generated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"token": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}