Skip to main content
Version: 1.28.0
Version: 3.0.0

OpenRemote Manager HTTP API

This is the documentation for the OpenRemote Manager HTTP API. The realm server variable selects the request realm. Operations that show the openid security requirement need an OAuth 2 access token; operations without that requirement support anonymous access, although the returned data can still be limited to public resources. Unless an operation documents another schema, error responses use a plain-text body. Please see the documentation for more info.

Authentication

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Token URL: /auth/realms/master/protocol/openid-connect/token

Authorization URL: /auth/realms/master/protocol/openid-connect/auth

Refresh URL: /auth/realms/master/protocol/openid-connect/token

Scopes:

  • profile: profile

OAuth Flow (clientCredentials):

Token URL: /auth/realms/master/protocol/openid-connect/token

Refresh URL: /auth/realms/master/protocol/openid-connect/token

Scopes:

  • profile: profile

License

AGPL 3.0