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

Sonatype Claim Components API

Use this REST API to manage components that are developed in-house and are not open-source.Claiming the component stores the identity information for the component hash and avoids triggering the Component-Unknown policy.Components will have a match state as `Exact` and Identification Source as `Manual`,for subsequent scans or evaluations.

Sonatype Claim Components API is one of 58 APIs that Sonatype publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Claim Components. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 2 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.201.0-02.

Requests are made against the base URL https://{iq-server-host}/.

4 operations 2 paths 3 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.201.0-02
Base URL
https://{iq-server-host}/
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Sonatype Claim Components API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Claim Components 4

Use this REST API to manage components that are developed in-house and are not open-source. Claiming the component stores the identity information for the component hash and avoid…

GET
/api/v2/claim/components
Use this method to retrieve details of all claimed components. Permissions required: Claim components
getAll → 200
POST
/api/v2/claim/components
Use this method to claim a component, or update the component details for a previously claimed component. Permissions required: Claim components
set body → 200
DELETE
/api/v2/claim/components/{hash}
Use this method to delete a claim on a previously claimed component by providing its hash. Permissions required: Claim components
delete 1 param → 204404
GET
/api/v2/claim/components/{hash}
Use this method to retrieve details of a claimed component by specifying its hash. Permissions required: Claim components
get 1 param → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ApiHashComponentIdentifierDTO (7 properties), ApiComponentIdentifierDTOV2 (2 properties), ApiHashComponentIdentifiersDTO (1 property). Each schema is shown below with its type and property counts.

ApiHashComponentIdentifierDTO
object
7 properties
ApiHashComponentIdentifiersDTO
object
1 property
ApiComponentIdentifierDTOV2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-claim-components-api-openapi.yml Raw ↑

Other APIs Sonatype publishes across the network.

Sonatype Advanced Search API
Sonatype Application Categories API
Sonatype Application Report Data API
Sonatype Applications API
Sonatype Audit Logs API
Sonatype Auto Policy Waiver Exclusions API
Sonatype Auto Policy Waivers API
Sonatype CI Configuration API
Sonatype Component Labels API
Sonatype Component Search API
Sonatype Components API
Sonatype Composite Source Control API
Where this information came from

This is an independent, third-party profile of Sonatype Claim Components 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.