API Access
Enable API access to integrate CastellanAI with your existing tools and workflows.
Overview
CastellanAI provides API access for organizations that need to integrate security data with other systems such as SIEM platforms, ticketing systems, or custom dashboards.
Most users don't need API access. The CastellanAI dashboard provides all the features you need for day-to-day security monitoring.
Who Needs API Access?
API access is typically used by:
- IT teams integrating with existing security tools
- SOC teams pulling data into centralized SIEM platforms
- Developers building custom integrations or automations
Enabling API Access
Step 1: Navigate to API Settings
- Log in to the CastellanAI Portal
- Click your profile icon in the top-right corner
- Select Settings → API Access
The API Access page displays your existing API keys with name, permissions, created date, and last used columns.
Step 2: Create an API Key
- Click + Create API Key
- Enter a descriptive name (e.g., "SIEM Integration" or "Ticketing System")
- Select the appropriate permission level:
| Permission | What It Allows |
|---|---|
| Read Only | View security events, agent status, and reports |
| Read/Write | Read access plus ability to acknowledge events |
| Admin | Full access including configuration changes |
- Click Create Key
The Create API Key dialog with name field and permission dropdown.
Step 3: Save Your Key
Your API key is shown only once. Copy it immediately and store it securely (e.g., in a password manager or secrets vault).
Your new API key is displayed with a copy button. Save it immediately—it won't be shown again.
Managing API Keys
View Active Keys
Go to Settings → API Access to see all active API keys, including:
- Key name and creation date
- Permission level
- Last used timestamp
Revoke a Key
If a key is compromised or no longer needed:
- Go to Settings → API Access
- Find the key you want to revoke
- Click the Revoke button
- Confirm the action
The key will be immediately disabled and cannot be restored.
Rate Limits
API requests are limited based on your subscription tier:
| Subscription | Requests per Minute |
|---|---|
| Small Business | 100 |
| Medium Business | 500 |
| Enterprise | 2,000 |
If you exceed your rate limit, requests will be temporarily blocked. Contact support if you need higher limits.
Getting Help
If you need assistance with API integration:
- Enterprise customers: Contact your dedicated Technical Account Manager
- All customers: Email support@castellanai.com with your integration requirements
For detailed technical API documentation, contact support to request access to the Developer Portal.