Api
Projects
Manage your projects, which serve as containers for organizing your cloud resources.
Projects
Manage your projects, which serve as containers for organizing your cloud resources.
List Projects
GET /projects
Retrieve all projects you own or are a member of. If you don't have any projects, one will be automatically created for you.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer token for authentication |
Response
200 - Success
[
{
"uid": "proj_abc123",
"name": "Production Environment",
"category": "business",
"supportTier": "standard",
"billingType": "hourly",
"lastUpdated": "2025-01-15T10:30:00Z",
"created": "2025-01-01T00:00:00Z"
},
{
"uid": "proj_def456",
"name": "Development Setup",
"category": "personal",
"supportTier": "basic",
"billingType": "hourly",
"lastUpdated": "2025-01-10T15:20:00Z",
"created": "2025-01-05T12:00:00Z"
}
]
Create Project
POST /projects
Create a new project to organize your cloud resources.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer token for authentication |
Request Body
| Name | Type | Description |
|---|---|---|
| name | string | Project name |
| category | string | Project category (personal, business, enterprise) |
| supportTier | string | Optional. Support level (basic, standard, premium) - defaults to "basic" |
Example Request:
{
"name": "Staging Environment",
"category": "business",
"supportTier": "standard"
}
Response
200 - Success
{
"uid": "proj_xyz789",
"name": "Staging Environment",
"category": "business",
"supportTier": "standard",
"lastUpdated": "2025-01-15T10:30:00Z",
"created": "2025-01-15T10:30:00Z"
}
Get Project
GET /projects/{project}
Retrieve detailed information about a specific project.
Path Parameters
| Name | Type | Description |
|---|---|---|
| project | string | Unique project identifier |
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer token for authentication |
Response
200 - Success
{
"uid": "proj_abc123",
"name": "Production Environment",
"category": "business",
"supportTier": "standard",
"billingType": "hourly",
"lastUpdated": "2025-01-15T10:30:00Z",
"created": "2025-01-01T00:00:00Z"
}
404 - Not Found
{
"error": "Project not found"
}
Update Project
PUT /projects/{project}
Update project settings such as name, category, or support tier.
Path Parameters
| Name | Type | Description |
|---|---|---|
| project | string | Unique project identifier |
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer token for authentication |
Request Body
| Name | Type | Description |
|---|---|---|
| name | string | Optional. Updated project name |
| category | string | Optional. Updated category (personal, business, enterprise) |
| supportTier | string | Optional. Updated support tier (basic, standard, premium) |
Example Request:
{
"name": "Production Environment v2",
"supportTier": "premium"
}
Response
200 - Success
{
"success": true
}
Related Topics
- Virtual Machines - Deploy VMs within your projects
- Billing & Profile - View billing information for your projects
- Authentication - Required for all project operations