Sirius Scan Logo

Documentation

REST API

The Sirius Scan REST API provides programmatic access to all scanning and vulnerability management features. Use it to integrate Sirius Scan into your security workflows and automation pipelines.

Authentication

Learn how to authenticate your API requests using API keys

API Endpoints

Browse all available REST API endpoints and their usage

Error Handling

Learn how to handle API errors and edge cases

Base URL

https://api.siriusscan.com/v1

All API endpoints are relative to this base URL. Make sure to include your API key in the Authorization header with all requests.

Request Format

The API accepts requests with the following formats:

  • Content-Type: application/json for request bodies
  • Authorization: Bearer token using your API key
  • Query Parameters: URL encoded for GET requests

Response Format

All responses are returned in JSON format and include:

  • Success Responses: Requested data in a consistent format
  • Error Responses: Error details with code and message
  • Pagination: Meta information for list endpoints

Rate Limiting

API requests are rate limited based on your subscription tier. The current limits are included in response headers:

  • X-RateLimit-Limit: Total requests allowed per hour
  • X-RateLimit-Remaining: Remaining requests for the current period
  • X-RateLimit-Reset: Time when the rate limit resets
Next
Installation