Skip to Content
SeyloDocs
API referenceDomains

List a service's domains

GET
/api/v1/domains.list

Lists the domains of a service, primary first, with DNS and certificate status. Also says which automatic domain can be added from the node's wildcard record, if any.

Needs domains.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
domains*array<>
autoDomainSuggestion*|null
Example Request
curl -X GET 'https://example.com/api/v1/domains.list?serviceId=string'
Example Response
{  "domains": [    {      "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"    }  ],  "autoDomainSuggestion": "string"}

Check a domain's DNS GET

Resolves the domain through public resolvers now and classifies the answer (ok, missing, wrong target, Cloudflare proxied). Returns the records to create and a Cloudflare DNS link when the zone is on Cloudflare. Also refreshes the stored status. Needs `domains.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Remove a domain POST

Removes a domain from the service; requests to it stop reaching the service right away. When it was primary, the oldest remaining domain becomes primary. Needs `domains.edit` on the service (a grant on its project covers it). Available to MCP clients and the assistant, after a person approves the call.