Change the Organization's Compliance profile

PATCH /v1/compliance-profile

Writes the next version of the Compliance profile at the version If-Match names and the Audit event compliance_profile.update with the values before and after, in one transaction (1.32.0, workspace ADR 0082). Session only: the api refuses the route to every API key, whatever its scopes, and to a Member who is not an owner, with 403 forbidden and the detail owner_required; only the owner holds compliance:write. A provider_regions value outside the cell's own set is refused with validation_failed and the issue region_not_in_cell. The change applies from the next Call: a Call in progress keeps the version it was admitted with. A change that leaves a published Agent version unable to run is accepted, and admission then refuses that version's Calls (provider_not_allowed).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the compliance:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/compliance-profile" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/compliance-profile`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/compliance-profile",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: ComplianceProfileUpdateRequest.

Responses

Fields of the 200 answer

The shape is ComplianceProfile.