Getting started on the FireTail platform

This guide will help you navigate the FireTail platform and explore its functionalities. Follow these steps in the suggested order to ensure a smooth setup process. Make sure to complete Steps 1-4 first, as they are essential for setting up the platform effectively

Set up steps

1. Set up an account
2. Create an organization
3. Create applications
4. API discovery
5. Notification integrations
6. Alerting
7. Logging integrations
8. Upload specifications

Step 1. Set up an account

To get started, you’ll need to create an account to access the FireTail platform.

1. Go to firetail.app or us.firetail.app.
2. Click Get Started.
3. Enter an email address and password or click Continue with Google to sign in with your Google account.

Follow the on-screen instructions to complete the sign-up process. To learn more, go to How do I create an account.

Step 2. Create an organization

When your account is set up, the next step is to create an organization. This allows you to Add members, set up Applications, APIs, Integrations and Alerts within that organization.

1. At first login, you will be prompted to create an organization.

• Alternatively, you can create organizations using the dropdown menu in the FireTail platform.

2. Select a subscription plan (a free 7-day trial of the business subscription is available).

Note: Each organization is separate, and nothing is shared between them. Members added to one organization do not have access to others unless added separately.

Learn more:

• Create an organization
• Manage subscriptions and billing

Step 3. Create an application

After creating your organization, it’s time to populate the platform by creating applications, which are essential for discovering and managing APIs. Applications serve as containers for your APIs, helping you organize them within the platform.

1. Navigate to the Applications section.
2. Click Create Application and enter the required details.
3. Applications are necessary for discovering and creating APIs within the platform.

Learn more about applications here.

Step 4. API discovery

Set up integrations to get full visibility of your APIs. You can integrate with various platforms such as AWS, Azure, Google Cloud, Wiz and GitHub.

1. Navigate to the Integrations section.
2. Choose the platform you want to integrate with.
3. Follow the detailed integration guides provided.

Learn more:

• AWS API Inventory Scanning
• Azure API Inventory Scanning
• Google Cloud API Inventory Scanning
• GitHub Repository Scanning (Docker)
• Wiz API Inventory Scanning
• GitHub Repo Scanning (GitHub App)
• GitLab Repo Scanning

Step 5. Create a notification integration

Set up notification integrations to receive alerts when specific conditions are triggered. It’s recommended to configure these integrations before creating alerts or incidents that you want to be notified about.

Learn more:

• Slack Webhook
• Microsoft Teams
• Lambda Function
• ‍Jira Integration
• ‍HTTP Webhook
• AWS WAFv2 IP Set‍
• ‍Splunk Integration‍
• PagerDuty Integration‍
• Email notification‍
• ‍ServiceNow Integration‍
• SMTP Email Notification

Step 6. Alerts

FireTail’s alerting system allows you to define custom conditions and thresholds for your APIs. When these are met, an alert is triggered and sent using your chosen notification method.

Learn more about Alerts.

Step 7. Logging integrations

Connect FireTail with logging services to ingest and monitor your logs. When integrated, you can view your logs in the dashboard's log table.

Learn more:

• AWS API Gateway logging with AWS Lambda
• Google Cloud API Gateway Logging‍
• AWS API Gateway Logging with Kinesis FireHose‍
• AppSync Lambda
• ‍AWS ALB Logging
• ‍Azure API Management Service Logging

Step 8. Specifications

Specifications help group API information and allow you to easily manage and view your API inventory data. You can upload a specification as a JSON or YAML file, or generate one based on historical request log information within the FireTail platform

Learn more about specifications.

By following these steps, you’ll have the FireTail platform set up and ready to manage APIs, integrations, notifications, and more. Additionally, you'll be able to view findings, set up incident policies, access reports, and configure actions for automated tasks on your APIs, among other features. For more comprehensive documentation, explore the available categories or visit specific sections linked above