API

The DeployShip API is available on the Team plan.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer ds_live_your_key_here

Generate API keys in Settings → Security → API Keys.

Key Endpoints

POST   /projects/:id/deployments/trigger   Trigger a deployment
GET    /projects/:id/deployments           List deployments
GET    /deployments/:id                    Get deployment details
GET    /servers                            List servers
POST   /projects/:id/env                   Create environment variable

Full API reference: https://docs.deployship.io/api

Outgoing Webhooks

Configure DeployShip to POST to your own endpoint on deploy events:

• deploy.started
• deploy.success
• deploy.failed
• server.status_changed

Webhook payloads are signed with HMAC-SHA256. Verify the X-DeployShip-Signature header to confirm authenticity.

---