v1

latestOpenAPI 3.1.02026-07-1213613295.5 KB

Services

Create service

Create a one-click / custom service

post/services

typestring

The one-click service type (e.g. "actualbudget", "calibre-web", "gitea-with-mysql" ...)

namestring

Name of the service.

descriptionstring nullable

Description of the service.

project_uuidstring required

Project UUID.

environment_namestring required

Environment name. You need to provide at least one of environment_name or environment_uuid.

environment_uuidstring required

Environment UUID. You need to provide at least one of environment_name or environment_uuid.

server_uuidstring required

Server UUID.

destination_uuidstring

Destination UUID. Required if server has multiple destinations.

instant_deployboolean

Start the service immediately after creation.

docker_compose_rawstring

The base64 encoded Docker Compose content.

force_domain_overrideboolean

Force domain override even if conflicts are detected.

is_container_label_escape_enabledboolean

Escape special characters in labels. By default, $ (and other chars) is escaped. If you want to use env variables inside the labels, turn this off.

Service created successfully.

uuidstring

Service UUID.

domainsstring[]

Service domains.