Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

admin-controller

Get the Administration Settings object using key (getAdminSettings)

Get the Administration Settings object using specified string key. Referencing non-existing key will cause an error.

Available for users with 'SYS_ADMIN' authority.

get/api/admin/settings/{key}

Path parameters

keystring required

A string value of the key (e.g. 'general' or 'mail').

Response

OK

createdTimeinteger

Timestamp of the settings creation, in milliseconds

keystring

The Administration Settings key, (e.g. 'general' or 'mail')

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "ADMIN_SETTINGS"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "key": "mail",
  "jsonValue": {}
}