Notes

Access

Programmatic access to the FireTail API is currently available only for Enterprise plans, and must be requested.

Client credentials and role-based scoping

Client credentials inherit the role and permissions of the user who created them:

• When client credentials are created, their scopes reflect the user’s current role (e.g., Admin).
• If the user’s role changes the associated scopes will be updated accordingly.

Keep your client credentials secure. Do not expose them in public code or repositories.

Search scope requirements

Performing a search operation requires multiple scopes:

• search:create
• {resource}:list (e.g., apis:list)

For example, to search API resources, you must include:

• search:create
• apis:list

Rate limiting

The FireTail API enforces the following rate limits per organization:

• GET / DELETE requests: up to 500 requests per second
• POST / PUT requests: up to 50 requests per second

We recommend implementing exponential backoff in the event of a 429 Too Many Requests responses.

Unsupported operations

The following operations are not currently supported through the API:

• Logging
• User management
• Callbacks
• Billing
• Organization-level operations (e.g., creating or searching organizations)