Ciaren

Projects API

Projects API

Lightweight workspaces that group related datasets and flows. A Default project is created automatically; every dataset and flow belongs to one.

MethodPathDescription
GET/api/projectsList projects (with dataset/flow counts)
POST/api/projectsCreate a project
GET/api/projects/{project_id}Get one project
PUT/api/projects/{project_id}Update a project
DELETE/api/projects/{project_id}Delete a project (its items move to Default)

Deleting a project never deletes its datasets or flows — they're reassigned to the Default project. The Default project itself can't be deleted (400).

Project names must be unique (case-insensitive); creating or renaming a project to a name that's already taken returns 409.

Projects also carry a color (used for the workspace badge in the UI) and is_disabled; reads additionally include is_default to flag the built-in Default project. Toggling a project's is_disabled cascades: disabling it also disables every dataset and flow in the project, and re-enabling it re-enables them (without reviving any dataset that was separately soft-deleted).

See also