Skip to main content
POST
/
v1
/
api-keys
/
{id}
/
rotate
Rotate an API key
curl --request POST \
  --url https://api.getsly.ai/v1/v1/api-keys/{id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "strategy": "immediate",
  "overlap_seconds": 300
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "prefix": "<string>",
    "environment": "test",
    "scopes": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "key": "<string>",
    "warning": "<string>",
    "last_used_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Path Parameters

id
string<uuid>
required

Body

application/json
strategy
enum<string>
default:immediate
Available options:
immediate,
overlap
overlap_seconds
integer
default:300
Required range: x <= 86400

Response

Rotated

data
object
required