ReferenceSDKClient
Projects
SDK reference for projects — Manage projects, storage provisioning, and project settings.
Manage projects, storage provisioning, and project settings.
listProjects
List all projects accessible to the authenticated user
GET
Usage:
const result = await swirls.client.projects.listProjects()createProject
Create a new project
POST
Usage:
const result = await swirls.client.projects.createProject({
name: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes |
Output:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
createdAt | unknown | |
orgId | string | null | |
userId | string |
getProject
Get details of a specific project
GET
Usage:
const result = await swirls.client.projects.getProject({
projectId: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
getStorage
GET
Usage:
const result = await swirls.client.projects.getStorage({
projectId: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
createStorage
POST
Usage:
const result = await swirls.client.projects.createStorage({
projectId: '...',
region: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
name | string | No | |
region | "americas" | "emea" | "apac" | Yes |
Output:
| Field | Type | Description |
|---|---|---|
instanceId | string | |
runId | string | |
status | string | |
projectRef | string |