Skip to content
Oblique Docs

API reference

The Oblique API is a JSON API over HTTPS. It is the API the Terraform provider and the MCP server are built on, and everything either of them does can be done directly.

Base URL

Every path below hangs off https://us.oblique.security orhttps://eu.oblique.security. Each region is its own deployment, with its own data, so call the one your organization is in.

Authorization

Every request carries an API key as a bearer token. A key is a service account, and can call the operations listed here — which is the whole of the public API.

OBLIQUE_BASE_URL="https://us.oblique.security" # Or "https://eu.oblique.security"
OBLIQUE_API_KEY="my-api-key"
curl -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "$OBLIQUE_BASE_URL/api/v1/users"

Conventions

The API follows Google's API improvement proposals, so the shape of one operation tells you the shape of the rest.

  • Every resource is identified and addressed by its name — for example teams/platform/members/ada
  • A collection is read a page at a time: pass pageSize and thenextPageToken of the previous page as pageToken
  • An update sends only the fields it changes, named inupdateMask
  • A date-time is an RFC 3339 timestamp in UTC, aduration is a number of seconds with an s after it, and a field-mask is a comma-separated list of field names
  • A 64-bit integer is written as a string, since JSON numbers lose precision above 253