latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

API Keys

Activate API-key policy revision

Makes one immutable revision the active policy for its API-key control profile.

post/v1/api-keys/{keyId}/policy-profiles/{profileId}/revisions/{revisionId}/activate

Path parameters

keyIdstring required

API key identifier.

Example:key_example

API key identifier.

profileIdstring required

revisionIdstring required

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

API-key control profile revision activated

Example response

{
  "data": {
    "profile": {
      "projectId": "prj_example",
      "apiKeyId": "key_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "activatedAt": "2025-01-01T00:00:00.000Z",
      "archivedAt": "2025-01-01T00:00:00.000Z"
    },
    "revision": {
      "createdAt": "2025-01-01T00:00:00.000Z",
      "activatedAt": "2025-01-01T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}