Enable or disable one compliance framework

PATCH /org/security/compliance/frameworks/{framework_key}

Enable or disable one compliance framework

Python

import requests

url = "https://platform.ankra.app/org/security/compliance/frameworks/{framework_key}"

payload = { "enabled": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "key": "<string>",
  "title": "<string>",
  "short_title": "<string>",
  "version": "<string>",
  "description": "<string>",
  "control_count": 123,
  "automated_control_count": 123,
  "enabled": true,
  "enabled_at": "2023-11-07T05:31:56Z",
  "score": 123,
  "satisfied_controls": 123,
  "at_risk_controls": 123,
  "failing_controls": 123,
  "manual_controls": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

framework_key · string · required

Body

application/json

enabled · boolean · required

Response

200

application/json

The updated framework switch with a live score when enabled.

key · string · required

title · string · required

short_title · string · required

version · string · required

description · string · required

control_count · integer · required

automated_control_count · integer · required

enabled · boolean · required

enabled_at · string<date-time> | null · required

score · number | null · required

satisfied_controls · integer | null · required

at_risk_controls · integer | null · required

failing_controls · integer | null · required

manual_controls · integer | null · required