Skip to Content
SeyloDocs
API referencePR previews

List a service's PR previews

GET
/api/v1/previews.list

Lists the PR previews of a service, open ones first, with PR, branch, URL and the status of their latest deploy.

Needs services.view on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Query Parameters

serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$

Response Body

Success.

application/json
  1. response
previews*array<>
Example Request
curl -X GET 'https://example.com/api/v1/previews.list?serviceId=string'
Example Response
{  "previews": [    {      "id": "string",      "prNumber": 1,      "prTitle": "string",      "branch": "string",      "commitSha": "string",      "previewServiceId": "string",      "url": "string",      "status": "queued",      "closedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

Get a service's PR preview settings GET

Returns whether PR previews are on for a service, their domain pattern and limit, and whether the service can have them at all (only GitHub sources can). Needs `services.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Turn PR previews on or off POST

Turns PR previews on or off and sets their domain pattern and limit. Previews use the same environment as the service, so they reach the same database: turning them on requires acknowledgeSharedEnv true. Turning them off removes open previews. Needs `services.update` on the service (a grant on its project covers it). Available to MCP clients and the assistant.