REST API

RESTful Application Programming Interface

Sonatype OSS Index provides a REST API which tool and application integrations can use to request component vulnerability reports.

Specification

The REST API specification is available via Swagger interface for more details.

Versioning

The URI scheme is versioned. The current version is v3.

Content-types are also versioned. Standard content-type application/json can be used and is treated as the latest version.

Authentication

To make authenticated requests use HTTP Basic authentication.

API token can be used in place of password. See user settings for the token value.

Rate Limiting

Rate limits apply to requests. If the rate is exceeded then responses will indicate 429 Too many requests status.

Authenticated requests have a higher limit. Register for an account and authenticate requests with API token to get a higher limit.