Assess Governance Control

(v2)

POST

Runs a governance control now against every project it governs, rather than waiting for the scheduled sweep, recording one verdict per project against the control's current version. A project is governed when its policy holds the control, or extends a base policy that does.

Verdicts are append-only: each becomes that project's current status and a row in the control's history, and running this again adds rows rather than replacing them. A project with nothing to measure resolves to NO_DATA, one whose control is not fully configured to ERROR. A control in no policy, or with no version, governs nothing and returns zero counts. Cost scales with the number of governed projects.

POST/v2/organization/governance-controls/{controlId}/assess

curl -X POST "https://api.confident-ai.com/v2/organization/governance-controls/{controlId}/assess" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "projectsAssessed": 5,
    "assessments": 5,
    "statusCounts": {
      "PASS": 4,
      "FAIL": 1
    }
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/controls/<GOVERNANCE-CONTROL-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

controlIdstringRequired
The id of the governance control.

Response

Assess Governance Control succeeded.

successboolean
Indicates if the request was successful.
dataobject
What one on-demand run of a control produced across the projects it governs.
Show 3 propertiesHide 3 properties
- projectsAssessedinteger
  How many governed projects the control was run against. It is 0 when the control is in no policy or has no version yet.
- assessmentsinteger
  How many verdicts this run recorded. It matches projectsAssessed unless recording one failed, in which case that project is skipped rather than reported.
- statusCountsobject
  How many projects resolved to each verdict, keyed by one of the GovernanceControlStatus values. A verdict no project resolved to is absent rather than zero, so an empty object means nothing was assessed.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI