API reference

Deplo has one API. The dashboard, the MCP server, your CI and your scripts all speak it.

POST  https://deplo.example.com/api/graphql      # the API
GET   https://deplo.example.com/api/graphql      # GraphiQL, in a browser

Every page in this section is generated from the live schema, so every query, mutation and subscription is here, each with who may call it, its arguments, and a working example.

First callCopy Anchor Link

Create a token under Settings -> API tokens, then:

curl https://deplo.example.com/api/graphql \
  -H "Authorization: Bearer deplo_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"query":"{ me { username } apps { slug status } }"}'

{
  "data": {
    "me": { "username": "ada" },
    "apps": [{ "slug": "shop", "status": "active" }]
  }
}

Read Authentication for the three credentials and how a request picks its team, then Conventions for what every operation has in common.

GraphQL, by domainCopy Anchor Link

TypesCopy Anchor Link

Other transportsCopy Anchor Link

See alsoCopy Anchor Link