Gateway

Rotate an API key

Creates a replacement with the same limits and optionally sets the previous key expiry. The replacement secret is returned once. Requires keys:write.

post/keys/{id}/rotate

Request

  • Base URL: https://api.phaseo.app/v1
  • URL: https://api.phaseo.app/v1/keys/{id}/rotate
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring

Optional replacement key name.

previous_key_expires_atstring date-time nullable

Optional expiry for the previous key. Omit to leave it unchanged.

Response

API key rotated

previous_key_expires_atstring date-time nullable required

Example response

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "hash": "a3f5b7c9d8e1f23456789abcdeffedcba9876543210fedcba1234567890abcdef",
    "workspace_id": "22222222-2222-4222-8222-222222222222",
    "name": "Analytics Service Key",
    "label": "Analytics Service Key",
    "prefix": "phaseo_v1_sk_abcd1234",
    "status": "active",
    "scopes": "[\"chat.completions\",\"responses\"]",
    "created_by": "user_abc123",
    "created_at": "2026-04-28T12:00:00Z",
    "updated_at": "2026-04-28T12:15:00Z",
    "last_used_at": "2026-04-28T12:30:00Z",
    "expires_at": "2027-12-31T23:59:59Z",
    "key": "phaseo_v1_sk_abcd1234_supersecretvalue"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.