Query your instances' metrics at one time
Evaluates a PromQL query at one time, as Prometheus's
GET /api/v1/query does, over your org's instance metrics and
nothing else. A query that names another org's series, or any
metric not listed under Metrics above, reads nothing.
The response is Prometheus's own: status, data with its
resultType and result, and any warnings. Errors are this
API's problem documents; a query that does not parse or cannot run
returns 400 invalid_request with a violation of query.
AuthorizationBearer <cc_...>An API key of your org, sent as Authorization: Bearer cc_.... Keys
start with cc_ and are otherwise opaque. Treat a key as a password:
anyone holding it can act with its scopes until it expires or is
revoked. Each operation's security requirement lists the scopes it
needs; an empty list means any valid key. The MCP server at /mcp
accepts agent keys and no other kind.
Scope: instances:read
query*stringA PromQL expression, which may use VictoriaMetrics' MetricsQL extensions.
1 <= length <= 4096time?stringWhen to evaluate the query, as an RFC 3339 time or Unix seconds. Now when absent.
1 <= length <= 40timeout?stringHow long the query may run, as a duration such as 10s. At most, and by default, 20 seconds.
1 <= length <= 20Api-Version*stringThe API version the request is written against. This document
describes 2026-10-15. A missing header returns
400 api_version_required, and a version the API does not serve
returns 400 unsupported_api_version.
X-Cloud-Organization?stringThe Cloud organization whose metrics this data source requests. Required for the managed Grafana OAuth client, which forwards the querying user's WorkOS token with metrics:read:all-orgs. For that dedicated client and scope only, the API verifies the WorkOS issuer, audience and user, then checks current membership and read access in this requested org on every query. The token's org_id does not restrict this user-wide metrics grant. A missing, repeated or unauthorized org returns 403 insufficient_scope. Other callers may omit it; if provided, it must match the org their credential already authorizes. The header itself grants no access.
^org-[a-z0-9]([-a-z0-9]*[a-z0-9])?$5 <= length <= 63X-Correlation-ID?stringAn id of your own for this request, or for a group of requests, to
find them in our logs and yours. Logged with the request and returned
unchanged in X-Correlation-ID. The request id itself is always the
API's own, in X-Request-ID.
^[A-Za-z0-9._:-]+$1 <= length <= 128Org-Context?stringAdmin keys only: the id of the org to act in. Required with an admin
key, together with Access-Reason; with any other credential it
returns 400 invalid_request. Every request that carries it is
recorded in that org's operator-access log.
^org-[a-z0-9]([-a-z0-9]*[a-z0-9])?$5 <= length <= 63Access-Reason?stringAdmin keys only: why the operator is acting in the org, such as a
support ticket. Required with Org-Context. Recorded, verbatim, in
the org's operator-access log.
^[^\x00-\x1F\x7F]+$10 <= length <= 500The query's result at one time, as Prometheus returns it.
application/json- response
Prometheus's query result, which is why its shape is Prometheus's. Ignore fields you do not know.
status*stringsuccess. Open set; accept values not listed.
data*vector and matrix results are lists of series, each with its
labels in metric and its value in value or its values in
values. A scalar or string result is one [time, value]
pair.
warnings?array<string>Problems that did not stop the query, such as a result cut short.
curl -X GET 'https://api.cloud.confidential.ai/v1/prometheus/api/v1/query?query=sum+by+%28instance%29+%28rate%28cloud_instance_cpu_seconds_total%5B5m%5D%29%29&time=2026-10-22T17%3A00%3A00Z&timeout=10s' \ -H 'Api-Version: 2026-10-15' \ -H 'X-Correlation-ID: rollout-2026-10-22' \ -H 'Access-Reason: Support ticket 4821: customer asked why i-6d3f9h2k8mzr failed'{ "status": "success", "data": { "resultType": "vector", "result": [ { "metric": { "instance": "i-7k2m9q4x1bfa" }, "value": [ 1792688400, "1.94" ] }, { "metric": { "instance": "i-3n8w2c6v0dha" }, "value": [ 1792688400, "0.27" ] } ] }}Withdraw a capacity request DELETE
Withdraws a capacity request that is `open`, and returns it in status `withdrawn`. Repeats, and calls on an `expired` request, return it unchanged.
Query your instances' metrics over a time range GET
Evaluates a PromQL query at every `step` from `start` to `end`, as Prometheus's `GET /api/v1/query_range` does, over your org's instance metrics and nothing else. The last 3 days are kept at 30 seconds and the last 14 days at 5 minutes; a range that starts more than 3 days ago is answered at 5 minutes.