Image Manager API

Get Image List

GET /api/environment/image

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string;
}

Response

{
  "status": 200,
  "data": DockerImageList,
  "time": 1718594177859
}

DockerImageList: https://docs.docker.com/engine/api/v1.37/#tag/Image/operation/ImageList

Get Container List

GET /api/environment/containers

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string;
}

Response

{
  "status": 200,
  "data": DockerContainerList,
  "time": 1718594177859
}

DockerContainerList: https://docs.docker.com/engine/api/v1.37/#tag/Container/operation/ContainerList

Get Network Mode List

GET /api/environment/networkModes

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string;
}

Response

{
  "status": 200,
  "data": DockerNetworkList,
  "time": 1718594177859
}

DockerNetworkList: https://docs.docker.com/engine/api/v1.37/#tag/Network/operation/NetworkList

Create Image

POST /api/environment/image

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string,
}

Request Body

{
  "dockerFile": "...", // DockerFile Config
  "name": "mcsm-custom", // Image Name
  "tag": "latest" // Version
}

Response

{
  "status": 200,
  "data": true,
  "time": 1718594177859
}

TIP

The image build runs asynchronously. The response returns true immediately before the build completes. Use the Build Progress endpoint to track the build status.

Delete Image

DELETE /api/environment/image

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string;
  imageId: string; // Docker image ID
}

Response

{
  "status": 200,
  "data": true,
  "time": 1718594177859
}

Build Progress

GET /api/environment/progress

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string,
}

Response

{
  "status": 200,
  "data": {
    "mcsm-custom:latest": -1 // -1 = Failed, 1 = Building, 2 = Complete
    // ...more...
  },
  "time": 1718594177859
}

Get Image Platforms

POST /api/environment/image_platforms

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  daemonId: string;
}

Request Body

{
  "imageName": "nginx:latest" // Image name (supports image:tag, namespace/image:tag, registry/repo/image:tag)
}

Response

{
  "status": 200,
  "data": [
    "linux/amd64",
    "linux/arm64",
    "linux/arm/v7"
  ],
  "time": 1718594177859
}

TIP

This endpoint queries supported platforms via the daemon's Docker service. Returns an empty array if platforms cannot be determined.

Get Docker Hub Image Platforms

POST /api/environment/dockerhub_image_platforms

TIP

This endpoint fetches platform information directly from Docker Hub (or a custom registry) via the Docker Registry HTTP API V2, bypassing the daemon. Useful for querying available platforms before pulling an image.

Request Body

{
  "imageName": "nginx:latest" // Image name (supports image:tag, namespace/image:tag, registry/repo/image:tag)
}

Response

{
  "status": 200,
  "data": [
    "linux/amd64",
    "linux/arm64",
    "linux/arm/v7"
  ],
  "time": 1718594177859
}

WARNING

If the request fails (e.g. network timeout, private repository without authentication), an empty array [] is returned as a graceful fallback.