ANando
API Keys

Rotate an API key

Changed on

Atomically replaces an API key secret while preserving its stable id; omitted label and scope fields keep their current values. Requires api_keys:write, a live admin/owner membership, an Idempotency-Key, and a different administrator key than the target. The old secret stops authenticating immediately. The encrypted replacement response is replayable for 24 hours through the same administrator key.

post/api-keys/{apiKeyId}/rotate

Request

  • Base URL
    https://api.ando.so/v1
  • URL
    https://api.ando.so/v1/api-keys/{apiKeyId}/rotate
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

apiKeyIdstring required

Stable API key identifier.

Headers

Idempotency-Keystring required

Idempotency key.

Required key for safe retries. Reusing it with different parameters returns 409 idempotency_conflict. The encrypted secret response can be replayed for 24 hours.

Request body

namestring nullable

Replacement operator-facing key label.

scopesstring[]

Exact replacement non-administrative scopes.

Response

Rotated API key.

Example response

{
  "data": {
    "key": {
      "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
      "subject": {
        "workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
      }
    }
  }
}

Changes

  • aaceae49c08dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • a1b7544d3bf4Revision changes
    • warning

      added the new slack_migration:read enum value to the /// response property for the response status

    • warning

      added the new slack_migration:write enum value to the /// response property for the response status