Cisco Firepower Threat Defense REST API Guide Americas Headquarters Cisco Systems, Inc
Total Page:16
File Type:pdf, Size:1020Kb
Cisco Firepower Threat Defense REST API Guide Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version. Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: https://www.cisco.com/c/en/us/about/legal/trademarks.html. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1721R) © 2017–2021 Cisco Systems, Inc. All rights reserved. CONTENTS CHAPTER 1 About the Firepower Threat Defense REST API 1 Audience for This Programming Guide 1 Supported HTTP Methods 1 The Base URL for the API 2 Securing SSL/TLS Communications for the FTD API 2 Determining the Supported API Versions 3 API Version Backward Compatibility 3 Version History for the Firepower Threat Defense REST API 4 CHAPTER 2 The API Explorer 7 Opening the API Explorer 7 Finding Your Way Around API Explorer 8 Viewing Documentation About a Resource 8 Finding the Object ID (objId) and Parent ID 10 Viewing the Error Catalog And Evaluating Error Messages 10 CHAPTER 3 General Process for Using the REST API 13 General Process for Using the REST API 13 CHAPTER 4 Authenticating Your REST API Client Using OAuth 15 Overview of the API Client Authentication Process 15 Requesting a Password-Granted Access Token 17 Requesting a Custom Access Token 19 Using an Access Token on API Calls 21 Refreshing an Access Token 21 Revoking an Access Token 23 Cisco Firepower Threat Defense REST API Guide iii Contents CHAPTER 5 Configuring External Users for the API 25 Define Authorization Rights in the RADIUS User Accounts 26 Define the RADIUS Servers 26 Create a AAA Server Group for the RADIUS Servers 28 Establish the AAA Server Group as an Authentication Source for HTTPS Access 30 Verify External User Access 33 CHAPTER 6 Using the Methods and Resources 37 Trying a Method and Interpreting the Results 37 GET: Obtaining Data from the System 39 POST: Create a New Object 41 PUT: Modify an Existing Object 43 DELETE: Remove a User-Created Object 45 CHAPTER 7 Deploying Configuration Changes 47 Deploying Configuration Changes 47 CHAPTER 8 Configuration Import/Export 49 About Configuration Import/Export 49 What is Included in the Export File 49 Comparing Import/Export and Backup/Restore 50 Strategies for Import/Export 50 Guidelines for Configuration Import/Export 51 Importing and Exporting Configurations 51 Export the Configuration 51 Check the Status of the Export Job 54 Download the Export File 54 Edit the Exported Configuration File 55 Minimum Configuration File Requirements 56 Basic Structure of Identity Wrapper Objects 56 Example: Editing a Network Object for Import Into a Different Device 57 Upload the Import File 58 Import the Configuration and Check Job Status 59 Cisco Firepower Threat Defense REST API Guide iv Contents Delete Unneeded Import/Export Files 62 CHAPTER 9 For More Information and Examples 65 For More Information and Examples 65 Cisco Firepower Threat Defense REST API Guide v Contents Cisco Firepower Threat Defense REST API Guide vi CHAPTER 1 About the Firepower Threat Defense REST API You can use the Firepower Threat Defense REpresentational State Transfer (REST) Application Programming Interface (API), over HTTPS, to interact with a FTD device through a client program. The REST API uses JavaScript Object Notation (JSON) format to represent objects. Firepower Device Manager includes an API Explorer that explains all of the resources and JSON objects available for your programmatic use. The Explorer provides detailed information about the attribute-value pairs in each object, and you can experiment with the various HTTP methods to ensure you understand the coding required to use each resource. The API Explorer also provides examples of the URLs required for each resource. You can also find reference information and examples online at https://developer.cisco.com/site/ ftd-api-reference/. The API is has its own version number. There is no guarantee that a client designed for one version of the API will work for a future version without error or without requiring changes to your program. • Audience for This Programming Guide, on page 1 • Supported HTTP Methods, on page 1 • The Base URL for the API, on page 2 • Securing SSL/TLS Communications for the FTD API, on page 2 • Determining the Supported API Versions, on page 3 • API Version Backward Compatibility, on page 3 • Version History for the Firepower Threat Defense REST API, on page 4 Audience for This Programming Guide This guide is written on the assumption that you have a general knowledge of programming and a specific understanding of REST APIs and JSON. If you are new to these technologies, please first read a general guide on REST APIs. Supported HTTP Methods You can use the following HTTP methods only. The other methods are not supported. • GET—To read data from the system. • POST—To create new objects. Cisco Firepower Threat Defense REST API Guide 1 About the Firepower Threat Defense REST API The Base URL for the API • PUT—To modify existing objects. When using PUT, you must include the entire JSON object. You cannot selectively update individual attributes within an object. • DELETE—To remove a user-defined object. The Base URL for the API The easiest way to determine the base URL for a given FTD 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 FTD 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 FTD version 6.3.0 is v2, so the base URL would be: https://ftd.example.com/api/fdm/v2/ Note Starting with FTD 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. Securing SSL/TLS Communications for the FTD API FTD devices come with a self-signed certificate so that you can initiate HTTPS communications with the device. However, because the certificate is not signed by a known Certificate Authority (CA), any SSL/TLS access attempt will consider the connection insecure.