POST /pairing/unpair
Revokes the local member record for the given peer and returns the Engine-owned workspace convergence state. Errors flow through the shared ApiError carrier and therefore serialize to ApiErrorResponse { code, message, details? } on the wire.
Request body
Response
Changes
Changed in 4 of the 44 revisions of this API.10220
- ▲
removed the required property
data/changeCountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/confirmedMemberCountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/removalIntentCountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/waitingMemberCountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/waitingMemberDeviceIdsfrom the response with the200statusresponse-required-property-removed
- ○
added the optional property
data/pendingRemovalDecisionEventIdto the response with the200statusresponse-optional-property-added
- ○
removed the
waiting_for_offline_memberenum value from thedata/phaseresponse property for the response status200response-property-enum-value-removed
- ○
added the required property
data/divergedPeerDeviceIdsto the response with the200statusresponse-required-property-added
- ○
added the required property
data/historyEventCountto the response with the200statusresponse-required-property-added
- ○
added the required property
data/pendingRemovalDecisionDeviceIdsto the response with the200statusresponse-required-property-added
- ○
added the required property
data/upgradeRequiredPeerDeviceIdsto the response with the200statusresponse-required-property-added
- ▲
- ▲
removed the required property
data/outcomefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/pendingRecipientDeviceIdsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/pendingRecipientsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
data/removedDeviceIdsfrom the response with the200statusresponse-required-property-removed
- ●
removed the optional property
data/revocationIdfrom the response with the200statusresponse-optional-property-removed
- ○
removed the non-success response with the status
409response-non-success-status-removed
- ○
added the optional property
data/convergenceDigestto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/failureCategoryto the response with the200statusresponse-optional-property-added
- ○
added the required property
data/changeCountto the response with the200statusresponse-required-property-added
- ○
added the required property
data/confirmedMemberCountto the response with the200statusresponse-required-property-added
- ○
added the required property
data/effectiveMemberCountto the response with the200statusresponse-required-property-added
- ○
added the required property
data/phaseto the response with the200statusresponse-required-property-added
- ○
added the required property
data/removalIntentCountto the response with the200statusresponse-required-property-added
- ○
added the required property
data/removedto the response with the200statusresponse-required-property-added
- ○
added the required property
data/revisionto the response with the200statusresponse-required-property-added
- ○
added the required property
data/waitingMemberCountto the response with the200statusresponse-required-property-added
- ○
added the required property
data/waitingMemberDeviceIdsto the response with the200statusresponse-required-property-added
This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
added the new
recoveringenum value to thedata/outcomeresponse property for the response status200response-property-enum-value-added
- ●
- ▲
removed the success response with the status
204response-success-status-removed
- ○
added the non-success response with the status
409response-non-success-status-added
- ○
added the success response with the status
200response-success-status-added
- ▲