API to Get the Schema of Config
This endpoint returns a static config schema for selected type/groups of configs.
GET /openapi/v1/config_groups/schema/<type>
where <type> is the Appliance config type.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
type |
string |
Specify the config type from "VM1" "VM3" "NTP" "LOG" "LDAP" "NETFLOW" "IPFIX" "NETSCALER" "F5" "AWS" "ENDPOINT" "SLACK_NOTIFIER" "GCP_CONNECTOR" "PAGERDUTY_NOTIFIER" "SYSLOG_NOTIFIER" "KINESIS_NOTIFIER" "EMAIL_NOTIFIER" "ISE" "MERAKI" "SLACK_NOTIFIER_OVERRIDE" "PAGERDUTY_NOTIFIER_OVERRIDE" "SYSLOG_NOTIFER_OVERRIDE" "KINESIS_NOTIFER_OVERRIDE" "AZURE_CONNECTOR" "EMAIL_NOTIFIER_OVERRIDE" "SYSLOG_SEVERITY_MAPPING" "SERVICENOW" "SYNC_INTERVAL" "ALERT" "VM3_ERSPAN" "AWS_CONNECTOR" "VM0" |
Response object: Returns the config schema for selected config type.
Sample response
resp = restclient.get('/config_groups/schema/LOG')
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
{
"type": "LOG",
"name": "Log",
"mode": "TEST",
"config": {
"secured": {},
"unsecured": {
"log-level": "info",
"max-log-size": 10,
"max-log-age": 30,
"max-log-backups": 20 }
},
"fill_ins": [
{
"field": "log-level",
"label": "Logging Level",
"placeholder": "info",
"type": "user_fill_in",
"input_type": "dropdown",
"possible_values": [
"trace",
"debug",
"info",
"warn",
"error"
]
},
{
"field": "max-log-size",
"label": "Max Log File Size (in MB)",
"placeholder": 10,
"type": "user_fill_in",
"input_type": "number",
"min": 1,
"max": 10240
},
{"field": "max-log-age",
"label": "Log Rotation (in days)",
"placeholder": 30,
"type": "user_fill_in",
"input_type": "number",
"min": 1,
"max": 365
},
{
"field": "max-log-backups",
"label": "Log Rotation (in instances)",
"placeholder": 20,
"type": "user_fill_in",
"input_type": "number",
"min": 1,
"max": 100
}
]
}