API Overview
Integrate Retrace Sandbox into your security workflows
Base URL
All API requests use the following base URL:
https://retrace.cloud/api/v1Authentication
Every request must include your API key in the X-API-Key header:
X-API-Key: rtrc_live_abc123...See Authentication for how to create and manage keys.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /analyze | Submit a file for analysis |
GET | /analyze | List your analyses |
GET | /analyze/:id | Get analysis details and results |
Rate Limits
API usage is subject to monthly scan quotas based on your plan. Rate limit information is included in every response:
| Header | Description |
|---|---|
X-RateLimit-Limit | Monthly scan quota |
X-RateLimit-Remaining | Scans remaining this month |
When you exceed your quota, requests return 429 Too Many Requests.
Error Responses
All errors follow a consistent format:
{
"error": "Description of what went wrong"
}| Status | Meaning |
|---|---|
400 | Bad request — missing or invalid parameters |
401 | Unauthorized — invalid or missing API key |
403 | Forbidden — insufficient permissions (e.g., viewer role) |
404 | Not found — analysis doesn't exist or belongs to another org |
429 | Rate limited — monthly quota exceeded |
500 | Internal server error |
503 | Service unavailable — no detonation VMs available |