Projects
create_project, list_projects, get_project, rename_project and delete_project — the container everything else lives in.
A project groups services and apps under your customer. Every app belongs to exactly one, so creating a project is the first call in almost any session.
create_project
Create a project to group services under your customer. A URL-safe slug is derived from the name and made unique within the customer.
| Parameter | Type | Description |
|---|---|---|
name | string, required | Human-readable project name. |
list_projects
List all projects belonging to your customer. Takes no parameters.
get_project
Fetch a single project by id.
| Parameter | Type | Description |
|---|---|---|
project_id | uuid, required | Project id. |
rename_project
Change a project's display name. The slug is not regenerated, so existing URLs keep working.
| Parameter | Type | Description |
|---|---|---|
project_id | uuid, required | Project id. |
name | string, required | New project name. |
delete_project
Delete a project and all of its services.
| Parameter | Type | Description |
|---|---|---|
project_id | uuid, required | Project id. |
This cannot be undone
Deleting a project takes every service and app inside it with it. Check with
list_services or list_apps first if you are not
certain what a project contains.