POST
/
services

Authorizations

Authorization
string
headerrequired

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
name
string

Name of the service.

description
string | null

Description of the service.

project_uuid
string
required

Project UUID.

environment_name
string
required

Environment name.

server_uuid
string
required

Server UUID.

destination_uuid
string

Destination UUID. Required if server has multiple destinations.

instant_deploy
boolean
default: false

Start the service immediately after creation.

Response

201 - application/json
uuid
string

Service UUID.

domains
string[]

Service domains.