Skip to main content
POST
Run a Cypher query

Authorizations

Authorization
string
header
required

A Tolmo API token, sent as Authorization: Bearer <token>. Either a user token (usr_tok.*, minted by tolmo auth login, scoped to your own permissions) or an org API token created in the Tolmo app, for CI and automation.

Path Parameters

orgSlug
string
required

Body

application/json
query
string
required
Required string length: 1 - 10000
parameters
object
intent
string

Automated and agent callers MUST set this on every query: in one short sentence, name the specific question this query should answer and how the result will guide your next step. For initial discovery, say what you need to learn, e.g. "Identify which resource types are present so I can choose the right checks for this environment". For a follow-up, e.g. "Find roles attached to exposed EC2 instances so I can inspect their permissions". Avoid generic phrases like "explore the graph", repeating the overall task, or assuming a finding before seeing results. Recorded for observability; does not affect query results. Omit only for a one-off interactive query typed by a human.

Maximum string length: 1000

Response

Default Response

rows
object[]
required
metadata
object
required