List rules

Python

from openlayer import Openlayer

client = Openlayer()

rules = client.governance.rules.list(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    framework_id="5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
    status="failing",
)
for rule in rules.items:
    print(rule.id, rule.name)

import Openlayer from 'openlayer';

const client = new Openlayer();

const rules = await client.governance.rules.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  status: 'failing',
});

console.log(rules.items);

package main

import (
	"context"
	"fmt"

	"github.com/openlayer-ai/openlayer-go"
)

client := openlayer.NewClient()
rules, err := client.Governance.Rules.List(
	context.TODO(),
	"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
	openlayer.GovernanceRuleListParams{
		FrameworkID: openlayer.F("5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b"),
	},
)
if err != nil {
	panic(err.Error())
}
fmt.Printf("%+v\n", rules.Items)

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.governance.rules.RuleListParams;
import com.openlayer.api.models.governance.rules.RuleListResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

RuleListParams params = RuleListParams.builder()
    .workspaceId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .frameworkId("5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b")
    .status(RuleListParams.Status.FAILING)
    .build();
RuleListResponse rules = client.governance().rules().list(params);

require "openlayer"

openlayer = Openlayer::Client.new(api_key: ENV["OPENLAYER_API_KEY"])

rules = openlayer.governance.rules.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", framework_id: "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b")

puts(rules)

{
  "items": [
    {
      "id": "7c9a1e2b-3d4f-4a5b-8c6d-7e8f9a0b1c2d",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Monitoring enabled",
      "scope": "project",
      "type": "platform",
      "dateCreated": "2026-03-22T11:31:01.185Z",
      "dateUpdated": "2026-03-22T11:31:01.185Z",
      "description": "Each project must have Openlayer monitoring mode enabled.",
      "evidenceType": "document",
      "renewalCadenceDays": 90,
      "automationType": "monitoring_mode_enabled",
      "automationParams": {},
      "deactivated": false,
      "assigneeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tags": [
        {
          "id": "6e8a0c2d-4f5b-4a3c-9d7e-8f0a1b2c3d4e",
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Evaluation",
          "immutable": false,
          "dateCreated": "2026-03-22T11:31:01.185Z",
          "dateUpdated": "2026-03-22T11:31:01.185Z",
          "color": "<string>"
        }
      ],
      "frameworks": [
        {
          "id": "<unknown>",
          "name": "<unknown>",
          "avatar": "<unknown>",
          "builtInSlug": "<unknown>",
          "enabled": "<unknown>"
        }
      ],
      "results": [
        {
          "id": "5b7d9f1a-2c3e-4d5f-8a6b-9c0d1e2f3a4b",
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "passing",
          "deactivated": false,
          "dateCreated": "2026-03-22T11:31:01.185Z",
          "dateUpdated": "2026-03-22T11:31:01.185Z",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "statusMessage": "<string>",
          "dateLastEvaluated": "2023-11-07T05:31:56Z",
          "dateOfNextEvaluation": "2023-11-07T05:31:56Z",
          "dateOfLatestEvidence": "2023-11-07T05:31:56Z",
          "dateOfRenewal": "2023-11-07T05:31:56Z",
          "deactivatedReason": "<string>",
          "assigneeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "blockedBy": [],
          "blocking": []
        }
      ],
      "resultsSummary": {
        "passing": 1,
        "total": 1
      },
      "immutable": true
    }
  ]
}

{
  "code": 123,
  "error": "<string>"
}

Python

from openlayer import Openlayer

client = Openlayer()

rules = client.governance.rules.list(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    framework_id="5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
    status="failing",
)
for rule in rules.items:
    print(rule.id, rule.name)

import Openlayer from 'openlayer';

const client = new Openlayer();

const rules = await client.governance.rules.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  status: 'failing',
});

console.log(rules.items);

package main

import (
	"context"
	"fmt"

	"github.com/openlayer-ai/openlayer-go"
)

client := openlayer.NewClient()
rules, err := client.Governance.Rules.List(
	context.TODO(),
	"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
	openlayer.GovernanceRuleListParams{
		FrameworkID: openlayer.F("5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b"),
	},
)
if err != nil {
	panic(err.Error())
}
fmt.Printf("%+v\n", rules.Items)

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.governance.rules.RuleListParams;
import com.openlayer.api.models.governance.rules.RuleListResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

RuleListParams params = RuleListParams.builder()
    .workspaceId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .frameworkId("5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b")
    .status(RuleListParams.Status.FAILING)
    .build();
RuleListResponse rules = client.governance().rules().list(params);

require "openlayer"

openlayer = Openlayer::Client.new(api_key: ENV["OPENLAYER_API_KEY"])

rules = openlayer.governance.rules.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", framework_id: "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b")

puts(rules)

{
  "items": [
    {
      "id": "7c9a1e2b-3d4f-4a5b-8c6d-7e8f9a0b1c2d",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Monitoring enabled",
      "scope": "project",
      "type": "platform",
      "dateCreated": "2026-03-22T11:31:01.185Z",
      "dateUpdated": "2026-03-22T11:31:01.185Z",
      "description": "Each project must have Openlayer monitoring mode enabled.",
      "evidenceType": "document",
      "renewalCadenceDays": 90,
      "automationType": "monitoring_mode_enabled",
      "automationParams": {},
      "deactivated": false,
      "assigneeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tags": [
        {
          "id": "6e8a0c2d-4f5b-4a3c-9d7e-8f0a1b2c3d4e",
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Evaluation",
          "immutable": false,
          "dateCreated": "2026-03-22T11:31:01.185Z",
          "dateUpdated": "2026-03-22T11:31:01.185Z",
          "color": "<string>"
        }
      ],
      "frameworks": [
        {
          "id": "<unknown>",
          "name": "<unknown>",
          "avatar": "<unknown>",
          "builtInSlug": "<unknown>",
          "enabled": "<unknown>"
        }
      ],
      "results": [
        {
          "id": "5b7d9f1a-2c3e-4d5f-8a6b-9c0d1e2f3a4b",
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "passing",
          "deactivated": false,
          "dateCreated": "2026-03-22T11:31:01.185Z",
          "dateUpdated": "2026-03-22T11:31:01.185Z",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "statusMessage": "<string>",
          "dateLastEvaluated": "2023-11-07T05:31:56Z",
          "dateOfNextEvaluation": "2023-11-07T05:31:56Z",
          "dateOfLatestEvidence": "2023-11-07T05:31:56Z",
          "dateOfRenewal": "2023-11-07T05:31:56Z",
          "deactivatedReason": "<string>",
          "assigneeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "blockedBy": [],
          "blocking": []
        }
      ],
      "resultsSummary": {
        "passing": 1,
        "total": 1
      },
      "immutable": true
    }
  ]
}

{
  "code": 123,
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

workspaceId

string<uuid>

required

The workspace id.

Query Parameters

page

integer

default:1

The page to return in a paginated query.

Required range: x >= 1

perPage

integer

default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100

frameworkId

string<uuid>

Only include items belonging to this framework.

projectId

string<uuid>

Only include items that apply to this project.

enabledFrameworkOnly

boolean

default:false

Only include items belonging to at least one enabled framework.

includeUnframed

boolean

default:true

Whether to include rules that are not part of any framework.

includeResults

boolean

default:false

Whether to include each rule's results inline, in a results array.

searchQuery

string

Filter by a free-text search over names and descriptions.

asc

boolean

default:true

Whether to sort in ascending order.

sortBy

enum<string>

The field to sort on.

Available options:

name,

status,

frameworks,

scope,

dateCreated

Response

Status OK.

items

object[]

required

Show child attributes

Reference

SDKs

CLI

REST API

Authorizations

Path Parameters

Query Parameters

Response