service
Create, update, delete, start, stop, restart, deploy services, and manage environment variables on Coolify instances.
Instructions
Service CRUD, lifecycle, and environment-variable actions — list via resource tool. Actions: get(uuid, format?, projection?, reveal?) · list-types(format?, projection?) · create(server_uuid, type?, compose?) · update(uuid) · delete(uuid, confirm) · delete_preview(uuid) · start(uuid) · stop(uuid) · restart(uuid) · deploy(uuid) · envs:list(uuid) · envs:get(uuid, key) · envs:create(uuid, key, value) · envs:update(uuid, key, value) · envs:delete(uuid, env_uuid, confirm) · envs:bulk-update(uuid, entries, confirm) Safety: confirm for destructive ops · optional instance · reveal opt-in only
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | Environment variable key | |
| fqdn | No | Application FQDN substring | |
| name | No | Service name substring | |
| page | No | Page number for pagination | |
| type | No | One-click service type, e.g. actualbudget, calibre-web, gitea-with-mysql | |
| urls | No | Optional domain URLs | |
| uuid | No | Service UUID | |
| value | No | Environment variable value | |
| action | Yes | The action to run | |
| format | No | Output format (default pretty) | |
| reveal | No | Reveal sensitive/masked values in full projection (default false — secrets masked as ***) | |
| compose | No | Inline Docker Compose YAML | |
| confirm | No | Explicit confirmation for destructive ops | |
| entries | No | Bulk env entries (min 1, max 100 per call) | |
| env_uuid | No | Environment variable UUID | |
| instance | No | Coolify instance name from registry (optional — uses env credentials or registry default) | |
| per_page | No | Items per page | |
| max_chars | No | Max formatted output characters (default 16000) | |
| is_literal | No | Literal flag | |
| is_preview | No | Preview variable | |
| projection | No | Detail projection depth | |
| description | No | Service description | |
| pull_latest | No | Pull latest Docker images before restart | |
| server_uuid | No | Target server UUID | |
| compose_file | No | Local path to a docker-compose.yml file (max 1 MiB) | |
| include_full | No | Alias for projection: full | |
| is_multiline | No | Multiline flag | |
| project_name | No | Project name | |
| project_uuid | No | Project UUID | |
| is_shown_once | No | Show-once flag | |
| delete_volumes | No | Also delete attached volumes | |
| docker_cleanup | No | Run Docker cleanup on stop | |
| instant_deploy | No | Start/deploy immediately after create | |
| destination_uuid | No | Destination UUID | |
| environment_name | No | Environment name | |
| environment_uuid | No | Environment UUID | |
| delete_configurations | No | Also delete configurations | |
| force_domain_override | No | Override domain conflict | |
| connect_to_docker_network | No | Connect to Docker network | |
| delete_connected_networks | No | Delete connected networks | |
| is_container_label_escape_enabled | No | Container label escape enabled |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | No | ||
| _meta | No | ||
| error | No | ||
| _size_warning | No | ||
| _formattedText | No |