Sign in
Bootstrap

Get application bootstrap

Retrieves the application bootstrap.

get/bootstrap

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/bootstrap
  • Auth: none required

Response

Bootstrap retrieved successfully

activeUsersLimitnumber nullable

Maximum number of active users allowed (conditionally added for admins if configured)

customerPanelUrlstring uri

URL to the customer management panel (conditionally added for admins if configured)

termsLanguagesstring[]

List of available language codes for terms localization

versionstring required

Current version of the PLANKA application

Example response

{
  "oidc": {
    "authorizationUrl": "https://oidc.example.com/auth",
    "endSessionUrl": "https://oidc.example.com/logout"
  },
  "activeUsersLimit": 100,
  "customerPanelUrl": "https://panel.example.com",
  "termsLanguages": [
    "de-DE",
    "en-US"
  ],
  "version": "2.0.0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.