Tail Worker Logs
Opens a server-sent events (SSE) stream that delivers real-time worker logs for a project. The stream includes log messages, request data, and exception information. A keep-alive is sent every 15 seconds. The stream times out after 5 minutes (300 seconds).
Each event is a JSON object delivered as an SSE `data` field.
> **Note**: This endpoint is served from the streaming API server, not the main API gateway.
Authentication
X-Auth-Tokenstring
### OAuth scopes
| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
| Infrastructure Deployments | read-only | `store_infrastructure_deployments_read_only` |
| Infrastructure Deployments | create preview | `store_infrastructure_deployments_create_preview` |
| Infrastructure Deployments | manage | `store_infrastructure_deployments_manage` |
| Infrastructure Projects | read-only | `store_infrastructure_projects_read_only` |
| Infrastructure Projects | manage | `store_infrastructure_projects_manage` |
| Infrastructure Logs | read-only | `store_infrastructure_logs_read_only` |
### Authentication header
| Header | Argument | Description |
|:-------|:---------|:------------|
| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |
### Further reading
For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).
For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).
For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
Path parameters
project_uuid
The UUID of the project to tail logs for.
store_hash
Permanent ID of the BigCommerce store.
Response
A stream of server-sent events with real-time worker log entries. The data attribute is stringified JSON.
Errors
400
Bad Request Error