For example, GET /objects/networks/{objId} requires the ID of a specific object. Use the GET /objects/networks method to get a list of network objects, then look for the id value for the object you want to examine. Note that in this case, the information returned in the GET /object/networks call will be the same as what you see in GET /objects/network/{objId}. See Finding the Object ID (objId) and Parent ID.

• objId—The object ID is always required if it is needed in the URL. For example, 900fac69-7d19-11e7-bf7b-d9417b20e59e.

• parentId—The parent ID is equivalent to object ID, but is simply for a parent that is higher up in the hierarchy. For example, GET /policy/intrusion returns a list of intrusion policies, whereas GET /policy/intrusion/{parentId}/intrusionrules returns the rules defined within one of those policies. You would get the parent ID from GET /policy/intrusion.

• offset—For resources that support multiple objects, how far into the list to start returning objects. The default, 0, indicates the start of the list.

• limit—The maximum number of objects to return in the response. The default is 10. The maximum limit is 1000; if you enter an invalid value, it is automatically changed to 1000.

• sort—How to sort the objects returned in the response. The default sort is alphabetical by the name value. To change the sort, enter the name of the attribute within the resource to sort on. For example, you can use sort=value in network objects to sort on the value (that is, IP address) attribute. To sort in reverse order, include a minus sign, for example, sort=-name.

• filter (not available for all resources)—Return items that match the filter criteria only. The format of the filter value is {key}{operator}{value}, where the key is an attribute name and value is the string to filter on. There are no spaces between the items. The fields you can filter on are listed in the description of the filter parameter in the API Explorer; the fields differ per object. If an object supports filtering on multiple fields, you can include multiple values on the filter parameter, separated with a semi-colon (;). For example, you could filter on gid:1;sid:105 for GET /policy/intrusionpolicies/{parentId}/intrusionrules. The allowed operators are:

  • : for equal to. For example, filter=name:Canada.

  • ! for not equal to. For example, filter=name!Canada.

  • ~ for similar to. For example, filter=name~United.

• filter=fts~string (not available for all resources)—Return items that match the filter only. The fts~ option is for full-text search. All attributes in the object are searched for the string. You can include a partial string; using the asterisk * as a wildcard to match one or more characters is optional. Do not include the following characters, they are not supported as part of the search string: ?~!{}<>:%. The following characters are ignored: ;#&.

  For example, you could find all network objects that have 10. as the first octet using GET /object/networks?filter=fts~10. Note that it takes 3-5 seconds to index newly-created or updated objects, so you need to pause before immediately doing a full-text search on new or changed objects.

• filter=fetchZeroHitCount:{true | false} (available for access rules only)—If you specify includeHitCounts=true, you can use this filter option to either include (true) or exclude (false) rules that have not been hit, that is, whose hit count is zero. The default is true.

• includeHitCounts (available for access rules only)—Whether to include hit count information for the rules in the policy. Specify includeHitCounts=true to get hit counts. Specify false (the default) to exclude hit counts. The hit count information is returned in the hitCount attribute in the returned object.

• time_duration (available for trending reports only)—How many seconds into the past the report should include. For example, 1800 returns a report for the past 30 minutes.

For successful calls (return code 200), the response body includes one object or a list of objects, depending on the call you made. For information on the general structure and content of the response, see Trying a Method and Interpreting the Results.

GET requests include a paging section. If there are more objects than were returned for the call, the prev and next values indicate how to get the previous or next set of objects. The count value indicates the overall number of objects. The limit value indicates how many items are returned in the response. The offset value indicates the starting position of the returned objects, with 0 indicating the start of the list.

"paging": {
    "prev": [],
    "next": [
      "https://ftd.example.com/api/fdm/latest/object/networks?limit=10&offset=10"
    ],
    "limit": 10,
    "offset": 0,
    "count": 22,
    "pages": 0
  }

• parentId—The ID of the parent object that will contain this object. For example, when adding an SSL rule, the ID of the SSL Decryption policy.

• at—For objects that reside in a parent that organizes the objects in an ordered list, such as SSL decryption policies, the location to insert the object. Use an integer to indicate the location, with 0 being the start of the list. The default is to insert the new object at the end of the list.

Clicking in this box loads the JSON model into the Value column for the body parameter. For example, clicking the box for the POST /object/networks resource loads the following body:

{
  "name": "string",
  "description": "string",
  "subType": "HOST",
  "value": "string",
  "type": "networkobject"
}

For enum values, be certain to read the allowed values under Response Class > Model. For example, you can create a network object for a subnet (rather than a host) address by filling in the values and changing the default value for subType:

{
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.10.0/24",
  "type": "networkobject"
}

Examine the curl command used to update the system. Note the additional headers. When you create your API client, you need to also include these header fields and values. For example, the curl command to create the sample object is the following. Note the Content-Type and Accept headers.

curl -X POST --header 'Content-Type: application/json' \
   --header 'Accept: application/json' -d '{ \ 
   "name": "new_network_object", \ 
   "description": "A subnet object created using the REST API.", \ 
   "subType": "NETWORK", \ 
   "value": "10.100.10.0/24", \ 
   "type": "networkobject" \ 
 }' 'https://ftd.example.com/api/fdm/latest/object/networks'

For successful calls (return code 200), the response body includes the complete object that you created, including other system-generated values such as version and id . The version and ID values are especially important, as you need them if you subsequently use PUT to change the object. For information on the general structure and content of the response, see Trying a Method and Interpreting the Results.

The response body also includes the links/self value, which is the URL for the object you created. For example, the following is the response body for the sample object.

{
  "version": "f6d8da48-7ed5-11e7-9bfd-d96183b5f5f1",
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.10.0/24",
  "isSystemDefined": false,
  "id": "f6d8da49-7ed5-11e7-9bfd-27136f5686ad",
  "type": "networkobject",
  "links": {
    "self": "https://ftd.example.com/api/fdm/latest/object/networks/
f6d8da49-7ed5-11e7-9bfd-27136f5686ad"
  }
}

• objId—The id value for the object. For example, 900fac69-7d19-11e7-bf7b-d9417b20e59e.

• parentId—For objects that reside within another object, the ID of the parent object that will contain this object. For example, when modifying an SSL rule, the ID of the SSL Decryption policy.

• at—For objects that reside in a parent that organizes the objects in an ordered list, such as SSL decryption policies, the location to insert the object. Use an integer to indicate the location, with 0 being the start of the list. The default is to insert the object at the end of the list.

Clicking in this box loads the JSON model into the Value column for the body parameter. For example, clicking the box for the PUT /object/networks resource loads the following body. Note that this is slightly different from the POST version for the same resource: the PUT body includes the version attribute.

{
  "version": "string",
  "name": "string",
  "description": "string",
  "subType": "HOST",
  "value": "string",
  "type": "networkobject"
}

Be certain to replicate old values that you do not want to change.

For enum values, be certain to read the allowed values under Response Class > Model. Repeat the old value unless you are changing the object to a different subtype. For example, the default PUT model for a network object has HOST for subType , but if you are changing a subnet object, make sure you change subType to NETWORK.

For example, to update the subnet IP address in a network object, repeat all the old values for all attributes except value . Enter the new subnet address in value .

{
  "version": "f6d8da48-7ed5-11e7-9bfd-d96183b5f5f1",
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.11.0/24",
  "type": "networkobject",
}

Examine the curl command used to update the system. Note the additional headers. When you create your API client, you need to also include these header fields and values. For example, the curl command to update the sample object is the following. Note the Content-Type and Accept headers.

curl -X PUT --header 'Content-Type: application/json' \
--header 'Accept: application/json' -d '{ \ 
   "version": "f6d8da48-7ed5-11e7-9bfd-d96183b5f5f1", \ 
   "name": "new_network_object", \ 
   "description": "A subnet object created using the REST API.", \ 
   "subType": "NETWORK", \ 
   "value": "10.100.11.0/24", \ 
   "type": "networkobject" \ 
 }' 'https://ftd.example.com/api/fdm/latest/object/
networks/f6d8da49-7ed5-11e7-9bfd-27136f5686ad'

For successful calls (return code 200), the response body includes the complete object that you updated. Note that the version value changes, but the object ID (and thus the link/self) stays the same. The version changes every time you modify an object. For information on the general structure and content of the response, see Trying a Method and Interpreting the Results.

For example, the following is the response body for updating the sample object.

{
  "version": "96f5f3cc-7ede-11e7-9bfd-9b7d8a92863f",
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.11.0/24",
  "isSystemDefined": false,
  "id": "f6d8da49-7ed5-11e7-9bfd-27136f5686ad",
  "type": "networkobject",
  "links": {
    "self": "https://ftd.example.com/api/fdm/latest/object/networks/
f6d8da49-7ed5-11e7-9bfd-27136f5686ad"
  }
}

If the object resides within a container, you also need to enter the ID of the parent object into the parentId field.

Examine the curl command used to delete the object from the system. Note the additional headers. When you create your API client, you need to also include these header fields and values. For example, the curl command to delete the sample object is the following. Note the Accept header.

curl -X DELETE --header 'Accept: application/json' 
'https://ftd.example.com/api/fdm/latest/object/
networks/f6d8da49-7ed5-11e7-9bfd-27136f5686ad'

For successful calls (return code 204 “No Content”), you get an empty response body. This is the expected result.