The easiest way to determine the base URL for a given
threat
defense device is to try out a GET method in the API Explorer, and
simply delete the object part of the URL from the result.
For example, you can do a GET /object/networks, and see something
similar to the following in the returned output under Request URL:
https://ftd.example.com/api/fdm/v1/object/networks
The server name part of the URL is
the hostname or IP address of the
threat
defense device, and will be different for your device in place of
“ftd.example.com.” In this example, you delete /object/networks from the path
to get the base URL:
https://ftd.example.com/api/fdm/v1/
All resource calls use this URL as the base for the request URL.
If you changed the HTTPS data port, you must include the
custom port in the URL. For example, if you changed the port to 4443:
https://ftd.example.com:4443/api/fdm/v1/
The "v" element in the URL is the API version, and this will typically change with the software version. For example, the
API version for the threat
defense version 6.3.0 is v2, so the base URL would be:
https://ftd.example.com/api/fdm/v2/
Note
|
Starting with the threat
defense 6.4, you can avoid the need to update the path in your API calls by using latest instead of the v element in the path. For example, https://ftd.example.com/api/fdm/latest/. The latest alias resolves to the most recent API version supported by the device.
|
In the API Explorer, if you scroll to the bottom of the page, you can
see information on the base URL (without the server name) and API version.