Subscribe to new logs
render_subscribe_logsRead-onlyIdempotent
Open a WebSocket connection to subscribe to real-time logs matching specified filters like resource, type, or text. Stream logs as they are generated.
Instructions
Subscribe to new logs. Open a websocket connection to subscribe to logs matching the provided filters. Logs are streamed in real-time as they are generated. You can query for logs across multiple resources, but all resources must be in the same region and belong to the same owner. Calls GET /logs/subscribe on the Render Public API.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | Filter request logs by their host. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported. | |
| path | No | Filter request logs by their path. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported. | |
| task | No | Filter logs by their task(s) | |
| text | No | Filter by the text of the logs. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported. | |
| type | No | Filter logs by their type. Types include `app` for application logs, `request` for request logs, and `build` for build logs. You can find the full set of types available for a query by using the `GET /logs/values` endpoint. | |
| level | No | Filter logs by their severity level. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported. | |
| limit | No | The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). | |
| method | No | Filter request logs by their requests method. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported. | |
| endTime | No | Epoch/Unix timestamp of end of time range to return. Defaults to `now()`. | |
| ownerId | Yes | The ID of the workspace to return logs for | |
| taskRun | No | Filter logs by their task run id(s) | |
| instance | No | Filter logs by the instance they were emitted from. An instance is the id of a specific running server. | |
| resource | Yes | Filter logs by their resource. A resource is the id of a server, cronjob, job, postgres, redis, or workflow. | |
| direction | No | The direction to query logs for. Backward will return most recent logs first. Forward will start with the oldest logs in the time range. | backward |
| startTime | No | Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`. | |
| statusCode | No | Filter request logs by their status code. [Wildcards and regex](https://render.com/docs/logging#wildcards-and-regular-expressions) are supported. |