GET
/
v1
/
projects
/
{project}
/
boxes
/
{name}
/
services
/
{service}
cURL
curl --request GET \
  --url https://api.example.com/v1/projects/{project}/boxes/{name}/services/{service}
{
  "commands": {
    "unpublish": "<string>",
    "deploy_preview": "<string>",
    "promote": "<string>",
    "publish": "<string>",
    "start": "<string>"
  },
  "state": "<string>",
  "active": {
    "alive": true,
    "pid": 123,
    "spec": {
      "command": [
        "<string>"
      ],
      "port": 1
    }
  },
  "active_url": "<string>",
  "pid": 123,
  "preview": {
    "alive": true,
    "pid": 123,
    "spec": {
      "command": [
        "<string>"
      ],
      "port": 1
    }
  },
  "preview_url": "<string>",
  "tags": {}
}

Path Parameters

project
string
required
name
string
required
service
string
required

Response

Service status

commands
object
required
state
string
required
active
object
active_url
string | null
pid
integer<int64> | null
preview
object
preview_url
string | null
tags
object