JSON
The default data format for the API is JSON.
JSON is based on key/value arrays.
Example: The system
"Your-Freedom Servers"
host is represented in JSON as follows:
{
"address": "66.90.73.46",
"comment": "Your-Freedom Servers to help blocking access from Your-Freedom clients",
"key": 86,
"link":
[
{
"href": "http://localhost:8082/7.2.1/elements/host/86",
"rel": "self",
"type": "host"
}
],
"name": "Your-Freedom Servers",
"read_only": true,
"secondary":
[
"193.164.133.72",
…
],
"system": true,
"third_party_monitoring":
{
"netflow": false,
"snmp_trap": false
}
}
The system and read-only flags are correctly set to
true
to indicate that the element in question is a system/read-only element. The name and comment attributes are correctly shown. In addition, there is more specific information — the address, the secondary address, and the
"third_party_monitoring"
status. Finally, the self verb is shown on the link row.
The primary IP address of this system host is
66.90.73.46
. The host also has several secondary IP addresses, and third-party monitoring is disabled.
For more information about the JSON format, see https://en.wikipedia.org/wiki/Json.