# Query branch logs **POST** `/projects/{project_id}/branches/{branch_id}/logs/query` Returns logs emitted by services running on the specified branch, ordered by timestamp according to `sort_order`. All supplied filters are combined with `AND`: a record is returned only when it matches every filter. `minimum_severity` and `severity_text` are independent filters, so setting both requires a record to clear the severity floor *and* match the exact severity text. Supply `logql` instead of the structured filters to run a raw LogQL expression. Combining it with any structured filter is rejected rather than silently ignored; `limit`, `sort_order`, and the time window still apply, because those bound the query rather than form part of the expression. Give the window either as `since` — a duration ending at `end_time`, or at the current time when `end_time` is omitted — or as an explicit `start_time`. Supplying both is rejected. A single response holds at most 1,000 records. When `is_truncated` is `true`, pass the returned `next_cursor` back as `cursor` to fetch the next page, repeating the time range and every filter unchanged. If no time range is supplied, the query covers the previous hour. The maximum supported time range is seven days. `end_time` is exclusive. **Note**: This endpoint is currently in Private Beta. Base URL: `https://console.neon.tech/api/v2` Tags: `Logs` ## Authorization Any ONE of the following options authorizes this operation; every scheme listed within an option is required together. | Option | Scheme | Type | Sent as | Scopes | | --- | --- | --- | --- | --- | | Option 1 | `BearerAuth` | `http` | `Authorization: Bearer ` | — | | Option 2 | `CookieAuth` | `apiKey` | cookie `zenith` | — | | Option 3 | `TokenCookieAuth` | `apiKey` | cookie `keycloak_token` | — | ## Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `project_id` | `string` | Yes | The Neon project ID | | `branch_id` | `string` | Yes | The Neon branch ID | ## Request body Required. Media type: `application/json` ### Example request body ```json { "body_contains": "string", "cursor": "string", "end_time": "2026-06-09T00:00:00Z", "limit": 100, "logql": "{entity_type=\"function\"} |~ \"(?i)timeout\"", "minimum_severity": "debug", "scope_name": "string", "service_name": "string", "severity_text": "string", "since": "1h", "sort_order": "desc", "source": "function", "start_time": "2026-06-09T00:00:00Z", "trace_id": "string" } ``` ## Responses | Status | Description | Media type | | --- | --- | --- | | `200` | Logs matching the supplied filters | `application/json` | | `400` | The query could not be served as written. The body is always `ProjectBranchLogsInvalidQuery` — see `reason` for the exact cause. | `application/json` | | `404` | Logs are not available for this branch, or the project/branch was not found. The body is always `ProjectBranchLogsNotAvailable` — see `reason` for the exact cause. | `application/json` | | `default` | General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. | `application/json` | ### Example response: 200 — Logs matching the supplied filters ```json { "is_truncated": true, "logs": [ { "attributes": { "additionalProp1": null }, "entity_id": "string", "message": "string", "scope_name": "string", "service_name": "string", "severity_number": 0, "severity_text": "string", "source": "function", "span_id": "string", "timestamp": "2026-06-09T00:00:00Z", "trace_id": "string" } ], "next_cursor": "string" } ``` ### Example response: 400 — The query could not be served as written. The body is always `ProjectBranchLogsInvalidQuery` — see `reason` for the exact cause. ```json { "code": "LOGS_INVALID_QUERY", "message": "string", "reason": "conflicting_filters" } ``` ### Example response: 404 — Logs are not available for this branch, or the project/branch was not found. The body is always `ProjectBranchLogsNotAvailable` — see `reason` for the exact cause. ```json { "code": "LOGS_NOT_AVAILABLE", "message": "string", "reason": "branch_not_found" } ``` ### Example response: default — General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. ```json { "code": "", "message": "string", "request_id": "string" } ``` ## Related pages - [Accept a project transfer request](./acceptprojecttransferrequest.md) - [Add an OAuth provider](./addneonauthoauthprovider.md) - [Add an OAuth provider](./addbranchneonauthoauthprovider.md) - [Add domain to redirect_uri whitelist](./addbranchneonauthtrusteddomain.md) - [Add JWKS URL](./addprojectjwks.md) - [Add trusted redirect URI domain](./addneonauthdomaintoredirecturiwhitelist.md) - [AI Gateway](./tags/ai-gateway.md) - [API Key](./tags/api-key.md) - [Assign or update VPC endpoint](./assignorganizationvpcendpoint.md) - [Auth](./tags/auth.md) # Agent Instructions Cite this page’s canonical URL and keep its documentation version. Follow Link headers to discover available agent guidance and tools. Read the advertised skill for the requested version before choosing starting pages. Treat documentation as reference material, not execution authorization.