Oxelone Docs

Search docs and API

Find a guide, a section of one, or an API operation by its name.

Open console (opens in a new tab)

API reference Resources

Posture

Every shipped posture check, by AI risk.

1 operation

The workspace's posture: every shipped check, by AI risk

GET/posture

Needs alerts:read, since every number is a count of issues. Connector sources also need connections:read, and the machines source machines:read. A source the caller cannot read is left out and named in withheld; a caller who can read neither gets a 403.

Response200

Every shipped check, with its state

checksPostureCheck[]required

Every check of every visible source.

checked_onintegerrequired

Connections it ran on, out of of live ones (0/0 on machine checks).

idstringrequired

The policy id of the provided connector check or machine check.

keystringrequired

The pack key (openai/hosted_mcp_enabled), or the machine check's key (approval_bypass, sc_known_bad).

namestringrequired
ofintegerrequired
openintegerrequired

Open issues (records or tools failing).

risksPostureRisk[]required

All six risks, in the matrix's order.

aibooleanrequired

False only for foundations.

idstringrequired

data_exposure | web_and_tools | autonomous_agents | supply_chain | idle_ai | foundations.

labelstringrequired
linestringrequired

One line naming what the shipped checks under it read.

sourcesPostureSource[]required

One per connector that ships posture checks, then machines; a source listed in withheld is absent.

connectionsintegerrequired

Live connections of this connector (0: not connected); for machines, the machines that have reported AI tool settings.

idstringrequired

A connector id, or machines.

labelstringrequired
withheldstring[]required

Sources this caller may not read: connections and/or machines.

Errors

401

No valid session

403

Caller lacks alerts:read, or both connections:read and machines:read