Skip to main content

Overview

The IncidentFox API provides programmatic access to:
  • Trigger investigations
  • Manage team configuration
  • Query investigation history
  • Integrate with custom workflows

Base URL

Authentication

All API endpoints require authentication via Bearer token.

Token Types

Team tokens are issued by your organization admin. Contact them if you need API access.

Response Format

All responses are JSON:

Error Responses

HTTP Status Codes

Rate Limiting

API requests are rate limited: Rate limit headers are included in responses:

API Categories

Agent API

Trigger and manage investigations

Config API

Manage team configuration

Quick Start

Trigger an Investigation

Get Team Configuration

SDKs

Official SDKs are available:
  • Python: pip install incidentfox
  • JavaScript: npm install @incidentfox/sdk

Python Example

Webhooks

Configure webhooks to receive investigation results:
Webhook payload:

Next Steps

Authentication

Detailed auth guide

Run Agent

Trigger investigations