Skip to main content

​
Welcome to the Ocean Security API

The Ocean Security API provides programmatic access to threat detection data, security metrics, and email protection insights for your organization. Prefer to work from the spec directly? Download the OpenAPI spec to generate clients, import into Postman, or explore in your tool of choice.

Threats API

Retrieve and analyze detected email threats

Metrics API

Access security analytics and ROI metrics

SONAR API

Manage phishing reports and response analytics

​
Authentication

All API endpoints require authentication using an API key passed via the X-Api-Key header. 
curl -X GET "https://api.ocean.security/api/v1/threats" \
  -H "X-Api-Key: your-api-key-here"
Keep your API key secure and never expose it in client-side code or public repositories.

​
Base URL

All API requests should be made to: 
https://api.ocean.security

​
Rate Limiting

API requests are rate limited to ensure fair usage. If you need higher limits, please contact support.

​
Response Format

All responses are returned in JSON format with a consistent structure: 
{
  "status": 200,
  "results": {
    // Response data
  }
}
For paginated endpoints, the response includes pagination information: 
{
  "status": 200,
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 150
  },
  "results": {
    "items": [...]
  }
}

​
Error Handling

When an error occurs, the API returns an appropriate HTTP status code along with an error message: 
{
  "error": "Invalid API key"
}
Status CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn’t exist
500Internal Server Error