SWIRLS_
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:

ParameterTypeRequiredDescription
namestringYes

Output:

FieldTypeDescription
idstring
namestring
createdAtunknown
orgIdstring | null
userIdstring

getProject

Get details of a specific project

GET

Usage:

const result = await swirls.client.projects.getProject({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes

getStorage

GET

Usage:

const result = await swirls.client.projects.getStorage({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes

createStorage

POST

Usage:

const result = await swirls.client.projects.createStorage({
  projectId: '...',
  region: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
namestringNo
region"americas" | "emea" | "apac"Yes

Output:

FieldTypeDescription
instanceIdstring
runIdstring
statusstring
projectRefstring

On this page