How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ocean Security Sonar API

Phishing report (SONAR) management and response analytics

Ocean Security Sonar API is one of 4 APIs that Ocean Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sonar. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ocean.security.

6 operations 6 paths 13 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.ocean.security
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ocean Security Sonar API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

Sonar 6

Phishing report (SONAR) management and response analytics

GET
/api/v1/sonar/phishing-reports/aggs/verdicts
Get aggregated total phishing reports by verdict
getAggregatedVerdicts 1 param → 200401500
GET
/api/v1/sonar/phishing-reports/aggs/mttr
Get Mean Time To Resolution for phishing reports
getPhishingReportsMttr 1 param → 200401500
GET
/api/v1/sonar/phishing-reports/{id}
Get phishing report by ID
getPhishingReportById 2 params → 200400401404500
GET
/api/v1/sonar/phishing-reports/by_original_email_internet_message_id/{internet_message_id}
Get phishing reports by original email internet message ID
getPhishingReportsByOriginalEmailInternetMessageId 2 params → 200400401404500
GET
/api/v1/sonar/phishing-reports/by_report_internet_message_id/{internet_message_id}
Get phishing reports by report internet message ID
getPhishingReportsByReportInternetMessageId 2 params → 200400401404500
GET
/api/v1/sonar/phishing-reports
List phishing reports
listPhishingReports 3 params → 200400401500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are controllers_sonar.PhishingReportDetails (12 properties), controllers_sonar.PhishingReportItem (9 properties), common.PaginationParams (3 properties), common.PaginatedResponse (3 properties). Each schema is shown below with its type and property counts.

controllers_sonar.MTTRResponse
object
1 property
controllers_sonar.PhishingReportDetails
object
12 properties
controllers_sonar.AggregatedTotalReportsResponse
object
1 property
ocean_api_common.BaseResponse-controllers_sonar_PhishingReportDetails
object
2 properties
verdict.Verdict
string
ocean_api_common.BaseResponse-controllers_sonar_AggregatedTotalReportsResponse
object
2 properties
controllers_sonar.phishingReportsResult
object
1 property
types.ErrorResponse
object
1 property
ocean_api_common.BaseResponse-array_controllers_sonar_PhishingReportItem
object
2 properties
controllers_sonar.PhishingReportItem
object
9 properties
ocean_api_common.BaseResponse-controllers_sonar_MTTRResponse
object
2 properties
common.PaginatedResponse
object
3 properties
common.PaginationParams
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocean-security-sonar-api-openapi.yml Raw ↑

Other APIs Ocean Security publishes across the network.

Ocean Security Metrics API
Ocean Security Settings API
Ocean Security Threats API
Where this information came from

This is an independent, third-party profile of Ocean Security Sonar API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.