Assess Control

POSThttps://api.confident-ai.com/v2/organization/governance-controls/{controlId}/assess

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

Each project resolves to one verdict. A RUNTIME control aggregates its data model over the trailing 24 hours and returns FAIL when the result sits on the threshold's direction side of it, PASS when it does not, and NO_DATA when the window produced nothing to measure. A pre-deployment control returns PASS when the newest completed run in its window satisfies the control's filters, FAIL when it does not, and NO_DATA when there is no such run. An OPERATIONAL control returns whatever the platform check finds. Any control that is not fully configured, or whose aggregation does not fit its data model, returns ERROR with the reason on the assessment.

Every verdict is stored, so it becomes the project's current status for this control and appears in the control's assessment history. Assessments are append-only — running this repeatedly adds rows rather than replacing them. It consumes evaluation resources proportional to the number of governed projects. A control attached to no policy, or one with no version yet, governs nothing and returns zero counts.

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