ExternalService

Leased external-service registration advertised through the OpenRemote Manager.

homepageUrlstringrequired

Absolute URL of the service UI or configuration page.

Possible values: >= 3 characters and <= 512 characters

Example: https://services.example.com/energy

iconstring

Material Design Icons name used by Manager UIs.

Example: puzzle

instanceIdinteger<int32>

Instance number assigned by the Manager during registration.

Example: 1

isGlobalboolean

Whether the service is visible to every realm.

labelstringrequired

Human-readable service label.

Possible values: non-empty and <= 255 characters

Example: Energy Service

realmstring

Realm that owns this registration.

Example: building

serviceIdstringrequired

Stable identifier shared by all instances of the same service.

Possible values: >= 3 characters and <= 255 characters

Example: energy-service

statusstringrequired

Current availability derived from the registration lease.

Possible values: [AVAILABLE, UNAVAILABLE]

versionstring

Service implementation version.

Possible values: >= 3 characters and <= 255 characters

Example: 1.4.0

ExternalService

{
  "homepageUrl": "https://services.example.com/energy",
  "icon": "puzzle",
  "instanceId": 1,
  "isGlobal": true,
  "label": "Energy Service",
  "realm": "building",
  "serviceId": "energy-service",
  "status": "AVAILABLE",
  "version": "1.4.0"
}