Skip to main content
POST
/
services
Create
curl --request POST \
  --url https://app.coolify.io/api/v1/services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "activepieces",
  "name": "<string>",
  "description": "<string>",
  "project_uuid": "<string>",
  "environment_name": "<string>",
  "server_uuid": "<string>",
  "destination_uuid": "<string>",
  "instant_deploy": false
}'
{
  "uuid": "<string>",
  "domains": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.

Body

application/json
​
type
enum<string>
required

The one-click service type

Available options:
activepieces,
appsmith,
appwrite,
authentik,
babybuddy,
budge,
changedetection,
chatwoot,
classicpress-with-mariadb,
classicpress-with-mysql,
classicpress-without-database,
cloudflared,
code-server,
dashboard,
directus,
directus-with-postgresql,
docker-registry,
docuseal,
docuseal-with-postgres,
dokuwiki,
duplicati,
emby,
embystat,
fider,
filebrowser,
firefly,
formbricks,
ghost,
gitea,
gitea-with-mariadb,
gitea-with-mysql,
gitea-with-postgresql,
glance,
glances,
glitchtip,
grafana,
grafana-with-postgresql,
grocy,
heimdall,
homepage,
jellyfin,
kuzzle,
listmonk,
logto,
mediawiki,
meilisearch,
metabase,
metube,
minio,
moodle,
n8n,
n8n-with-postgresql,
next-image-transformation,
nextcloud,
nocodb,
odoo,
openblocks,
pairdrop,
penpot,
phpmyadmin,
pocketbase,
posthog,
reactive-resume,
rocketchat,
shlink,
slash,
snapdrop,
statusnook,
stirling-pdf,
supabase,
syncthing,
tolgee,
trigger,
trigger-with-external-database,
twenty,
umami,
unleash-with-postgresql,
unleash-without-database,
uptime-kuma,
vaultwarden,
vikunja,
weblate,
whoogle,
wordpress-with-mariadb,
wordpress-with-mysql,
wordpress-without-database
​
project_uuid
string
required

Project UUID.

​
environment_name
string
required

Environment name.

​
server_uuid
string
required

Server UUID.

​
name
string

Name of the service.

Maximum length: 255
​
description
string | null

Description of the service.

​
destination_uuid
string

Destination UUID. Required if server has multiple destinations.

​
instant_deploy
boolean
default:false

Start the service immediately after creation.

Response

Create a service.

​
uuid
string

Service UUID.

​
domains
string[]

Service domains.

⌘I