Retrieve the manager configuration JSON

GET 
https://demo.openremote.io/api/master/configuration/manager

Retrieve the manager configuration JSON

Responses

default

default response

application/json

Schema

Schema

loadLocalesboolean
languages object
property name*string
realms object
property name* ManagerAppRealmConfig
appTitlestring
stylesstring
logostring
logoMobilestring
faviconstring
languagestring
headersstring[]
notifications object
languagesstring[]
defaultLanguagestring
pages object
property name*object
manager object
managerUrlstring
keycloakUrlstring
appVersionstring
realmstring
clientIdstring
autoLoginboolean
consoleAutoEnableboolean
loadIconsboolean
pollingIntervalMillisint32
loadTranslationsstring[]
loadDescriptorsboolean
translationsLoadPathstring
skipFallbackToBasicAuthboolean
applyConfigToAdminboolean
authstring
Possible values: [KEYCLOAK, BASIC, NONE]
credentials object
usernamestring
passwordstring
eventProviderTypestring
Possible values: [WEBSOCKET, POLLING]
mapTypestring
Possible values: [VECTOR, RASTER]
configureTranslationsOptionsobject
basicLoginProviderobject
defaultLanguagestring

Example (auto)

{
  "loadLocales": true,
  "languages": {},
  "realms": {},
  "pages": {},
  "manager": {
    "managerUrl": "string",
    "keycloakUrl": "string",
    "appVersion": "string",
    "realm": "string",
    "clientId": "string",
    "autoLogin": true,
    "consoleAutoEnable": true,
    "loadIcons": true,
    "pollingIntervalMillis": 0,
    "loadTranslations": [
      "string"
    ],
    "loadDescriptors": true,
    "translationsLoadPath": "string",
    "skipFallbackToBasicAuth": true,
    "applyConfigToAdmin": true,
    "auth": "KEYCLOAK",
    "credentials": {
      "username": "string",
      "password": "string"
    },
    "eventProviderType": "WEBSOCKET",
    "mapType": "VECTOR",
    "configureTranslationsOptions": {},
    "basicLoginProvider": {},
    "defaultLanguage": "string"
  }
}

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L 'https://demo.openremote.io/api/master/configuration/manager' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!