Skip to content

List containers

Request

Requires node-exec::read permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/node/{nodeID}/exec/container' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
Array [
commandstring

Command to run in the container

descriptionstring

Container description

Example:"my container"
enabledboolean
execTypestring

Execution type

Enum:"onDemand""service""recurring"
hostnamestring

Container hostname

Example:"mycontainer"
idstring

Container ID

Example:"b4011aa3-d0d5-4c5c-9c0b-19095ba515d5"
imageobject(Image)

Image

namestring

Container name

Example:"mycontainer"
privilegedboolean

Run the container as a privileged user

requireConnectivityboolean

Only start the container if the node has connectivity to the control plane. Needed for encrypted volumes.

stopTimestring

Grace period for container to stop when requested, in seconds

Example:"60"
useInitboolean

Indicates that an init process should be used as PID 1 in the container. Ensures responsibilities of an init system are performed inside the container (e.g., handling exit signals).

userstring

User name (or UID) and optionally the group (or GID) to use when starting the container. This will override the USER specified in the image

nodeUidstring

UUID of the node this container is configured on

namespacestring

Container namespace, typically "exec"

saveOutputboolean

Whether to persist stdout/stderr from on-demand container runs

]
Response
[
  {
    "command": "string",
    "description": "my container",
    "enabled": true,
    "execType": "onDemand",
    "hostname": "mycontainer",
    "id": "b4011aa3-d0d5-4c5c-9c0b-19095ba515d5",
    "image": { … },
    "name": "mycontainer",
    "privileged": true,
    "requireConnectivity": true,
    "stopTime": "60",
    "useInit": true,
    "user": "string",
    "nodeUid": "string",
    "namespace": "string",
    "saveOutput": true
  }
]