Skip to main content

Remove

The /actions/:cluster/volume/:volumeName/remove endpoint of the Dashium API allows you to remove a Docker volume.

Endpoint​

  • Path: /actions/:cluster/volume/:volumeName/remove
  • Method: DELETE

Parameters​

  • :cluster (path parameter): The ID of the cluster containing the volume.
  • :volumeName (path parameter): The name or ID of the volume to be removed.

Response​

The response confirms the successful removal of the Docker volume.

Response Example​

{
    "info": "Volume {volumeName} removed!"
}

Example​

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