--- title: "Start a query" description: "Validates the SQL (400 invalid_query, with line and column) and queues it; a worker runs it. 429 too_many_queries (with Retry-After) when the organization's queue, or everyone's, is full; 429 quota_exceeded (with quota, never Retry-After) when an hourly quota is spent. With an Idempotency-Key, retrying the same request within 24 hours answers the first 202 again, with Idempotent-Replayed: true, and queues nothing; the same key with a different request is 409 idempotency_conflict, and while the first is still being admitted, 409 idempotency_in_progress (with Retry-After)." --- > Documentation Index > Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Trails API › queries `POST /v1/organizations/{orgId}/queries` Validates the SQL (400 invalid_query, with line and column) and queues it; a worker runs it. 429 too_many_queries (with Retry-After) when the organization's queue, or everyone's, is full; 429 quota_exceeded (with quota, never Retry-After) when an hourly quota is spent. With an Idempotency-Key, retrying the same request within 24 hours answers the first 202 again, with Idempotent-Replayed: true, and queues nothing; the same key with a different request is 409 idempotency_conflict, and while the first is still being admitted, 409 idempotency_in_progress (with Retry-After). ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `StartQuery.path.orgId` (string, required) — The organization. - format `uuid` ## Header parameters - `StartQuery.header.Idempotency-Key` (string | null, optional) — 1 to 200 printable ASCII characters, scoped to the organization and kept 24 hours. ## Request body _Required._ - `StartQuery.sql` (string, required) - `StartQuery.from` (string | null, optional) — Inclusive, RFC 3339. - format `date-time` - `StartQuery.to` (string | null, optional) — Exclusive, RFC 3339. - format `date-time` ## Example request ```json { "from": "2019-08-24T14:15:22Z", "sql": "string", "to": "2019-08-24T14:15:22Z" } ``` ## Code samples ### cURL ```curl curl --request POST \ --url https://audit.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/queries \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "from": "2019-08-24T14:15:22Z", "sql": "string", "to": "2019-08-24T14:15:22Z" } ' ``` ### TypeScript ```typescript const url = 'https://audit.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/queries'; const options = { method: 'POST', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({from: '2019-08-24T14:15:22Z', sql: 'string', to: '2019-08-24T14:15:22Z'}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://audit.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/queries" payload = { "from": "2019-08-24T14:15:22Z", "sql": "string", "to": "2019-08-24T14:15:22Z" } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 202 Queued. Location names the query; poll it until it finishes. #### Example ```json { "queryId": "10210520-b895-40ca-bce5-474f9643bf53", "status": "string" } ``` - `StartQuery.response.202.queryId` (string, required) - format `uuid` - `StartQuery.response.202.status` (string, required) — "queued". ### 400 invalid_request, invalid_cursor, invalid_query (with line and column), or lookup_too_broad. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.400.error` (object, required) - `StartQuery.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.400.error.message` (string, required) - maxLength 1024 - `StartQuery.response.400.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.400.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.400.error.quota.id` (string, required) - `StartQuery.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.400.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.400.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.400.error.quota.region` (string, optional) - `StartQuery.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.400.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.400.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.400.error.reason` (string, optional) — query_failed: the query's own error code. ### 401 unauthenticated: no credential, or one that doesn't check out. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.401.error` (object, required) - `StartQuery.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.401.error.message` (string, required) - maxLength 1024 - `StartQuery.response.401.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.401.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.401.error.quota.id` (string, required) - `StartQuery.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.401.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.401.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.401.error.quota.region` (string, optional) - `StartQuery.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.401.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.401.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.401.error.reason` (string, optional) — query_failed: the query's own error code. ### 403 access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.403.error` (object, required) - `StartQuery.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.403.error.message` (string, required) - maxLength 1024 - `StartQuery.response.403.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.403.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.403.error.quota.id` (string, required) - `StartQuery.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.403.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.403.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.403.error.quota.region` (string, optional) - `StartQuery.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.403.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.403.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.403.error.reason` (string, optional) — query_failed: the query's own error code. ### 404 not_found: unknown, malformed, or in an organization the caller isn't in. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.404.error` (object, required) - `StartQuery.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.404.error.message` (string, required) - maxLength 1024 - `StartQuery.response.404.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.404.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.404.error.quota.id` (string, required) - `StartQuery.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.404.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.404.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.404.error.quota.region` (string, optional) - `StartQuery.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.404.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.404.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.404.error.reason` (string, optional) — query_failed: the query's own error code. ### 409 query_not_finished (with Retry-After), query_failed (with reason), query_cancelled or query_finished. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.409.error` (object, required) - `StartQuery.response.409.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.409.error.message` (string, required) - maxLength 1024 - `StartQuery.response.409.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.409.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.409.error.quota.id` (string, required) - `StartQuery.response.409.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.409.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.409.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.409.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.409.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.409.error.quota.region` (string, optional) - `StartQuery.response.409.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.409.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.409.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.409.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.409.error.reason` (string, optional) — query_failed: the query's own error code. ### 413 payload_too_large: the body is over 1 MiB. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.413.error` (object, required) - `StartQuery.response.413.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.413.error.message` (string, required) - maxLength 1024 - `StartQuery.response.413.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.413.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.413.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.413.error.quota.id` (string, required) - `StartQuery.response.413.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.413.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.413.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.413.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.413.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.413.error.quota.region` (string, optional) - `StartQuery.response.413.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.413.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.413.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.413.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.413.error.reason` (string, optional) — query_failed: the query's own error code. ### 429 too_many_requests or too_many_queries, with Retry-After; or quota_exceeded (with quota), never with Retry-After. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.429.error` (object, required) - `StartQuery.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.429.error.message` (string, required) - maxLength 1024 - `StartQuery.response.429.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.429.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.429.error.quota.id` (string, required) - `StartQuery.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.429.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.429.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.429.error.quota.region` (string, optional) - `StartQuery.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.429.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.429.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.429.error.reason` (string, optional) — query_failed: the query's own error code. ### 500 internal_error: a bug; the details are in the logs, under the request ID. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.500.error` (object, required) - `StartQuery.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.500.error.message` (string, required) - maxLength 1024 - `StartQuery.response.500.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.500.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.500.error.quota.id` (string, required) - `StartQuery.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.500.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.500.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.500.error.quota.region` (string, optional) - `StartQuery.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.500.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.500.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.500.error.reason` (string, optional) — query_failed: the query's own error code. ### 503 unavailable: a dependency the request needs is down. Retry after Retry-After. #### Example ```json { "error": { "code": "string", "column": 0, "line": 0, "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" }, "reason": "string" } } ``` - `StartQuery.response.503.error` (object, required) - `StartQuery.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `StartQuery.response.503.error.message` (string, required) - maxLength 1024 - `StartQuery.response.503.error.column` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.503.error.line` (integer, optional) — invalid_query: where the SQL went wrong. - `StartQuery.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After. - `StartQuery.response.503.error.quota.id` (string, required) - `StartQuery.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `StartQuery.response.503.error.quota.limit` (integer, required) - min 0 - `StartQuery.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `StartQuery.response.503.error.quota.inFlight` (integer, optional) - min 0 - `StartQuery.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `StartQuery.response.503.error.quota.region` (string, optional) - `StartQuery.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `StartQuery.response.503.error.quota.scopeResourceName` (string, optional) - `StartQuery.response.503.error.quota.used` (integer, optional) - min 0 - `StartQuery.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. - `StartQuery.response.503.error.reason` (string, optional) — query_failed: the query's own error code. Source: https://docs.ezghcloud.com/trails-api/queries/StartQuery/index.md