Configure products
POST /api/v1/products/configure: request fields and declared response contract.
POST/api/v1/products/configure
| Permission | settings.manage |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| installationId | string | required | non-null | — |
| settings | object | required | non-null | — |
| expectedRevision | integer | required | non-null | — |
| changeReason | string | optional | non-null | — |
Response
201
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | unknown | required | non-null | — |
Declared failures
| PRODUCT_CONFIGURATION_FAILED | 500 — not retryable |
|---|---|
| PRODUCT_CONFIGURATION_INVALID | 400 — not retryable |
Readback
Read the result back with:
- products.inspectInstalled
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
POST /api/v1/products/configure HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"installationId": "<installationId>",
"settings": {},
"expectedRevision": 0
}