Skip to main content

Stop

The /actions/:cluster/container/:containerName/stop endpoint of the Dashium API allows you to stop a Docker container.

Endpoint​

  • Path: /actions/:cluster/container/:containerName/stop
  • Method: PUT

Parameters​

  • :cluster (path parameter): The ID of the cluster containing the container.
  • :containerName (path parameter): The name of the container to stop.

Response​

The response confirms the successful stopping of the Docker container.

Response Example​

{
    "info": "Container {containerName} stopped!"
}

Exemple​

fetch('http://your-api-url/actions/your-cluster/container/your-container/stop', {
    method: 'PUT',
})
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error(error));