Skip to content

Create

POST
/services

Create a one-click service

Authorizations

Request Body required

object
type
required

The one-click service type

string
Allowed values: 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

Name of the service.

string
<= 255 characters
description

Description of the service.

string
nullable
project_uuid
required

Project UUID.

string
environment_name
required

Environment name.

string
server_uuid
required

Server UUID.

string
destination_uuid

Destination UUID. Required if server has multiple destinations.

string
instant_deploy

Start the service immediately after creation.

boolean

Responses

201

Create a service.

object
uuid

Service UUID.

string
domains

Service domains.

Array<string>

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.