Skip to content
English
  • There are no suggestions because the search field is empty.

Explore the REST API reference

Summary

The REST API is documented in a live, unauthenticated OpenAPI specification you can inspect before writing any code. This article is a map of what's available and where to find the full contract for each endpoint.

Before you start

You'll need an API key with the scopes relevant to what you're building, see Choose the right API key scopes.

1. Read the OpenAPI document

The full contract, every endpoint, request shape, response shape, and error case, is published at /api/public/v1/openapi.json as an OpenAPI 3.1 document. It's unauthenticated, so you can review it without a key first. A docs page at /api/public/v1/docs renders it for browsing.

2. Know what each area covers

  • Signals (signals:read, signals:write): list and view items from your triage queue, and acknowledge one or mark it in progress (Professional). Writing cannot resolve, suppress or close a signal.
  • Events (events:read): query activity metadata, plus a cursor-paginated pull endpoint built for continuous SIEM ingestion rather than one-off queries.
  • Users (users:read): your roster and per-user 30-day activity summaries.
  • Assets (assets:read): your registered assets, list and detail.
  • Compliance (compliance:read): frameworks, per-control status, and attestations (Professional), and programs (Ultimate or the Full compliance add-on, turned on for your organization).
  • Policies (policies:read, policies:write): list and view alert policies, and create, update, and delete them (Professional). Some alert types allow only one policy for the whole organization: a second one is refused with a 409 (policy_type_exists) that names the existing policy.
  • Incidents (incidents:read, incidents:write): list incidents, promote a signal into an incident, and resolve one (Professional).
  • Remediation (remediation:read, remediation:write): list actions, transition their status, and reassign them (Professional).
  • Ontology (any valid key, no specific scope): a self-describing document of every public entity, its fields, how entities relate, and the vocabularies the rest of the API uses.

Areas marked with a plan return a 403 with upgrade_required if your plan doesn't include them, whatever scopes the key holds. Everything else works on every plan.

3. What events don't include

Event responses are metadata only: captured prompt and response content, and DLP match evidence, are never included in the API. If your integration needs that level of detail, it isn't available through this endpoint at any scope.

4. Know how subject data is handled

If your organization is set to de-identify activity, requests that try to filter or identify a specific person (for example, by email) are refused rather than silently stripped. The refusal is a 403, and its response body explains that your organization de-identifies activity. That body is what distinguishes it from a scope-related 403: your key and its scopes are fine, so change the request rather than the key. The list endpoints for signals, events (including the pull endpoint), users, and incidents also carry a subjectDisclosure field, named or withheld, saying whether the rows identify people. Detail endpoints don't carry it.

Confirm it worked

Fetch /api/public/v1/openapi.json directly (no key needed) and confirm you can see the full list of paths. Then make one authenticated request against an endpoint you're planning to use, with a key scoped for it.

If it didn't work

  • Can't find an endpoint you expected: check the OpenAPI document directly rather than assuming; it's the authoritative, current list.
  • A response is missing content you expected: if it's prompt/response body content or DLP evidence, the public API never surfaces it.
  • A filtered request is refused unexpectedly: check whether your organization is set to de-identify activity; a subject-scoped filter behaves differently in that mode. See Authenticate your API requests for how to read the response.

Related