Rotate

Rotate Api Key

put

Rotate an API key.

Args: service_account_id: ID of the service account to which the API key belongs. api_key_name_or_id: Name or ID of the API key to rotate. rotate_request: API key rotation request.

Returns: The updated API key.

Authorizations

Path parameters

service_account_idstring · uuidRequired

api_key_name_or_idany ofRequired

Body

Request model for API key rotation.

retain_period_minutesintegerOptionalDefault: 0

Responses

application/json

objectOptional

Response model for API keys.

application/json

application/json

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/service_accounts/{service_account_id}/api_keys/{api_key_name_or_id}/rotate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "retain_period_minutes": 1
}

{
  "body": {
    "created": "2025-04-21T16:49:05.607Z",
    "updated": "2025-04-21T16:49:05.607Z",
    "key": "text",
    "active": true,
    "service_account": {
      "body": {
        "created": "2025-04-21T16:49:05.607Z",
        "updated": "2025-04-21T16:49:05.607Z",
        "active": true
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  },
  "metadata": {
    "description": "text",
    "retain_period_minutes": 1,
    "last_login": "2025-04-21T16:49:05.607Z",
    "last_rotated": "2025-04-21T16:49:05.607Z"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}