v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Configs/Configuration Definitions

Read a Specific Configuration Definition

get/config-definitions/{config-name}

Path parameters

config-namestring required

To read definitions for all configurations, use "*"

Query parameters

tagsstring

An optional comma seperated list of tags the definition to search has. To search all configs with the tags, set config-name to "*"

startnumber

This is the start value when using pagination. 0 is the default and the minimum value. For example the default of 0 paired with the default limit of 100 would return the first 100 objects in the data request. A start of 100 and a default limit of 100 would give you the second 100 results in the response.

limitnumber

This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.

Default to 100

sortstring

Defaults to "code_version desc,config_name asc"

Response

config-namestring required
descriptionstring required
defaultstring required
code-versionstring required
config-def-allow-hostnamestring required
config-def-allow-reseller-accessstring required
config-def-default-basic-userstring required
config-def-default-call-center-supervisorstring required
config-def-default-office-managerstring required
config-def-default-resellerstring required
config-def-default-super-userstring required
data-typestring required
tagsstring required