Skip to Content
SeyloDocs
API referencePR previews

Get a service's PR preview settings

GET
/api/v1/previews.getSettings

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.

Authorization

cookieseylo_session<token>

Query Parameters

serviceId*string

Panel-issued id.

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

Response Body

Success.

application/json
  1. response
settings*
available*boolean
unavailableReason*string|null
Example Request
curl -X GET 'https://example.com/api/v1/previews.getSettings?serviceId=string'
Example Response
{  "settings": {    "enabled": true,    "domainPattern": "string",    "maxPreviews": 1  },  "available": true,  "unavailableReason": "string"}

Delete a PR preview POST

Deletes a PR preview's service with its containers and volumes. The next push to the PR creates it again while previews are on. Needs `services.update` on the service (a grant on its project covers it). Available to MCP clients and the assistant, after a person approves the call.

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.