Skip to content
Anlyon
Esc
↑↓navigate↵open⌘Jpreview

List approval policies

Policies in the credential’s own environment, in evaluation order. Needs policies:read, or a console session. With ?actionName= only the policies that could govern that action are returned: the ones naming it plus the broad ones that also catch it. A credential is bound to one environment; an environmentId query that disagrees with it is refused.

GET/api/v2/approval-policies
Authorization
AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

or
better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters
actionNamestring
max length 200
Header parameters
X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128
Responses
200

Approval policies in the workspace.

successbooleanrequired
Allowed:true
dataApprovalPolicy[]required
Show properties
Array of ApprovalPolicy
idstringrequired

Public policy id (apol_xxx).

environmentIdstring<uuid>required

The environment the policy governs. Policies never span environments.

namestringrequired
priorityintegerrequired

Lower runs first. Ties are broken by creation time, then by id, so the order is always deterministic.

enabledbooleanrequired
scopestringrequired

What the policy applies to, derived from match. Never inferred from the name.

Allowed:specific_actionall_actionscustom_requestsall_requests
needsScopeReviewbooleanrequired

True on a broad policy nobody has confirmed the scope of. Every policy created before explicit targeting is in this state, because the old form sent no action selector. Preserved as it was, and flagged.

matchApprovalPolicyMatchrequired
Show properties
kindstringrequired
Allowed:anyactioncustom
actionNamestring | nullrequired
agentIdstring | nullrequired
userIdstring | nullrequired
tagsstring[] | nullrequired
minAmountnumber | nullrequired
conditionsobject | nullrequired
conditionstring | nullrequired

A CEL expression (https://cel.dev) that must also hold, over input, agent.id, user.id, tags, action.name and kind. Checked against the target action's input schema when saved. An evaluation error (for example a missing field) requires approval rather than skipping the policy; guard optional fields with has().

effectstringrequired
Allowed:require_approvalauto_approveauto_deny
requiredApprovalsintegerrequired

Distinct approvers needed (N-of-M).

versionintegerrequired

Bumps on each edit; recorded on approvals this policy governs.

scopeReviewedAtstring<date-time> | nullrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
managedByobject | null

Set when a policy file owns this policy. Console and API edits of it are refused; change the file.

Show properties
filestringrequired
keystringrequired
401

Unauthorized - Invalid or missing API key

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
429

Too Many Requests - Rate limit exceeded

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.anlyon.com/api/v2/approval-policies' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "success": true,
  "data": [
    {
      "id": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "name": "string",
      "priority": 0,
      "enabled": true,
      "scope": "specific_action",
      "needsScopeReview": true,
      "match": {
        "kind": "any",
        "actionName": "string",
        "agentId": "string",
        "userId": "string",
        "tags": [
          "string"
        ],
        "minAmount": 0,
        "conditions": {},
        "condition": "string"
      },
      "effect": "require_approval",
      "requiredApprovals": 0,
      "version": 0,
      "scopeReviewedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "managedBy": {
        "file": "string",
        "key": "string"
      }
    }
  ]
}