API reference
GraphQL, the REST exceptions, the deploy hook and the MCP server.
There is no separate REST resource API: everything routes through one GraphQL endpoint, except a handful of transports GraphQL is the wrong shape for. If you are looking for how to create and scope a credential first, read API tokens.
GraphQL
Deplo exposes a single GraphQL endpoint that is the canonical way to drive the platform. The dashboard UI and any external client (CI, a script, your own tooling) speak the same API.
POST https://<your-deplo-host>/api/graphql
GET https://<your-deplo-host>/api/graphql # GraphiQL explorer (in a browser)The full schema is published as schema.graphql at the repo root, and
browsable interactively via GraphiQL at the endpoint above. Read
Conventions once before the domain pages
below, it covers what every mutation and subscription has in common so
each domain page doesn't have to repeat it.
Identity and access
Authentication
Session cookie, API token, OAuth
API tokens
Creating, scoping and revoking a token
Session and login
What only a signed-in person can do
Authorization
The capability model
Instance-admin operations
Users, Docker cleanup, the panel's own address
The platform
Apps
Catalogue, deployments, framework detection
Environment variables
App-level and team-owned shared variables
Domains and TLS
Hostnames and a host's own certificates
Projects and environments
The containers apps live in
Databases
Managed Postgres, MySQL, MongoDB and more
Servers
Enrolling, roling and removing a machine
Teams and members
Membership, roles and the team itself
Activity
The read-only audit trail
Backup destinations
Testing a destination before you trust it
Migration and other transports
Errors
Errors come back in the standard GraphQL errors[] array. The message
is safe to show a user (e.g. "You don't have permission to deploy");
internal stack traces are never leaked.
See also
Did this page help you?