Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Configs/Configurations

Read a Specific Configuration

get/configurations/{config-name}

Path parameters

config-namestring required

Query parameters

domainstring

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

This is the domain this configuration applies to. Defaults to search for "*"

resellerstring

This is the reseller or territory this configuration applies to. Defaults to search for "*"

userstring

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

This is the user this configuration applies to. Defaults to search for "*"

core-serverstring

This is the hostname this configuration applies to. Defaults to search for "*"

user-scopestring

This is the user scope this configuration applies to. Defaults to search for "*"

admin-ui-account-typestring

This is the admin UI account this configuration applies to. Defaults to search for "*"

Response

config-namestring required

This is the name of the configuration

domainstring

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

descriptionstring

This describes the configuration

admin-ui-account-typestring
resellerstring
userstring
user-scopestring
core-serverstring

Example response

[
  {
    "domain": "example.com"
  }
]