Create a container

POST 
/node/:hostname/container/docker

Create a new container on the target node. Returns a job ID for tracking the asynchronous operation.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

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

application/json

Body

required

Container creation parameters.

image stringrequired

Container image reference (e.g., "nginx:latest").

name string

Optional name for the container.

command string[]

Command to run in the container.

env string[]

Environment variables in KEY=VALUE format.

ports string[]

Port mappings in host_port:container_port format.

volumes string[]

Volume mounts in host_path:container_path format.

auto_start boolean

Default value: true

Whether to start the container immediately after creation. Defaults to true.

Responses

202

Container creation accepted.

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.

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",
      "id": "a1b2c3d4e5f6",
      "name": "my-nginx",
      "image": "nginx:latest",
      "state": "running",
      "created": "2024-01-15T10:30:00Z",
      "changed": true,
      "error": "string"
    }
  ]
}

400

Invalid request payload.

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 creating container.

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...