Skip to main content

Container

The /detail/:cluster/container/:containerName endpoint of the Dashium API allows you to get details about a specific Docker container.

Use this route to access detailed information about a container, including configuration details, state, and much more.

Endpoint​

  • Path: /detail/:cluster/container/:containerName
  • Method: GET
  • Parameters:
    • :cluster (Docker cluster identifier)
    • :containerName (Docker container name)

Response​

The response from this route includes details of the specified Docker container.

{
  "Id": "ID",
  "Created": "2023-12-10T21:23:54.946616826Z",
  "Path": "/bin/bash",
  "Args": [
    "-c",
    "tail -f /var/log/dmesg"
  ],
  "State": {
    "Status": "exited",
    "Running": false,
    "Paused": false,
    "Restarting": false,
    "OOMKilled": false,
    "Dead": false,
    "ExitCode": 1,
    "Error": "",
    "StartedAt": "2023-12-10T21:23:55.182110222Z",
    "FinishedAt": "2023-12-10T21:23:55.183653762Z"
  },
  // Other container details
}
  • Id: Container ID
  • Created: Container creation date
  • Path: Path of the container's entry command
  • Args: Arguments of the entry command
  • State: Current state of the container
  • Image: Image used by the container
  • Name: Container name
  • Mounts: Container mounts
  • Config: Container configuration
  • NetworkSettings: Container network settings

And many other pieces of information.

Example Usage​

Make a GET request to this route replacing :cluster with the Docker cluster identifier and :containerName with the name of the Docker container you want to query.

curl -X GET https://your-dashium-api.com/detail/cluster/1/container/my_container

Upon success, you will receive a JSON response indicating details of the specified container.