Skip to Content
SeyloDocs
API referencePR previews

Turn PR previews on or off

POST
/api/v1/previews.updateSettings

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.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$
enabled?boolean
domainPattern?string
Lengthlength <= 253
maxPreviews?integer
Range1 <= value <= 50
acknowledgeSharedEnv?boolean

Response Body

Success.

application/json
  1. response
enabled*boolean
domainPattern*string
Lengthlength <= 253
maxPreviews*integer
Range1 <= value <= 50
Example Request
curl -X POST 'https://example.com/api/v1/previews.updateSettings' \  -H 'Content-Type: application/json' \  -d '{  "serviceId": "string"}'
Example Response
{  "enabled": true,  "domainPattern": "string",  "maxPreviews": 1}

List a service's PR previews GET

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.

Create a project POST

Creates an empty project. Services are added to it afterwards. Needs `projects.create`, which owners and admins hold. Available to MCP clients and the assistant.