Enums

Every enum in the schema, A to Z. Send a value bare in a document (status: ready) and as a string in JSON variables ("ready").

AccessNodeKind

What a per-node capability set is attached to.

Value	Description
`app`
`folder`
`project`

ActivityType

Value	Description
`app`
`backup`
`cleanup`
`cron`
`database`
`deployment`
`domain`
`env`
`instance`
`integration`
`mcp`
`member`
`monitoring`
`project`
`s3`
`security`
`server`

AppStatus

Value	Description
`active`
`building`
`error`
`idle`
`queued`
`restoring`
`stopping`

BackupRunStatus

Value	Description
`canceled`
`failed`
`running`
`success`

BackupStatus

Value	Description
`canceled`
`failed`
`never`
`running`
`success`

BackupTargetKind

Value	Description
`app`
`database`

BulkAppAction

A lifecycle action run over every app in a folder or project: start, stop, or restart (stop then start).

Value	Description
`restart`
`start`
`stop`

Capability

The 44 capabilities, one action each. What each one grants is on Capabilities.

Value	Description
`configure_apps`
`configure_databases`
`control_apps`
`control_databases`
`create_apps`
`create_databases`
`create_folders`
`create_projects`
`delete_apps`
`delete_backups`
`delete_databases`
`delete_folders`
`delete_projects`
`delete_team`
`deploy`	Deprecated. Split into finer permissions. Still accepted on input, where it means: create_apps, deploy_apps, rollback_apps, control_apps, configure_apps, delete_apps, move_apps, open_app_console, manage_previews, manage_crons, create_folders, organize_folders, delete_folders, create_projects, organize_projects, delete_projects, manage_environments.
`deploy_apps`
`manage_backup_destinations`
`manage_backups`
`manage_basic_auth`
`manage_crons`
`manage_domains`
`manage_env`
`manage_environments`
`manage_git`
`manage_infra`	Deprecated. Split into finer permissions. Still accepted on input, where it means: create_databases, configure_databases, control_databases, delete_databases, open_database_console, manage_backups, restore_backups, delete_backups, manage_backup_destinations, manage_registries, manage_git, manage_tokens, manage_mcp, manage_notifications, manage_monitoring.
`manage_mcp`
`manage_members`
`manage_monitoring`
`manage_notifications`
`manage_previews`
`manage_registries`
`manage_roles`
`manage_s3`	Deprecated. Split into finer permissions. Still accepted on input, where it means: manage_backup_destinations.
`manage_team`
`manage_tokens`
`move_apps`
`open_app_console`
`open_database_console`
`organize_folders`
`organize_projects`
`restore_backups`
`reveal_secrets`
`rollback_apps`
`view`
`view_activity`
`view_logs`
`view_metrics`

CertProvider

Value	Description
`cloudflare`
`custom`
`letsencrypt`
`none`

DatabaseStatus

Value	Description
`error`
`provisioning`
`running`
`stopped`

DatabaseType

Value	Description
`clickhouse`
`mariadb`
`mongodb`
`mysql`
`postgres`
`redis`

DeploymentEnvironment

Value	Description
`preview`
`production`

DeploymentStatus

Value	Description
`building`
`canceled`
`error`
`queued`
`ready`

DeploySource

Value	Description
`COMPOSE`
`DOCKER_IMAGE`
`GIT`
`GITHUB`
`UPLOAD`

DestinationKind

Value	Description
`s3`
`server`

DestinationStatus

Value	Description
`connected`
`error`
`unverified`

DeviceKind

Value	Description
`desktop`
`mobile`
`tablet`
`unknown`

DockerCleanupRunStatus

Value	Description
`failed`
`running`
`success`

A class of Docker object a cleanup may reclaim. build_cache = the daemon's BuildKit cache. dangling_images = untagged layers (never -a). orphan_buildkit_cache = dangling volumes proven to be abandoned buildkitd stores. unused_app_images = old app images no container references, bounded per app by that app's rollbackKeep (falling back to keepImagesPerApp where a rollback is impossible). Deplo pushes to no registry, so a removed image comes back only by a rebuild - the newest image per app always survives. leftover_app_files = the config files of Apps and databases that were DELETED, judged against the stacks this instance still knows about; the only scope that removes something no rebuild recreates, so it is skipped outright on an agent too old to have the list. leftover_networks = the Docker networks of Environments and previews that are gone, judged against the same kind of list; it reclaims address space rather than disk. All are on by default.

Value	Description
`build_cache`
`dangling_images`
`leftover_app_files`
`leftover_networks`
`orphan_buildkit_cache`
`unused_app_images`

DockerCleanupTrigger

Value	Description
`manual`
`scheduled`

DomainEntrypoint

Value	Description
`web`
`websecure`

DomainStatus

A custom domain's DNS verification state.

Value	Description
`cloudflare`	Proxied through Cloudflare's orange-cloud. UNVERIFIED - treat as an open question, not a success. The host resolves to Cloudflare's anycast IPs, which are shared by every proxied domain on the internet and mask the origin, so public DNS can show only that the domain is proxied, never whether Cloudflare forwards it to this app's server or to somebody else's. The domain is routed regardless (it must be, or a correct setup could never work), but nothing has been confirmed.
`error`	A check failed unexpectedly (reserved).
`misconfigured`	Resolves to an address that is neither this app's server nor a Cloudflare edge. Not routed, unless `Domain.proxied` says another proxy answers for it.
`pending`	No A record resolves yet - the normal state of a record just created. Re-checked automatically.
`valid`	An A record resolves straight to this app's server: confirmed, and routed.

DomainWwwRedirect

Which half of a www / non-www pair serves the app, relative to this domain. toThis: the counterpart hostname redirects here. toCounterpart: this hostname redirects to its counterpart, which serves the app. none: no pair.

Value	Description
`none`
`toCounterpart`
`toThis`

EnvTarget

Value	Description
`preview`
`production`

EnvVarType

Value	Description
`plain`
`secret`

HealthCheckType

How the check asks. http requests a path over localhost inside the container; command runs a shell line and reads its exit code.

Value	Description
`command`
`http`

MigrationOutcome

One line of the report. created = it is in Deplo now. skipped = already here, or left out on purpose. failed = refused, with the server's own message. manual = it came across, but something needs a person (a private repo with no credential, a database whose host name changed, a compose file that was rewritten). unsupported = there is no Deplo equivalent.

Value	Description
`created`
`failed`
`manual`
`skipped`
`unsupported`

MigrationPlanStatus

What the preview thinks will happen to one service on the panel. new = it will be created. exists = something with that name is already here, so it is left alone. unsupported = Deplo has no such thing (a keydb database, a service the panel would not return). needs_grant = it can only be created by someone holding the host-volumes or expose-ports grant.

Value	Description
`exists`
`needs_grant`
`new`
`unsupported`

MigrationPlatform

Which product a migration reads. Deplo migrates from these two and refuses anything else by name.

Value	Description
`coolify`
`dokploy`

MountPropagation

How mounts appearing UNDER a host bind mount cross between the server and the container. Null is docker's rprivate default: the container sees only the submounts that existed when it started, so a network disk, a FUSE share or a volume another container mounts there never appears. rslave keeps following the server; rshared is two-way. Host binds only - docker rejects the option on a managed volume.

Value	Description
`rshared`
`rslave`

PasskeyKind

What holds the credential, as the authenticator itself reported it - not as the person named it.

Value	Description
`device`
`securityKey`
`synced`

RegistrationLinkStatus

Value	Description
`pending`
`revoked`
`used`

RegistrationMode

Value	Description
`existing_teams`
`own_team`

RegistryType

Value	Description
`dockerhub`
`generic`
`ghcr`
`gitlab`

Role

Value	Description
`member`
`owner`
`viewer`

S3Provider

Value	Description
`AWS`
`BACKBLAZE_B2`
`CLOUDFLARE_R2`
`DIGITALOCEAN`
`MINIO`
`OTHER`
`WASABI`

S3TestStepStatus

Value	Description
`failed`
`passed`
`skipped`

SearchKind

One kind of thing a search can return.

Value	Description
`app`
`cron`
`database`
`domain`
`environment`
`folder`
`member`
`project`
`role`
`server`
`template`

ServerReadinessGroup

Value	Description
`agent`
`build`
`capacity`
`config`
`docker`
`routing`

ServerReadinessSeverity

How much a readiness row matters. fail = a deployment to this server cannot succeed. warn = a deployment succeeds, but the result is not fully usable. info = a true, neutral fact. pass = verified good. skip = we could not evaluate it (the agent is too old, or an upstream fact is missing) - a skip never moves the verdict.

Value	Description
`fail`
`info`
`pass`
`skip`
`warn`

ServerReadinessVerdict

The report's overall answer. provisioning = no agent has called home yet (never dialed). A fail row outranks provisioning.

Value	Description
`degraded`
`not_ready`
`provisioning`
`ready`

ServerStatus

Value	Description
`error`
`offline`
`online`
`provisioning`
`warning`

ServerType

Value	Description
`remote`

TakeoverPlatform

The panel this install is replacing.

Value	Description
`coolify`
`dokploy`

TakeoverState

pending = the migration is not finished. ready = the operator asked for the machine and the installer is moving the ports. failed = the cutover rolled back; error says why and it can be asked for again. done = the ports are Deplo's. removing / removed = the old platform is coming off the disk. cancelled = the operator backed out and Deplo is uninstalling itself.

Value	Description
`cancelled`
`done`
`failed`
`pending`
`ready`
`removed`
`removing`

TeamPlan

Value	Description
`enterprise`
`pro`

On this page