Manage Provider Routes
/routes-manageAtomically reconciles one provider report, including routes, endpoint creation and the provider group graph. Reported state is observed state; it cannot replace customer route documents or their associations. Partial reports never prune omitted routes. IDs on reports may identify existing routes only; new resources receive server-assigned IDs. Response receipts are retained for 24 hours.
Required scope
Any authenticated access token
Header parameters
- Idempotency-Key
stringRequired Client-chosen key that makes a non-idempotent request retry-safe, following draft-ietf-httpapi-idempotency-key-header. A committed response is stored for 24 hours and replayed for the same principal, operation, key and payload. Missing key returns 400 IDEMPOTENCY_KEY_REQUIRED, a key longer than 255 characters returns 400 IDEMPOTENCY_KEY_INVALID, the same key with a different payload returns 422, and the same key while the first request is still in flight returns 409. Requests rolled back before external provider attempts do not consume the key. Group mutations retain terminal failed responses after provider attempts together with received provider truth; their operation contract defines these replayable outcomes.
minLength: 1
maxLength: 255
Request body
Fields
RoutesManageRequestReturns
200
Per-report results and errors. An error means the entire report rolled back.
Fields
RoutesManageResponseErrors
400Invalid request or missing Idempotency-Key.
Check the request fields and any validation details, then correct the payload.
409Idempotency key in flight.
Check the device’s current mode or state. Retry only after the conflict is resolved.
422Idempotency key payload conflict.
Correct the rejected value using the constraints in the error details or request schema.