v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01251938.4 KB

apps

Inspect App

Retrieve details about an app

get/apps/{app_id}

Path parameters

app_idstring required

App ID to get details from

Query parameters

endpointIdinteger

Endpoint ID to get app details from. If not set, get details from the local endpoint

Response

Successful Response

app_idstring

App ID

endpointIdinteger

Endpoint ID(-1:Not install on app store)

app_namestring nullable

App name

app_diststring nullable

App dist

app_versionstring nullable

App version

app_officialboolean

App official

proxy_enabledboolean

Proxy enabled

statusinteger

App status(0:unknown,1:active,2:inactive,3:installing,4:error)

creationDateinteger nullable

Creation date

domain_namesobject[]

Domain names

envobject

Environment variables

gitConfigobject

Git configuration

containersobject[]

Containers

volumesobject[]

Volumes

errorstring nullable

Error message

Example response

{
  "app_id": "wordpress",
  "endpointId": 1,
  "app_name": "wordpress",
  "app_dist": "community",
  "app_version": "1.0.0",
  "app_official": true,
  "error": "Internal Server Error",
  "logs": [
    "Simple log message",
    {
      "id": "db01ae396f16",
      "status": "Installing..."
    }
  ]
}