List Controls

GEThttps://api.confident-ai.com/v2/organization/governance-controls

Lists your organization's governance controls, newest created first, each with its health across the projects it governs. A control's definition is not included — read its versions for that. Health is computed from the latest verdict per governed project, so it reflects the current state rather than the whole assessment history.

GET/v2/organization/governance-controls

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

200

{
  "success": true,
  "data": {
    "governanceControls": [
      {
        "id": "<GOVERNANCE-CONTROL-ID>",
        "name": "Production error rate under 2%",
        "description": "Traces must error on fewer than 2% of production requests over the last day.",
        "type": "RUNTIME",
        "operationalKey": null,
        "recommended": false,
        "configured": true,
        "policiesCount": 2,
        "severity": "CRITICAL",
        "assessmentsCount": 128,
        "createdAt": "2025-01-14T09:30:00.000Z",
        "health": {
          "passRate": 75,
          "projectsAssessed": 4,
          "projectsFailing": 1,
          "projectsTotal": 5,
          "projects": [
            {
              "projectId": "<PROJECT-ID>",
              "projectName": "Checkout Assistant",
              "status": "PASS"
            }
          ]
        }
      }
    ],
    "totalGovernanceControls": 12,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/controls",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Query parameters

typeenum
activityenum
pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of controls per page, at most 100. Defaults to 25.

Response

List Controls succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of governance controls, with the total across all pages.
Show 4 propertiesHide 4 properties
- governanceControlslist of objects
  The organization's governance controls for the current page, newest created first.
  Show 12 propertiesHide 12 properties
  - idstring
    The id of the control, generated by Confident AI.
  - namestring
    The name of the control, unique within your organization.
  - descriptionstring | null
    What the control checks and why, or null when it has none.
  - 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
  - operationalKeystring | null
    The Confident AI registry entry an OPERATIONAL control was seeded from, which is what it checks. It is null for every other type.
  - recommendedboolean
    Whether Confident AI recommends this control as part of a baseline. It is set on the controls Confident AI seeds and is false for controls you create.
  - configuredboolean
    Whether the control's current version carries enough of a definition to be assessed. A runtime control needs a data model, an aggregation and a numeric threshold; a pre-deployment control needs either a run identifier or officialOnly. An unconfigured control assesses as ERROR, and an OPERATIONAL control is always configured.
  - policiesCountinteger
    How many governance policies hold this control. A control in no policy governs nothing and is never assessed.
  - severityenum | null
    How much a failing control matters, set per version rather than per control. LOW never blocks a deployment gate; CRITICAL, HIGH and MEDIUM block, and so does leaving the severity unset.
    Show 4 enum valuesHide 4 enum values
    CRITICAL
    HIGH
    MEDIUM
    LOW
  - assessmentsCountinteger
    How many verdicts have been recorded for this control, summed across every version of its definition.
  - createdAtstring
    When the control was created.
  - healthobject
    How a control is doing across the projects it governs, computed from the latest verdict per project rather than from its whole assessment history. A project is governed when its policy holds the control, or when its policy extends a base policy that holds it.
    Show 5 propertiesHide 5 properties
    passRatenumber | null
    projectsAssessedinteger
    How many governed projects have produced a counted verdict, meaning a PASS, FAIL or ERROR rather than NO_DATA.
    projectsFailinginteger
    How many governed projects have a latest verdict of FAIL or ERROR.
    projectsTotalinteger
    How many projects the control governs in total, including those it has never been assessed against. The difference from projectsAssessed is the projects with no counted verdict yet.
    projectslist of objects
    The latest verdict for each governed project, one entry per project counted in projectsTotal. It is empty when the control is attached to no policy.
    Show 3 propertiesHide 3 properties
    projectIdstring
    The id of the governed project.
    projectNamestring
    The name of the governed project.
    statusenum | null
    The verdict of assessing one governance control against a project or organization.
    Show 4 enum valuesHide 4 enum values
    PASS
    FAIL
    ERROR
    NO_DATA
- totalGovernanceControlsinteger
  The number of controls matching type and activity, across every page.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of controls per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI