Error

HTTP API schema

The one Port OS error shape, returned by every REST error response and every MCP tool error. `code` names the specific failure and `family` its broad class; both are closed enums, so clients branch on them and show `message`, which says what failed and what to do next.

Error fields

familyErrorFamilyRequired

family: Reference ErrorFamily

codeErrorCodeRequired

code: Reference ErrorCode

messagestringRequired

Plain-language description of the failure and the suggested next action.

detailsErrorDetails

details: Reference ErrorDetails

errorsarray<SynchronizationItemError>

Every rejected item when a request that is validated item by item and applied atomically fails, such as a discovery `SynchronizationRequest` whose routes, group routes or relationships are rejected. Omitted for single-item failures.

View source specification ↗