Projects API
Projects are logical groupings of related services. Use the Projects API to create, update, and manage your projects.
List Projects
Get all projects for the authenticated account.
GET /api/projects
Response:
{
"projects": [
{
"id": "proj_123",
"name": "my-app",
"createdAt": "2024-01-15T10:30:00Z"
}
]
}
Create Project
Create a new project.
POST /api/projects
Request Body:
{
"name": "my-app",
"description": "My application"
}
Response:
{
"id": "proj_123",
"name": "my-app",
"description": "My application",
"createdAt": "2024-01-15T10:30:00Z"
}
Get Project
Get a specific project by ID.
GET /api/projects/:projectId
Response:
{
"id": "proj_123",
"name": "my-app",
"description": "My application",
"createdAt": "2024-01-15T10:30:00Z"
}
Update Project
Update an existing project.
PATCH /api/projects/:projectId
Request Body:
{
"name": "my-updated-app",
"description": "Updated description"
}
Delete Project
Delete a project and all associated services.
DELETE /api/projects/:projectId
Warning
Deleting a project will also delete all services and deployments within it. This action cannot be undone.