Sign in
InOrbit
Docs

API reference

List policies

Have a token? Manage tokens in the console
GET
/v1/guardrails/policies

The account's guardrail policies, by name: effect, rule, reason and source.

Needs scope decisions:read.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Query Parameters

account_id?string
space_id?string
page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.guardrails.v1.ListPoliciesResponse

application/json
  1. response

iohr.guardrails.v1.ListPoliciesResponse

next_page_token*string
policies*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const policy of api.guardrails.allListPolicies()) {    console.log(policy);  }} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

{  "next_page_token": "string",  "policies": [    {      "account_id": "string",      "effect": "string",      "enabled": true,      "name": "string",      "reason": "string",      "rule": "string",      "source_kind": "string",      "source_ref": "string",      "space_id": "string",      "updated_at": "string",      "updated_by": "string"    }  ]}

Check an action POST

Check an action an agent is about to take against the account's policies (and a space's): the answer is `allow`, `warn`, `ask` or `deny`, with each policy that had something to say, why, and where its rule comes from. A policy only ever restricts: a check never grants anything. Nothing is stored. Send the action's shape (the tool, the command, the working directory, the file), never a file's content, a command's output or a secret. Needs scope `decisions:write`.

Create or replace a policy PUT

Create or replace a policy by its name. Only a person who owns or administers the account, never an assistant. Audited by name. Needs scope `decisions:write`.