Skip to main content

🥷 Actions

The /actions endpoint of Dashium API provides functionalities to perform various actions on Docker entities.

Use this route to execute actions such as container deletion, force stopping containers, container renaming, etc.

Endpoint​

  • Path: /actions
  • Method: GET

Response​

The response includes a list of actions available on Docker entities.

Response Example​

{
    "routes": [
        { "path": "/actions/:cluster/remove", "methods": ["DELETE"], "params": ["cluster"] },
        
        { "path": "/actions/:cluster/container/:containerName/kill", "methods": ["PUT"], "params": ["cluster", "containerName"] },
        { "path": "/actions/:cluster/container/:containerName/remove", "methods": ["DELETE"], "params": ["cluster", "containerName"] },
        { "path": "/actions/:cluster/container/:containerName/rename", "methods": ["PUT"], "params": ["cluster", "containerName"], "body": { "newName": "New Name" } },
        { "path": "/actions/:cluster/container/:containerName/start", "methods": ["PUT"], "params": ["cluster", "containerName"] },
        { "path": "/actions/:cluster/container/:containerName/restart", "methods": ["PUT"], "params": ["cluster", "containerName"] },
        { "path": "/actions/:cluster/container/:containerName/pause", "methods": ["PUT"], "params": ["cluster", "containerName"] },
        { "path": "/actions/:cluster/container/:containerName/resume", "methods": ["PUT"], "params": ["cluster", "containerName"] },
        
        { "path": "/actions/:cluster/image/:imageName/remove", "methods": ["DELETE"], "params": ["cluster", "imageName"] },
        
        { "path": "/actions/:cluster/volume/:volumeName/remove", "methods": ["DELETE"], "params": ["cluster", "volumeName"] }
    ]
}

Example​

fetch('http://your-api-url/actions')
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error(error));