Documentation
Deploy through the API
Ship a registry image or a ZIP artifact straight from your pipeline.
Deploy
Requires «Deploy» permission and a domain in the key scope. The same endpoint covers registry images and ZIP/binary artifacts.
Registry deploy (Docker image)
Domain with deploy_source=registry. image_ref must match the repository configured on the domain. Optional strategy (e.g. all_in).
curl -sfS -X POST "${HOST_API_URL}/v1/domains/{DOMAIN_ID}/deploy" \
-H "Authorization: Bearer ${HOST_DEPLOY_TOKEN}" \
-H "Content-Type: application/json" \
-d '{"image_ref":"myorg/api:v1.2.3","strategy":"all_in"}'
Artifact deploy (ZIP or binary)
Domain with deploy_source=artifact. Send multipart/form-data with the file field.
curl -sfS -X POST "${HOST_API_URL}/v1/domains/{DOMAIN_ID}/deploy" \
-H "Authorization: Bearer ${HOST_DEPLOY_TOKEN}" \
-F "[email protected]"
Deploy status
List domain deployments or fetch a specific deployment by ID.
curl -sfS "${HOST_API_URL}/v1/domains/{DOMAIN_ID}/deployments" \
-H "Authorization: Bearer ${HOST_DEPLOY_TOKEN}"
curl -sfS "${HOST_API_URL}/v1/domains/{DOMAIN_ID}/deployments/{DEPLOY_ID}" \
-H "Authorization: Bearer ${HOST_DEPLOY_TOKEN}"
Artifact download in containers
Set APP_URL (admin hostname) or APP_IP (IP reachable from containers) so runtimes can download artifacts. HMAC grant is per domain (stable across rollbacks).
Ready to run your own Hub?
Start free and manage your first domains in minutes.
Create your free account →