Organizations
| Method | Route | Required Access |
|---|---|---|
GET | /api/organizations | User authentication |
GET | /api/organizations/{id} | Organization member |
GET | /api/organizations/{id}/storage-config | Organization member |
POST | /api/organizations/{id}/storage-config | Organization member + org:settings |
GET | /api/organizations/{id}/store | Organization member or public access |
POST | /api/organizations/{id}/store | Organization member + entities:share_store + entity publisher |
DELETE | /api/organizations/{id}/store | Organization member + entities:share_store + entity publisher |
GET | /api/organizations/{id}/store/{publicationId} | Organization member or public access |
PATCH | /api/organizations/{id}/store/{publicationId} | Organization member + entities:share_store |
DELETE | /api/organizations/{id}/store/{publicationId} | Organization member + entities:share_store |
GET | /api/stores | User authentication |
Members & Roles
| Method | Route | Required Access |
|---|---|---|
POST | /api/organizations/{id}/members | Organization member + members:invite |
PUT | /api/organizations/{id}/members/{userId}/role | Organization member + members:manage_roles |
DELETE | /api/organizations/{id}/members/{userId} | Organization member + members:remove (or self) |
GET | /api/organizations/{id}/roles | Organization member |
POST | /api/organizations/{id}/roles | Organization member + members:manage_roles |
GET | /api/organizations/{id}/roles/{roleId} | Organization member + members:manage_roles |
PATCH | /api/organizations/{id}/roles/{roleId} | Organization member + members:manage_roles |
DELETE | /api/organizations/{id}/roles/{roleId} | Organization member + members:manage_roles |
GET | /api/scopes | User authentication |
GET | /api/scopes/{id} | User authentication |
POST | /api/users/invite | Organization member + members:invite |
Entities
| Method | Route | Required Access |
|---|---|---|
POST | /api/entities | User authentication + entities:publish |
GET | /api/entities/{entityId} | Entity access |
PUT | /api/entities/{entityId} | Entity access + publisher |
DELETE | /api/entities/{entityId} | Entity access + publisher |
GET | /api/entities/{entityId}/details | Entity access |
POST | /api/entities/icon-upload-url | User authentication + entities:publish |
Versions
| Method | Route | Required Access |
|---|---|---|
POST | /api/entities/{entityId}/versions/upload-url | Entity access + publisher |
POST | /api/entities/{entityId}/versions/confirm | Entity access + publisher |
GET | /api/entities/{entityId}/versions/{versionId}/download | Entity access |
GET | /api/entities/{entityId}/active-version | Entity access |
PUT | /api/entities/{entityId}/active-version | Entity access + publisher |
DELETE | /api/entities/{entityId}/versions/{versionId} | Entity access + publisher |
Sharing
| Method | Route | Required Access |
|---|---|---|
POST | /api/entities/{entityId}/shares | Entity access + entities:share (+ entities:share_external for external) |
GET | /api/entities/{entityId}/shares | Entity access |
DELETE | /api/entities/{entityId}/shares/{shareId} | Share creator |
GET | /api/entities/shared-with-me | User authentication |
GET | /api/entities/shares | User authentication |
GET | /api/entities/{entityId}/publishers | Entity access |
POST | /api/entities/{entityId}/publishers | Entity access + publisher |
GET | /api/entities/{entityId}/publishers/me | User authentication |
DELETE | /api/entities/{entityId}/publishers/{userId} | Entity access + publisher |
Production Apps
| Method | Route | Required Access |
|---|---|---|
GET | /api/production-apps | User authentication |
POST | /api/production-apps | Organization member + entities:deploy + entity publisher |
GET | /api/production-apps/{id} | User authentication |
PATCH | /api/production-apps/{id} | Organization member + entities:deploy + entity publisher |
DELETE | /api/production-apps/{id} | Organization member + entities:deploy + entity publisher |
GET | /api/subdomains/check | User authentication |
Deployments
| Method | Route | Required Access |
|---|---|---|
POST | /api/deploy | Organization member + entities:deploy + entity publisher |
GET | /api/deploys | User authentication |
GET | /api/deploys/{id} | User authentication |
POST | /api/deploys/{id}/cancel | Organization member + entities:deploy + entity publisher |