Skip to Content
SeyloDocs
API referenceCompose stacks

Preview a compose stack

POST
/api/v1/compose.preview

Parses a compose file and shows the member services it would create in the project, with ports, volumes, dependencies and warnings. Creates nothing. It is a POST (mutation) only because the file is too large for a query string.

Needs services.create on the project. Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
projectId*string

Panel-issued id.

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

DNS-safe; the service's host name on the project network. Unique in its project.

Match^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
Length1 <= length <= 40
nodeId*string

Panel-issued id.

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

Response Body

Success.

application/json
  1. response
members*array<>
warnings*array<string>
Example Request
curl -X POST 'https://example.com/api/v1/compose.preview' \  -H 'Content-Type: application/json' \  -d '{  "projectId": "string",  "name": "string",  "nodeId": "string",  "source": {    "type": "inline",    "yaml": "string"  }}'
Example Response
{  "members": [    {      "composeService": "string",      "name": "string",      "action": "create",      "image": "string",      "ports": [        1      ],      "volumes": [        {          "name": "string",          "mountPath": "string",          "sharedWith": [            "string"          ]        }      ],      "dependsOn": [        "string"      ],      "envKeys": [        "string"      ],      "hasHealthCheck": true    }  ],  "warnings": [    "string"  ]}