ABS provides a REST API to update global configurations related to AI engine training and
API discovery. These global configurations are part of
pingidentity/abs/mongo/abs_init.js file. The updated global
configuration values take effect immediately. Following is the list of six global
configurations that you can update using the globalconfig
API:
- attack_initial_training
- attack_update_interval
- api_discovery
- discovery_initial_period
- discovery_subpath
- discovery_update_interval
You can use the globalconfig
API with GET and PUT methods. Following is
the URL for globalconfig
API. Only the Admin user can use the PUT
method to update the values. For more information on different ABS users, see ABS users for API reports.
URL - https//<abs_host>:<abs_port>/v4/abs/globalconfig
Header | Value | |
Access Key |
x-abs-ak
|
<string> For example,
|
Secret Key |
x-abs-sk
|
<string> For example,
|
globalconfig
API with GET method, it fetches the
current value of the global
configuration.{
"company": "ping identity",
"name": "api_globalconfig",
"description": "This report contains status information of ABS global configurations",
"global_config": {
"attack_initial_training": 24,
"attack_update_interval": 24,
"api_discovery": true,
"discovery_initial_period": 1,
"discovery_subpath": 1,
"discovery_update_interval": 1
}
}
{
"api_discovery": true,
"discovery_initial_period": 1,
"discovery_subpath": 1,
"discovery_update_interval": 1
}
{
"success": "global config updated successfully"
}
You can update either one or more than one global configurations at once. Note that the values are updated only when the body of the request is well-formed.