latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

API Keys

Create API-key policy revision

Appends an immutable rule snapshot to an API-key control profile without activating it.

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

Path parameters

keyIdstring required

API key identifier.

Example:key_example

API key identifier.

profileIdstring 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.

Request body

defaultAction'allow' | 'deny' | 'approval_required' | 'review' required

Decision used when no rule matches.

Example request

{
  "defaultAction": "deny"
}

Response

API-key control profile revision created

Example response

{
  "data": {
    "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"
  }
}