API Reference

Last updated: April 12, 2026

ShipDock exposes a full REST API allowing you to programmatically monitor and orchestrate your infrastructure.

Authentication

Pass your Personal Access Token (generated in your Dashboard Account Settings) via the standard Authorization HTTP Header:

Authorization: Bearer shp_xxxxxxxxxxxxxxxxxxxxxxxxxx

Engine Endpoints

GET/api/servers/

List all connected VPS instances and their health status.

POST/api/deployments/

Trigger a manual build and deployment bypass for a specific project.

GET/api/deployments/{id}/logs

Retrieve historical STDOUT build logs array for a single pipeline.

DELETE/api/projects/{id}

Hard teardown the project from the connected Traefik proxy cluster.

OpenAPI 3.0 specs will be explicitly available in upcoming v1.1 release patch.