Services

Register, discover, renew, and deregister leased external-service instances

📄️List registered external services for a realm

Returns all active realm-scoped service registrations for an active realm accessible to the caller.

📄️Register an external service with the OpenRemote Manager

Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.

📄️List globally available external services

Returns active registrations marked as globally available across realms.

📄️Register a global external service with the OpenRemote Manager

Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.

📄️Deregister an external service

Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.

📄️Retrieve an external service instance

Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.

📄️Renew an external service registration lease

Extends the lease of one service instance. The caller must be the service account that registered it; global-service heartbeats additionally require a super user.