Update Governance Policy Controls

(v2)

PUT

Replaces the set of controls the governance policy attaches directly, changing what it gates its projects on from the next assessment onward. This is how a control comes to govern anything: a newly created control is attached to no policy, so it gates nothing until a policy attaches it here. Every id must name a control in your organization, or the whole request is rejected.

PUT/v2/organization/governance-policies/{policyId}/controls

curl -X PUT "https://api.confident-ai.com/v2/organization/governance-policies/{policyId}/controls" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "controlIds": [
    "<GOVERNANCE-CONTROL-ID>"
  ]
}'

200

{
  "success": true,
  "data": {
    "controls": [
      {
        "id": "<GOVERNANCE-CONTROL-ID>",
        "name": "Groundedness above 0.9",
        "description": "Answers must stay grounded in the retrieved context.",
        "type": "RUNTIME",
        "recommended": true,
        "configured": true,
        "currentVersion": {
          "id": "<GOVERNANCE-CONTROL-VERSION-ID>",
          "version": "00.00.02"
        },
        "latestAssessments": [
          {
            "id": "<GOVERNANCE-ASSESSMENT-ID>",
            "governanceControlId": "<GOVERNANCE-CONTROL-ID>",
            "governanceControlVersion": {
              "id": "<GOVERNANCE-CONTROL-VERSION-ID>",
              "version": "00.00.02"
            },
            "projectId": "<PROJECT-ID>",
            "status": "PASS",
            "evidence": {
              "measured": 0.94,
              "threshold": 0.9
            },
            "error": null,
            "createdAt": "2025-01-15T02:00:00.000Z"
          }
        ],
        "baseGovernancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        },
        "alsoInBaseGovernancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        }
      }
    ],
    "totalGovernancePolicyControls": 6
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/policies/<GOVERNANCE-POLICY-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

policyIdstringRequired
The id of the governance policy.

Request body

controlIdslist of stringsRequired
The complete set of controls the policy should attach directly. Any control it currently attaches and you leave out is detached, and an empty array detaches all of them. An inherited control cannot appear here — it is attached on the base policy that owns it.

Response

Update Governance Policy Controls succeeded.

successboolean
Indicates if the request was successful.
dataobject
The controls a governance policy applies, as they stand after the call.
Show 2 propertiesHide 2 properties
- controlslist of objects
  Every control that applies to this policy's projects, including the ones inherited from the policies it extends.
  Show 10 propertiesHide 10 properties
  - idstring
    The id of the governance control.
  - namestring
    The name of the governance control.
  - descriptionstring | null
    What the control checks, or null when it has no description.
  - typeenum
    What a governance control checks: RUNTIME watches production behaviour, PRE_DEPLOYMENT_EVALS and PRE_DEPLOYMENT_RED_TEAMING gate a release, and OPERATIONAL covers process rather than the system itself.
    Show 4 enum valuesHide 4 enum values
    RUNTIME
    PRE_DEPLOYMENT_EVALS
    PRE_DEPLOYMENT_RED_TEAMING
    OPERATIONAL
  - recommendedboolean
    Whether Confident AI recommends this control for the kind of system the policy governs.
  - configuredboolean
    Whether the control's current version carries the settings its type needs to run. A control that is not configured is never assessed, so it produces no verdicts.
  - currentVersionobject | null
    The version of a control's definition an assessment was computed against.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the control version, generated by Confident AI.
    versionstring
    The human-readable label of the control version.
  - latestAssessmentslist of objects
    This control's newest verdict in each project enrolled in the policy. A project with no verdict for the control is absent rather than listed with a null status.
    Show 8 propertiesHide 8 properties
    idstring
    The id of the assessment, generated by Confident AI.
    governanceControlIdstring
    The id of the governance control that was assessed.
    governanceControlVersionobject
    The version of a control's definition an assessment was computed against.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the control version, generated by Confident AI.
    versionstring
    The human-readable label of the control version.
    projectIdstring
    The id of the project the control was assessed against.
    statusenum
    The verdict of assessing one governance control against a project or organization.
    Show 4 enum valuesHide 4 enum values
    PASS
    FAIL
    ERROR
    NO_DATA
    evidenceobject | null
    errorstring | null
    Why the check itself failed to run, or null when it ran. This is set on an ERROR verdict and says nothing about whether the project complies.
    createdAtstring
    When the assessment was recorded.
  - baseGovernancePolicyobject
    A governance policy, named by id.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the governance policy.
    namestring
    The name of the governance policy.
  - alsoInBaseGovernancePolicyobject
    A governance policy, named by id.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the governance policy.
    namestring
    The name of the governance policy.
- totalGovernancePolicyControlsinteger
  How many controls apply to this policy, the length of controls. This response is not paginated.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI