What importing a Compose file would create: a project, and a service per
Compose service with its source, ports, variables, volumes and health
check, in deploy order. It adds a warning for each thing that isn't
carried over. Nothing is created. Edit the plan if you like, then pass it
to the importCompose operation.
API key access: read.
apiKeyAuthorizationBearer <pyo_…>An API key from the dashboard's API keys page: Authorization: Bearer pyo_…. Keys can expire, and an expired one gets a 401.
application/jsonteamId*stringplatform*Platform"coolify" or "dokploy".
"coolify""dokploy"url*stringThe platform's address, e.g. https://coolify.example.com.
token*stringAn API token of the platform's: Coolify's with read and read:sensitive, or a Dokploy API key. Used for this request only, never stored.
The plan.
application/jsonA whole import: what will be created, and what was left out.
project*services*array<>In deploy order: a service comes after those it depends on.
warnings*array<>curl -X POST 'https://your-pyo.example.com/api/v1/compose/preview' \
-H 'Content-Type: application/json' \
-d '{
"teamId": "string",
"platform": "coolify",
"url": "string",
"token": "string"
}'{
"project": {
"name": "string",
"namespace": "string"
},
"services": [
{
"name": "string",
"composeName": "string",
"source": {
"type": "string",
"image": "string",
"reference": "string",
"repoUrl": "string",
"branch": "string",
"buildContext": "string",
"dockerfilePath": "string",
"buildArgs": [
{
"key": "string",
"value": "string",
"secret": true
}
],
"installationId": 0,
"private": true
},
"ports": [
{
"name": "string",
"containerPort": 0,
"protocol": "string",
"public": true,
"publicPort": 0,
"domain": "string"
}
],
"env": [
{
"key": "string",
"value": "string",
"secret": true
}
],
"volumes": [
{
"name": "string",
"mountPath": "string",
"sizeGi": 0,
"fromBind": true
}
],
"healthCheck": {},
"replicas": 0,
"resources": {
"cpuRequest": 0,
"cpuLimit": 0,
"memoryRequest": 0,
"memoryLimit": 0,
"gpu": 0
},
"container": {},
"dependsOn": [
"string"
]
}
],
"warnings": [
{
"service": "string",
"field": "string",
"message": "string"
}
]
}