API Reference

Build on the ImaraForge platform with our RESTful API. Authenticate with Bearer tokens, manage devices, run scans, and automate your security workflows.

Authentication

All API requests require a Bearer token. Obtain one via the login endpoint or use an API key for service-to-service calls.

# Authenticate and get a Bearer token curl -X POST https://api.imaraforge.com/api/auth/login \ -H "Content-Type: application/json" \ -d '{"email": "admin@example.com", "password": "••••••••"}' # Use the token in subsequent requests curl https://api.imaraforge.com/api/devices \ -H "Authorization: Bearer <your-token>"

Core Endpoints

Devices

Register, list, and manage endpoint devices across your organization.

  • GET/api/devices
  • POST/api/devices/enroll
  • GET/api/devices/{id}
  • PUT/api/devices/{id}

Vulnerabilities

Scan results, vulnerability details, and remediation tracking.

  • GET/api/vulnerabilities
  • GET/api/vulnerabilities/{id}
  • POST/api/scans/trigger

Patches

Patch inventory, deployment scheduling, and compliance reporting.

  • GET/api/patches
  • POST/api/patches/deploy
  • GET/api/patches/compliance

Compliance

Compliance status, audit reports, and regulatory framework mappings.

  • GET/api/compliance/status
  • GET/api/compliance/report

Webhooks

Subscribe to real-time events for security alerts, scan completions, and compliance changes.

  • GET/api/webhooks
  • POST/api/webhooks
  • DEL/api/webhooks/{id}

Analytics

Dashboard metrics, trend data, and executive reporting endpoints.

  • GET/api/admin/analytics
  • GET/api/dashboard/metrics

Rate Limiting

API requests are rate-limited to ensure fair usage and platform stability.

# Rate limit headers are included in every response X-RateLimit-Limit: 200 X-RateLimit-Remaining: 187 X-RateLimit-Reset: 1709942400 # When rate limited, you'll receive a 429 response HTTP/1.1 429 Too Many Requests {"error": "Too many requests", "retry_after": 60}