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 Component Labels API

Use this REST API to manage component labels for applications, organizations and repositories.Component Labels can be used as attributes of a component at the time of creating policies. A policy violation can be triggered based on the component label.

Sonatype Component Labels 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 Component Labels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 2 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 4 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}/.

6 operations 4 paths 4 schemas 1 DELETE3 GET1 POST1 PUT

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 Component Labels 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 6

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

Component Labels 6

Use this REST API to manage component labels for applications, organizations and repositories. Component Labels can be used as attributes of a component at the time of creating po…

GET
/api/v2/labels/{ownerType}/{ownerId}
Use this method to retrieve the details for component labels for an application, organization or a repository. Permissions required: View IQ Elements
getLabels 3 params → 200
POST
/api/v2/labels/{ownerType}/{ownerId}
Use this method to create and assign a component label to an application, organization or repository. Permissions required: Edit IQ Elements
addLabel 2 params body → 200
PUT
/api/v2/labels/{ownerType}/{ownerId}
Use this method to update an existing component label for an application, organization or repository. Permissions required: Edit IQ Elements
updateLabel 2 params body → 200
GET
/api/v2/labels/{ownerType}/{ownerId}/applicable
Use this method to retrieve all component labels that are applicable to the specified application, organization or repository. Permissions required: View IQ Elements
getApplicableLabels 2 params → 200
GET
/api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}
Use this method to retrieve the hierarchy of owners (applications, organizations, repositories) in which the label can be applied. Permissions required: Edit IQ Elements
getApplicableContexts 3 params → 200
DELETE
/api/v2/labels/{ownerType}/{ownerId}/{labelId}
Use this method to delete an existing component label. Permissions required: Edit IQ Elements
deleteLabel 3 params → 204

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ApiLabelDTO (6 properties), LabelsByOwner (4 properties), ApplicableContext (4 properties), ApplicableLabels (1 property). Each schema is shown below with its type and property counts.

ApplicableContext
object
4 properties
LabelsByOwner
object
4 properties
ApplicableLabels
object
1 property
ApiLabelDTO
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-component-labels-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 Claim Components 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 Component Labels 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.