WorkspaceSettings
Workspace settings management API
| Method | Path | Description |
|---|
| GET | /api/v1/workspaces/{slug}/settings | Get workspace settings |
| PATCH | /api/v1/workspaces/{slug}/settings | Update workspace settings |
GET /api/v1/workspaces/{slug}/settings
Retrieve settings for a workspace. Requires admin permission.
| Name | Required | Description |
|---|
slug | Yes | Workspace slug |
| Status | Description |
|---|
200 | Settings retrieved successfully |
403 | Admin permission required |
404 | Workspace not found |
| Field | Type | Description |
|---|
workspaceId | string (uuid) | Workspace ID |
startupMatrix | MatrixResponse[] | Resolved matrix details for matrices to pre-assemble at runtime startup |
orphanedMatrixUris | string[] | Matrix URIs that could not be resolved (deleted matrices) |
updatedAt | string (date-time) | When the settings were last updated |
{
"success": true,
"data": {
"workspaceId": "550e8400-e29b-41d4-a716-446655440000",
"startupMatrix": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string",
"description": "string",
"repositoryUrl": "string",
"imports": [],
"importedBy": [],
"packageInfo": {
"id": null,
"name": null,
"currentVersion": null
},
"createdAt": "2025-03-28T14:22:03Z",
"updatedAt": "2025-03-28T14:22:03Z",
"prefixDeclarations": []
}
],
"orphanedMatrixUris": [
"string"
],
"updatedAt": "2025-03-28T14:22:03Z"
}
}
curl -X GET "https://poliglot.io/api/v1/workspaces/<slug>/settings" \
-H "Authorization: Bearer <your-token>"
PATCH /api/v1/workspaces/{slug}/settings
Update settings for a workspace using PATCH semantics. Only provided fields are updated. Requires admin permission.
| Name | Required | Description |
|---|
slug | Yes | Workspace slug |
Content-Type: application/json
| Field | Type | Description |
|---|
startupMatrix | string[] | List of matrix URIs to pre-assemble at runtime startup |
| Status | Description |
|---|
200 | Settings updated successfully |
400 | Invalid request |
403 | Admin permission required |
404 | Workspace not found |
| Field | Type | Description |
|---|
workspaceId | string (uuid) | Workspace ID |
startupMatrix | MatrixResponse[] | Resolved matrix details for matrices to pre-assemble at runtime startup |
orphanedMatrixUris | string[] | Matrix URIs that could not be resolved (deleted matrices) |
updatedAt | string (date-time) | When the settings were last updated |
{
"success": true,
"data": {
"workspaceId": "550e8400-e29b-41d4-a716-446655440000",
"startupMatrix": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string",
"description": "string",
"repositoryUrl": "string",
"imports": [],
"importedBy": [],
"packageInfo": {
"id": null,
"name": null,
"currentVersion": null
},
"createdAt": "2025-03-28T14:22:03Z",
"updatedAt": "2025-03-28T14:22:03Z",
"prefixDeclarations": []
}
],
"orphanedMatrixUris": [
"string"
],
"updatedAt": "2025-03-28T14:22:03Z"
}
}
curl -X PATCH "https://poliglot.io/api/v1/workspaces/<slug>/settings" \
-H "Authorization: Bearer <your-token>"
-H "Content-Type: application/json" \
-d '{}'