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 Configure Artifactory Connection API

Use this REST API to manage the configuration of Firewall for JFrog Artifactory.

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

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

8 operations 4 paths 6 schemas 1 DELETE2 GET3 POST2 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 Configure Artifactory Connection 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 8

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

Configure Artifactory Connection 8

Use this REST API to manage the configuration of Firewall for JFrog Artifactory.

GET
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
Use this method to retrieve Artifactory connection details by specifying the owner Id. Permissions required: View IQ Elements
getOwnerArtifactoryConnection 3 params → 200
POST
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
Use this method to add a new Artifactory connection. Permissions required: Edit IQ Elements
addArtifactoryConnection 2 params body → 200
PUT
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
Use this method to enable/disable an existing Artifactory connection for the specified owner. Permissions required: Edit IQ Elements
updateOwnerArtifactoryConnectionStatus 2 params body → 204
POST
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test
Use this method to test an Artifactory connection for the specified owner. Permissons required: View IQ Elements
testArtifactoryConnection 2 params body → 204
DELETE
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
Use this method to delete an existing Artifactory connection. Permissions required: Edit IQ Elements
deleteArtifactoryConnection 3 params → 204
GET
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
Use this method to retrieve details for an Artifactory connection. Permissions required: View IQ Elements
getArtifactoryConnection 3 params → 200
PUT
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
Use this method to update an existing Artifactory connection. Permissions required: Edit IQ Elements
updateArtifactoryConnection 3 params body → 200
POST
/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test
Use this method to test an existing Artifactory connection using the connection ID.
testArtifactoryConnection_1 3 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ApiArtifactoryConnectionDTO (7 properties), ApiArtifactoryConnectionStatusResponseDTO (6 properties), ApiOwnerDTO (4 properties), ApiOwnerArtifactoryConnectionDTO (3 properties). Each schema is shown below with its type and property counts.

ApiArtifactoryConnectionStatusResponseDTO
object
6 properties
ApiOwnerArtifactoryConnectionDTO
object
3 properties
ApiArtifactoryConnectionDTO
object
7 properties
ApiStatusDTO
object
2 properties
ApiArtifactoryConnectionStatusRequestDTO
object
2 properties
ApiOwnerDTO
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-configure-artifactory-connection-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 Labels API
Sonatype Component Search API
Sonatype Components API
Where this information came from

This is an independent, third-party profile of Sonatype Configure Artifactory Connection 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.