Skip to Content
SeyloDocs
API referenceDomains

Change a domain's routing

POST
/api/v1/domains.update

Changes path prefix, strip prefix, target port, HTTPS mode, the HTTP to HTTPS redirect or the forward target of a domain. Fields left out keep their value; forward null turns a redirect-only domain back into a normal one.

Needs domains.edit 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}$
domainId*string

Panel-issued id.

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

Only requests under this path match. "/" is the whole host.

Match^/[A-Za-z0-9._~!$&'()*+,;=:@%/-]*$
Length1 <= length <= 200
stripPrefix?boolean
targetPort?integer

Port the container listens on.

Range1 <= value <= 65535
https?string|string|string
redirectToHttps?boolean
forward?|null

Response Body

Success.

application/json
  1. response
id*string

Panel-issued id.

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

Panel-issued id.

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

Lower-case host name without scheme or port, for example shop.example.com.

Match^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z][a-z0-9-]{0,62}$
Length3 <= length <= 253
pathPrefix*string

Only requests under this path match. "/" is the whole host.

Match^/[A-Za-z0-9._~!$&'()*+,;=:@%/-]*$
Length1 <= length <= 200
stripPrefix*boolean
targetPort*integer

Port the container listens on.

Range1 <= value <= 65535
https*string|string|string
redirectToHttps*boolean
auto*boolean
primary*boolean
forward*|null
middlewares*
dnsStatus*string|string|string|string|string
dnsCheckedAt*|null
certificate*
liveAt*|null
url*string
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X POST 'https://example.com/api/v1/domains.update' \  -H 'Content-Type: application/json' \  -d '{  "serviceId": "string",  "domainId": "string"}'
Example Response
{  "id": "string",  "serviceId": "string",  "host": "string",  "pathPrefix": "string",  "stripPrefix": true,  "targetPort": 1,  "https": "acme",  "redirectToHttps": true,  "auto": true,  "primary": true,  "forward": {    "url": "stringst",    "permanent": true,    "keepPath": true  },  "middlewares": {    "basicAuth": {      "usernames": [        "string"      ]    },    "ipAllowList": [      "string"    ],    "rateLimit": {      "average": 1,      "burst": 1,      "periodSeconds": 1    },    "redirects": [      {        "from": "string",        "to": "string",        "permanent": true      }    ]  },  "dnsStatus": "unknown",  "dnsCheckedAt": "2019-08-24T14:15:22Z",  "certificate": {    "status": "none",    "expiresAt": "2019-08-24T14:15:22Z",    "issuer": "string",    "error": "string"  },  "liveAt": "2019-08-24T14:15:22Z",  "url": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Make a domain primary POST

Makes this the service's primary domain: IP:port access redirects here once it is live, and ${{svc.URL}} references resolve to it. The previous primary stays as a normal domain. Needs `domains.edit` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Check a service's environment GET

Runs the env analyzer over the saved .env of a service and returns its diagnostics: syntax errors, unknown references, and internal addresses of services on another node (there is no cross-node private network). The web editor runs the same analyzer locally on unsaved text. Needs `env.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.