Subscribe to new logs

get

https://api.render.com/v1/logs/subscribe

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ownerId

string

required

The ID of the workspace to return logs for

startTime

date-time

Epoch/Unix timestamp of start of time range to return. Defaults to now() - 1 hour.

endTime

date-time

Epoch/Unix timestamp of end of time range to return. Defaults to now().

direction

string

enum

Defaults to backward

The direction to query logs for. Backward will return most recent logs first. Forward will start with the oldest logs in the time range.

Allowed:

resource

array of strings

required

Filter logs by their resource. A resource is the id of a server, cronjob, job, postgres, redis, or workflow.

resource*

instance

array of strings

Filter logs by the instance they were emitted from. An instance is the id of a specific running server.

instance

host

array of strings

Filter request logs by their host. Wildcards and regex are supported.

host

statusCode

array of strings

Filter request logs by their status code. Wildcards and regex are supported.

statusCode

method

array of strings

Filter request logs by their requests method. Wildcards and regex are supported.

method

task

array of strings

Filter logs by their task(s)

task

taskRun

array of strings

Filter logs by their task run id(s)

taskRun

level

array of strings

Filter logs by their severity level. Wildcards and regex are supported.

level

type

array of strings

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.

type

text

array of strings

Filter by the text of the logs. Wildcards and regex are supported.

text

path

array of strings

Filter request logs by their path. Wildcards and regex are supported.

path

limit

integer

1 to 100

Defaults to 20

The maximum number of items to return. For details, see Pagination.

Responses

101The connection has been upgraded to a websocket. The server will send log messages as they are generated in the format defined below.

400The request could not be understood by the server.

401Authorization information is missing or invalid.

403You do not have permissions for the requested resource.

404Unable to find the requested resource.

406Unable to generate preferred media types as specified by Accept request header.

410The requested resource is no longer available.

429Rate limit has been surpassed.

500An unexpected server error has occurred.

503Server currently unavailable.