Authentication
All API requests require authentication using a Bearer token. You can generate API tokens from your dashboard settings.
Request Header
Authorization: Bearer dp_live_xxxxxxxxxxxxxxxxxxxxKeep your API tokens secure. Never expose them in client-side code or public repositories.
Base URL
All API requests should be made to the following base URL:
Base URL
https://api.shipyard.dev/v1Rate Limits
API requests are rate limited based on your plan:
| Plan | Requests/min | Requests/day |
|---|---|---|
| Free | 60 | 1,000 |
| Pro | 300 | 10,000 |
| Enterprise | Unlimited | Unlimited |
Projects
Manage your projects programmatically.
GET
/projects
List all projects in your account.
$ curl -X GET https://api.shipyard.dev/v1/projects \
-H "Authorization: Bearer dp_live_xxx"
Response 200 OK
{
"data": [
{
"id": "prj_abc123",
"name": "my-app",
"framework": "nextjs",
"created_at": "2024-01-15T10:30:00Z"
}
],
"meta": { "total": 1, "page": 1 }
}
POST
/projects
Create a new project.
Request Body
name
string
required
Project name (lowercase, alphanumeric, hyphens)
git_repository
string
required
Git repository URL
framework
string
Framework type (auto-detected if not specified)
Deployments
Trigger and manage deployments.
GET
/projects/:id/deployments
List all deployments for a project.
POST
/deployments
Trigger a new deployment.
DELETE
/deployments/:id
Cancel a running deployment.
Need help with the API?
Check out our guides or reach out to our developer support team.