DELETE /{o}/{p}/nukeWipe this project's data
Project-scoped self-service wipe, callable with a project API token at admin/owner. Wipes all project-scoped runtime + catalog rows while preserving the project, members, repo links, tokens, and environments. Idempotent.
Auth: Bearer token required ยท Permission:
apply:write
Path parameters
| Name | Type | Description |
|---|---|---|
o | string | |
p | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Deleted row counts by table | ProjectNukeResult |
403 | Cross-project or insufficient role | Error |
GET /orgs/{orgId}/projectsList projects in an org
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Projects | ProjectList |
401 | Unauthorized | Error |
POST /orgs/{orgId}/projectsCreate a project
Owner/admin only. Auto-creates the default environment and the caller's owner membership.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
name | string | (required) |
slug | string | (required) |
Responses
| Status | Description | Schema |
|---|---|---|
201 | Created project | Project |
401 | Unauthorized | Error |
403 | Forbidden (member role) | Error |
GET /orgs/{orgId}/projects/{projectId}Get a project
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | The project | Project |
401 | Unauthorized | Error |
404 | Project not found | Error |
PUT /orgs/{orgId}/projects/{projectId}Update a project
Owner/admin only.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
name | string | |
metadata | object |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Updated project | Project |
401 | Unauthorized | Error |
403 | Forbidden (member role) | Error |
404 | Project not found | Error |
DELETE /orgs/{orgId}/projects/{projectId}Delete a project
Owner/admin only.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Deleted project | object |
401 | Unauthorized | Error |
403 | Forbidden (member role) | Error |
404 | Project not found | Error |
GET /orgs/{orgId}/projects/{projectId}/membersList project members
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Project members | ProjectMemberList |
401 | Unauthorized | Error |
POST /orgs/{orgId}/projects/{projectId}/membersAdd a project member
Owner/admin only. Optionally scope the membership to a single environment.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
userId | string | (required) |
role | owner | admin | member | viewer | |
envName | string |
Responses
| Status | Description | Schema |
|---|---|---|
201 | Member added | object |
400 | Environment not found | Error |
401 | Unauthorized | Error |
403 | Forbidden (member role) | Error |
DELETE /orgs/{orgId}/projects/{projectId}/members/{userId}Remove a project member
Owner/admin only.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string | |
userId | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member removed | object |
401 | Unauthorized | Error |
403 | Forbidden (member role) | Error |
404 | Member not found | Error |
PUT /orgs/{orgId}/projects/{projectId}/members/{userId}/cell-scopesSet a member's cell scopes
Owner/admin only. null resets to all-cells; an array restricts the member to those cell values.
Auth: Bearer token required
Path parameters
| Name | Type | Description |
|---|---|---|
orgId | string | |
projectId | string | |
userId | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
cellScopes | string[] | null | (required) |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Updated cell scopes | object |
401 | Unauthorized | Error |
403 | Forbidden (member role) | Error |
404 | Member not found | Error |
Error| Field | Type | Description |
|---|---|---|
error | string | (required) |
code | string |
Project| Field | Type | Description |
|---|---|---|
id | string | (required) |
orgId | string | (required) |
name | string | (required) |
slug | string | (required) |
metadata | null | |
createdAt | string | string | |
updatedAt | string | string |
ProjectListType: Project[]
ProjectMemberListType: object[]
ProjectNukeResult| Field | Type | Description |
|---|---|---|
projectId | string | (required) |
rowCountsDeleted | object | (required) |