Complete REST API documentation for SnapDeploy
All API requests require authentication using an API key.
Get your API key from API Keys page in your dashboard
/api/containers
List all containers for the authenticated user.
[
{
"containerId": "cont-abc123",
"containerName": "my-app",
"status": "RUNNING",
"imageName": "nginx:latest",
"cpu": "512",
"memory": "1024",
"createdAt": "2025-11-26T10:00:00Z"
}
]
/api/containers/deploy
Deploy a new container from a Docker image.
{
"imageName": "nginx:latest",
"containerName": "my-app",
"cpu": "512",
"memory": "1024",
"environmentVariables": {
"PORT": "8080",
"NODE_ENV": "production"
}
}
{
"containerId": "cont-abc123",
"status": "DEPLOYING",
"message": "Container deployment started"
}
/api/containers/{containerId}
Get details of a specific container.
/api/containers/{containerId}/stop
Stop a running container.
/api/containers/{containerId}
Delete a container permanently.
/api/deployments/github
Deploy directly from a GitHub repository.
{
"repoUrl": "https://github.com/username/repo",
"branch": "main",
"containerName": "my-github-app",
"buildCommand": "npm run build",
"startCommand": "npm start"
}
/api/deployments
List all deployments with their status.
/api/logs/{containerId}
Retrieve container logs.
startTime - ISO 8601 timestampendTime - ISO 8601 timestamplimit - Max number of log lines (default: 100)/api/metrics/{containerId}
Get performance metrics for a container.
{
"cpu": {
"current": 45.2,
"average": 38.7,
"max": 87.3
},
"memory": {
"current": 512,
"average": 478,
"max": 1024
},
"network": {
"bytesIn": 1048576,
"bytesOut": 524288
}
}
Get your API key and start deploying in minutes