List applications

Every application on the server.

GET/api/v1/apps

Returns every application on the server. Works with a viewer or an admin token.

Authorizations

bearerAuthbearer
An API token created in Settings → API tokens. Tokens start with qsr_.

Request

curl -X GET 'https://admin.your-domain.com/api/v1/apps' \
  -H 'Authorization: Bearer $TOKEN'

Responses

200

200Every application.

appsApp[]required
Show child attributes
- idstringrequired
  Identifier of the application.
- namestringrequired
- subdomainstringrequired
  @ for an application served on the root domain.
- hoststringrequired
  The host the application is served on.
- deploy_type"image" | "git" | "compose"required
- image_refstring
  The image, for image applications.
- git_urlstring
  The repository, for git applications.
- git_branchstring
  The branch, for git applications.
- portintegerrequired
  Port the application listens on inside its container.
- statestringrequired
  running, stopped, error (crashed, or only part of a stack is up), deploying or not deployed. Other Docker states, such as restarting, are passed through as they are.
- uptimestring
  How long the application has been running, such as 12m, 5h 20m or 3d 4h. Only set while it is running.

Response

{
  "apps": [
    {
      "id": "3f9c2a7e",
      "name": "Blog",
      "subdomain": "blog",
      "host": "blog.your-domain.com",
      "deploy_type": "git",
      "git_url": "https://github.com/me/blog.git",
      "git_branch": "main",
      "port": 3000,
      "state": "running",
      "uptime": "3d 4h"
    }
  ]
}

401

401The token is missing or invalid.

errorstringrequired
What went wrong.

Response

{
  "error": "invalid token"
}