controlVersions

Requires permission settings:controls:manage.

Returns every saved version of a control, newest first. Requires settings:controls:manage.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ControlVersions($id: ID!) {
  controlVersions(id: $id) {
    createdAt
    archived
    changeReason
    createdBy
    mode
    revision
    rule {
      id
      name
      archived
      checkpoint
      invalid
      invalidReason
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ControlVersions($id: ID!) {\n  controlVersions(id: $id) {\n    createdAt\n    archived\n    changeReason\n    createdBy\n    mode\n    revision\n    rule {\n      id\n      name\n      archived\n      checkpoint\n      invalid\n      invalidReason\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "controlVersions": [
      {
        "createdAt": "2025-01-15T00:00:00Z",
        "archived": true,
        "changeReason": "string",
        "createdBy": "string",
        "mode": "string",
        "revision": 0,
        "rule": {
          "id": "id",
          "name": "string",
          "archived": true,
          "checkpoint": "string",
          "invalid": true,
          "invalidReason": "string"
        }
      }
    ]
  }
}

controlVersions(
  id: ID!
): [ControlVersionType!]!

Arguments

controlVersions.id ● ID! non-null scalar

The ID of the control.

Type

ControlVersionType object

One saved version of a control.