Offboard Lock Connection

Offboards a Lock Connection, revoking all Keys, removing Locks from Access Groups, and disconnecting from the vendor system.

This is a two-step process to prevent accidental offboarding:

Step 1: Dry-run — Call this endpoint without the If-Match request header.
The response includes an impact summary (number of Locks, Keys, shared Keys, and Doorbells that will be affected) and an ETag response header.

Step 2: Confirm — Call this endpoint again with the If-Match header set to the ETag value from Step 1.
If the Lock Connection state has not changed since the dry-run, the offboarding is initiated asynchronously.
If the state has changed, the server responds with 412 Precondition Failed and a new dry-run must be performed.

Notes:

  • The Lock Connection must be in connected or error state.
  • Offboarding is asynchronous — the Lock Connection state will change to disconnected once the process completes.
  • Each dry-run returns a fresh ETag reflecting the current state.
Required Scopeproject.admin
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the Project. Must match the one in the JWT.

string
required

ID of the Lock Connection.

Headers
string

The ETag from a previous dry-run call. When provided, the offboarding is executed.
When omitted, a dry-run is performed and a new ETag is returned in the response header.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json