For the complete documentation index, see llms.txt. This page is also available as Markdown.

Project

List projects

get

Lists the projects accessible by the user.

Authorizations
api-tokenstringRequired
Responses
200

Projects listed successfully

application/json
objectOptional
get/projects

Create project

post

Creates a new project. Requires a compatible plan.

Authorizations
api-tokenstringRequired
Body
namestringRequired

Project name (max. 50 characters)

descriptionstringOptional
iconstringOptional
teamIDstringOptional

Team to link (optional)

fromAppIDsstring[]Optional
Responses
201

Project created successfully

application/json
objectOptional
post/projects

Project details

get

Returns the details of a project, including team and apps.

Authorizations
api-tokenstringRequired
Path parameters
projectIDstringRequired

Project ID

Responses
200

Project loaded successfully

application/json
objectOptional
get/projects/{projectID}

Update project

patch

Updates the name, description and/or icon of a project.

Authorizations
api-tokenstringRequired
Path parameters
projectIDstringRequired

Project ID

Body
namestringOptional
descriptionstringOptional
iconstringOptional
Responses
200

Project updated successfully

application/json
objectOptional
patch/projects/{projectID}

Link/unlink team

patch

Links a team to the project (teamID) or unlinks it (teamID null). Owner only.

Authorizations
api-tokenstringRequired
Path parameters
projectIDstringRequired

Project ID

Body
teamIDstring · nullableOptional

Team ID to link, or null to unlink

Responses
200

Team linked or unlinked successfully

application/json
objectOptional
patch/projects/{projectID}/team

List available apps

get

Lists the apps that can be added to the project.

Authorizations
api-tokenstringRequired
Path parameters
projectIDstringRequired

Project ID

Responses
200

Available apps listed successfully

application/json
objectOptional
get/projects/{projectID}/apps

Add/move app to project

put

Adds an app to the project. If the cluster differs, use migrate=true to migrate (202 response, asynchronous migration).

Authorizations
api-tokenstringRequired
Path parameters
projectIDstringRequired

Project ID

appIDstringRequired

Application ID

Body
migratebooleanOptional

If true, migrates the app to the project's cluster

Responses
200

App added to the project successfully

application/json
objectOptional
put/projects/{projectID}/apps/{appID}

Remove app from project

delete

Removes the app from the project (sets projectID null). The app is not deleted.

Authorizations
api-tokenstringRequired
Path parameters
projectIDstringRequired

Project ID

appIDstringRequired

Application ID

Responses
200

App removed from the project successfully

application/json
objectOptional
delete/projects/{projectID}/apps/{appID}

Last updated