Get a deploy server (poll status until 'ready'; init_step shows provisioning progress)
Requires the deploy_servers:read permission.
An access token from this zone's POST /oauth/token, or a session token from POST /api/v1/auth/login. Send it as Authorization: Bearer <token>.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/deploy-servers/string"{ "app_instance_type": "string", "created_at": "2019-08-24T14:15:22Z", "dashboard_url": "string", "id": "string", "init_step": "string", "name": "string", "reason": "string", "status": "string", "tags": { "property1": "string", "property2": "string" }, "tenant_id": "string", "updated_at": "2019-08-24T14:15:22Z", "vpc_id": "string", "wildcard_domain": "string", "worker_count": 0, "worker_disk_gib": 0, "worker_instance_type": "string", "worker_microvm_id": "string", "workers": [ { "coolify_server_uuid": "string", "index": 0, "microvm_id": "string", "primary": true, "private_ip": "string", "public_ip": "string", "registered": true } ]}Create the tenant's deploy server (Coolify) — idempotent: returns the existing one if present. This is the REQUIRED first step before deploying any app; it provisions the Coolify control plane + a worker automatically. POST
Previous Page
Scale a deploy server: worker_count adds/removes deploy targets (1-10), worker_instance_type resizes every worker, worker_disk_gib grows their disks (grow-only), app_instance_type resizes the Coolify control plane. Workers change ONE at a time and the dashboard keeps serving; poll workers[] until every entry has registered=true. Resizing a worker RESTARTS it, briefly interrupting the apps on it. PUT
Next Page