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"
  }
}

Changes

Changed in 3 of the 13 revisions of this API.454

Aug 25, 2026a04e2929537f22See the full diff
- ▲
  removed subschema #2 subschema #6 from the / request property oneOf list
  request-property-one-of-removed
- ▲
  added subschema #2 subschema #6 to the /// response property oneOf list for the response status
  response-property-one-of-added
- ○
  added subschema #2 subschema #6 to the / request property oneOf list
  request-property-one-of-added
- ○
  removed subschema #2 subschema #6 from the /// response property oneOf list for the response status
  response-property-one-of-removed
Aug 19, 2026f138f2b5866322See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #6 from the / request property oneOf list
  request-property-one-of-removed
- ▲
  added subschema #1 subschema #2 subschema #6 to the /// response property oneOf list for the response status
  response-property-one-of-added
- ○
  added subschema #1 subschema #2 subschema #6 to the / request property oneOf list
  request-property-one-of-added
- ○
  removed subschema #1 subschema #2 subschema #6 from the /// response property oneOf list for the response status
  response-property-one-of-removed
Aug 15, 20263e302bba53865See the full diff
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added

Full history