List containers

GET 
/node/:hostname/container/docker

List containers on the target node, optionally filtered by state.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

Target agent hostname, reserved routing value (_any, _all), or label selector (key:value).

Query Parameters

state string

Possible values: [running, stopped, all]

Default value: all

Filter containers by state. Defaults to "all".

limit integer

Possible values: >= 1 and <= 100

Default value: 20

Maximum number of containers to return.

Responses

200

List of containers.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

The hostname of the agent.

containers

object[]

List of containers on this agent.

Array [

id string

Container identifier.

name string

Container name.

image string

Image used by the container.

state string

Current container state.

created string

Container creation timestamp.

]

changed boolean

Whether the operation modified system state.

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "containers": [
        {
          "id": "a1b2c3d4e5f6",
          "name": "my-nginx",
          "image": "nginx:latest",
          "state": "running",
          "created": "2024-01-15T10:30:00Z"
        }
      ],
      "changed": true,
      "error": "string"
    }
  ]
}

400

Invalid request parameters.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error listing containers.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...