Cisco Cisco ASA 5555-X Adaptive Security Appliance
About the ASA REST API v1.2.1
Resource Identity
Resource Identity
6
Primitive kinds
Some primitives like IP Address, Network, FQDN, Service Type etc could be represented using ‘kind’ as well when they
are mixed with other resource types. In those cases the ‘kind’ will be without any ‘#’ and will be specified directly. Such
resources will be very simple and besides ‘kind’ they will only contain ‘value’ attribute, which specifies the value.
Example:
{
”kind”: ”IPv4Address”
”value”: ”1.1.1.1”
}
Resource association
Other resources could be referenced from a given resource. There are two type of referencing:
1. Through inline object where the complete referring object is present in its entirety. This approach is used rarely
and supported only in certain APIs.
2. The most common way to refer to another resource is through its resource identifier, which could be objectId or
refLink.
Example:
{
”kind”: ”objectref#networkObjectGroup” ,
”refLink”: ”http://host/api/object/networkObjectGroups/548292” ,
“objectId”:548292
}
OR
{
”kind”: ”objectref#networkObjectGroup” ,
”refLink”: ”http://host/api/object/networkObjectGroup/Lab%20Printers” ,
“objectId”: “Lab Printers”
}
Object ‘rangeInfo’
Most collection resources will contain a rangeInfo object in it, which will provide details on the range of items currently
contained in the collection. The GET and Query API support pagination and will never return more than a predefined MAX
contained in the collection. The GET and Query API support pagination and will never return more than a predefined MAX
number of items. So if you have 20,000 network objects, you cannot get all of it in one single call. Also in the API request
you can specify the offset and the limit from that offset that should be returned in the result. The result will always
contain a rangeInfo specifying what was the offset and limit that are being returned and the total items.
contain a rangeInfo specifying what was the offset and limit that are being returned and the total items.