Inspect an exec instance Run in API Explorer

GET /exec/{id}/json

Return low-level information about an exec instance.

Path parameters

  • id string Required

    Exec instance ID

Responses

  • 200 application/json

    No error

    Hide response attributes Show response attributes object
    • CanRemove boolean
    • DetachKeys string
    • ID string
    • Running boolean
    • ExitCode integer
    • ProcessConfig object
      Hide ProcessConfig attributes Show ProcessConfig attributes object
      • privileged boolean
      • user string
      • tty boolean
      • entrypoint string
      • arguments array[string]
    • OpenStdin boolean
    • OpenStderr boolean
    • OpenStdout boolean
    • ContainerID string
    • Pid integer

      The system process ID for the exec process.
  • 404 application/json

    No such exec instance

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
  • 500 application/json

    Server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
GET /exec/{id}/json 
curl \
 --request GET 'http://api.example.com/v1.44/exec/{id}/json'
Response examples (200) 
{
  "ID": "f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b",
  "Pid": 42000,
  "Running": false,
  "ExitCode": 2,
  "CanRemove": false,
  "OpenStdin": true,
  "DetachKeys": "",
  "OpenStderr": true,
  "OpenStdout": true,
  "ContainerID": "b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126",
  "ProcessConfig": {
    "tty": true,
    "user": "1000",
    "arguments": [
      "-c",
      "exit 2"
    ],
    "entrypoint": "sh",
    "privileged": false
  }
}
Response examples (200) 
{
  "CanRemove": true,
  "DetachKeys": "string",
  "ID": "string",
  "Running": true,
  "ExitCode": 42,
  "ProcessConfig": {
    "privileged": true,
    "user": "string",
    "tty": true,
    "entrypoint": "string",
    "arguments": [
      "string"
    ]
  },
  "OpenStdin": true,
  "OpenStderr": true,
  "OpenStdout": true,
  "ContainerID": "string",
  "Pid": 42
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}