Admin REST API
Admin application programming interface (API) is used to fetch the list of nodes in the API Behavioral Security (ABS) cluster, Mongo DB Nodes, the status of each node (CPU, memory, file System etc) and logs processed that are sent by all API Security Enforcer nodes.
URL: /v5/abs/admin
Method: GET
| Header | Value | |
|---|---|---|
Access Key |
|
<string> |
Secret Key |
|
<string> |
Sample curl command:
curl --location --request GET 'https://<IP Address>:8080/v5/abs/admin' \
--header 'x-abs-ak: abs_ak' \
--header 'x-abs-sk: abs_sk'Sample Response:
{
"company": "ping identity",
"name": "api_admin",
"description": "This report contains status information on all APIs, ABS clusters, and ASE logs",
"license_info": {
"tier": "Subscription",
"expiry": "Mon Jan 01 00:00:00 UTC 2024",
"max_transactions_per_month": 1000000000,
"current_month_transactions": 0,
"max_transactions_exceeded": false,
"expired": false
},
"across_api_prediction_mode": false,
"poc": true,
"api_discovery": {
"status": false
},
"apis": [
{
"api_name": "rest_api_decoy_outcontext",
"host_name": "",
"url": "/decoy",
"api_type": "decoy-outcontext",
"creation_date": "Mon May 31 03:41:10 UTC 2021",
"servers": 0,
"protocol": "http",
"cookie": "",
"token": false,
"training_started_at": "n/a",
"training_duration": "n/a",
"prediction_mode": false,
"apikey_header": "",
"apikey_qs": "",
"jwt": {
"location": "",
"username": "",
"clientid": ""
},
"username_header": ""
},
{
"api_name": "rest_api",
"host_name": "",
"url": "/rest",
"api_type": "regular",
"creation_date": "Mon May 31 03:41:10 UTC 2021",
"servers": 2,
"protocol": "http",
"cookie": "",
"token": false,
"training_started_at": "Mon May 31 03:42:46 UTC 2021",
"training_duration": "20 hours",
"prediction_mode": false,
"apikey_header": "",
"apikey_qs": "",
"jwt": {
"location": "",
"username": "",
"clientid": ""
},
"username_header": ""
},
{
"api_name": "rest_api_decoy_incontext",
"host_name": "",
"url": "/restdecoy",
"api_type": "decoy-incontext",
"creation_date": "Mon May 31 03:41:10 UTC 2021",
"servers": 2,
"protocol": "http",
"cookie": "",
"token": false,
"training_started_at": "Mon May 31 03:42:46 UTC 2021",
"training_duration": "20 hours",
"prediction_mode": false,
"apikey_header": "",
"apikey_qs": "",
"jwt": {
"location": "",
"username": "",
"clientid": ""
},
"username_header": ""
},
{
"api_name": "root_api",
"host_name": "",
"url": "/",
"api_type": "regular",
"creation_date": "Mon May 31 03:41:10 UTC 2021",
"servers": 1,
"protocol": "http",
"cookie": "JSESSIONID",
"token": false,
"training_started_at": "n/a",
"training_duration": "n/a",
"prediction_mode": false,
"apikey_header": "X-API-KEY",
"apikey_qs": "",
"jwt": {
"location": "h:authorization:bearer",
"username": "username",
"clientid": "client_id"
},
"username_header": ""
}
],
"abs_cluster": {
"abs_nodes": [
{
"node_id": "937e8553-ccc6-419b-b24d-c4f9a5d46632",
"os": "Red Hat Enterprise Linux Server - ",
"cpu": "8",
"memory": "15G",
"filesystem": "6%",
"timezone": "UTC",
"bootup_date": "Fri May 21 04:57:08:502 UTC 2021"
},
{
"node_id": "d224a4f9-3a17-423a-a7b3-571c8143cfff",
"os": "Red Hat Enterprise Linux Server - VMware, Inc.",
"cpu": "16",
"memory": "62G",
"filesystem": "2%",
"timezone": "UTC",
"bootup_date": "Mon May 31 03:39:14:818 UTC 2021"
}
],
"mongodb_nodes": [
{
"node_ip": "172.16.40.165:27017",
"status": "primary"
}
]
},
"ase_logs": [
{
"ase_node": "53de980b-df8e-467a-9328-04e33497d2cd",
"last_connected": "Mon May 31 03:41:15 UTC 2021",
"logs": {
"start_time": "Mon May 31 03:41:15 UTC 2021",
"end_time": "Mon May 31 03:41:15 UTC 2021",
"gzip_size": "13.96MB"
}
}
],
"percentage_diskusage_limit": "80%",
"scale_config": {
"scale_up": {
"cpu_threshold": "70%",
"cpu_monitor_interval": "30 minutes",
"memory_threshold": "70%",
"memory_monitor_interval": "30 minutes",
"disk_threshold": "70%",
"disk_monitor_interval": "30 minutes"
},
"scale_down": {
"cpu_threshold": "10%",
"cpu_monitor_interval": "30 minutes",
"memory_threshold": "10%",
"memory_monitor_interval": "30 minutes",
"disk_threshold": "10%",
"disk_monitor_interval": "30 minutes"
}
},
"attack_ttl": {
"ids": [
{
"id": "ip",
"ttl": 0
},
{
"id": "cookie",
"ttl": 0
},
{
"id": "access_token",
"ttl": 0
},
{
"id": "api_key",
"ttl": 0
},
{
"id": "username",
"ttl": 0
}
]
}
}