The APIs section of the FireTail platform provides an overview of all discovered and custom APIs. Navigate to the APIs by going to Inventory in the FireTail platform and selecting APIs . Here, you can manage and view details of the APIs you have created, as well as those that have been discovered by FireTail. The APIs are organized in a way that allows you to quickly assess their usage, risk score, associated findings, and other critical data.
In the API section, you get an overview of the:
Use the filter function to filter for specific APIs. You can select to filter by:
To create a filter:
Note on Cloud Tags
Cloud tags are key-value pairs associated with cloud resources (e.g., environment: production, region: us-east-1, etc) that are ingested from supported cloud providers. These tags can be used as filters to help identify and group APIs based on metadata defined in the cloud environment.
Click Download to download a CSV file of the API data. Learn more about how to download.
You can sort the API inventory by Risk score or Date created. Click the arrow to toggle between ascending and descending order.
In the API information you can view the associated:
FireTail's API Risk Scoring system categorizes APIs based on open findings to determine risk scores. Scores are divided into bands: critical (80-100), high (60-80), medium (40-60), and low (below 40), with higher severity findings impacting the score more significantly. The presence of critical findings results in the highest scores, followed by high, medium, and low findings. Learn more about API risk scoring.
Click the API card or title to view more information about that API.
The API dashboard provides an overview of the API:
In the Requests tab, you can view the incoming requests and their details. The requests table can be filtered by time. Select from:
Select Custom and enter a Start date and an End date to filter by a specific date and time.
The Polling Interval indicates how often the page data reloads from the API, in minutes. Select the polling interval from the dropdown.
In the Tokens tab, you can view or create tokens for that API. Learn how to Create an API token.
In the Specifications tab, you can view or create any specifications for that API. Specifications can be used to group information for an API. Creating a specification on the platform enables you to view the inventory data. Learn more about Specifications
In the Findings tab, you can view any findings for that API. Learn more about Findings.
Actions are automated tasks performed on the API, which can be triggered by events or scheduled times. Click the Actions tab to view existing Actions or create new ones. Learn more about Actions.
Linked Resources can be connected to code repositories with APIs either manually or automatically. When done automatically, the system scans the code to find and link relevant resources in the background. For manual setup, you can click Create Link and select the appropriate code repository or API. FireTail identifies the correct cloud API corresponding to the one in the code and creates a linked resource between them
In the Details tab, you can view further details about the API, including:
To modify the API, click 'Edit API'. View more information on making changes to the API.
