Sonatype Platform

https://help.sonatype.com/en/
Admin
This documentation provides comprehensive information and support for the Sonatype Platform,...
Tokens:1,728,277
Snippets:14,667
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example: Install from requirements.yml

Source: https://help.sonatype.com/en/ansible-cli-usage.html

Example of installing collections from a requirements file named requirements.yml.

```bash
ansible-galaxy collection install -r requirements.yml
```

--------------------------------

### Example: Install requests with uv

Source: https://help.sonatype.com/en/pypi-cli-usage.html

Example of installing the 'requests' package using uv.

```bash
uv pip install requests
```

--------------------------------

### Example: Install requests with pip

Source: https://help.sonatype.com/en/pypi-cli-usage.html

Example of installing the 'requests' package using pip.

```bash
pip install requests
```

--------------------------------

### Example: Install community.general from Nexus

Source: https://help.sonatype.com/en/ansible-cli-usage.html

Example of installing the community.general collection from a Nexus proxy repository. The API key is generated inline using base64 encoding of admin:admin123.

```bash
ansible-galaxy collection install community.general \
  --api-key="$(echo -n 'admin:admin123' | base64)" \
  --server="http://nexus-host:8081/repository/ansible-proxy/"
```

--------------------------------

### conda install example with credentials

Source: https://help.sonatype.com/en/conda-cli-usage.html

Example of installing the numpy package from a Nexus Repository Conda proxy repository using HTTPS and admin credentials.

```bash
conda install -c https://admin:admin123@nexus.example.com:8081/repository/conda-proxy numpy
```

--------------------------------

### Example Response for Get Installed License

Source: https://help.sonatype.com/en/licensing-api.html

Example JSON response returned by the Get Installed License endpoint. Shows the fields included in the license details.

```json
{
  "contactEmail": "string",
  "contactCompany": "string",
  "contactName": "string",
  "effectiveDate": "2025-03-27T16:58:45.032Z",
  "expirationDate": "2025-03-27T16:58:45.032Z",
  "licenseType": "string",
  "licensedUsers": "string",
  "fingerprint": "string",
  "features": "string",
  "maxRepoComponents": 0,
  "maxRepoRequests": 0
}
```

--------------------------------

### Example: Initialize Go project and configure Nexus

Source: https://help.sonatype.com/en/configure-go-with-nexus.html

Complete example showing module initialization, dependency tidy, environment inspection, netrc creation, permission setting, and Go environment configuration for a Nexus proxy. Includes optional GONOSUMDB for no checksum.

```bash
go mod init github.com/go-sample-project
go mod tidy
go env

nano ~/.netrc

'''
machine example.nexus.com
login admin
password admin123
'''

chmod 600 ~/.netrc        # for Linux and macOS only

go env -w GOPROXY=example.nexus.com/repository/go-proxy/
go env -w GOSUMDB='sum.golang.org example.nexus.com/repository/raw-proxy/'

# for no checksum
go env -w GONOSUMDB=*
```

--------------------------------

### GET /api/v2/githubApp/setupInstallation

Source: https://help.sonatype.com/en/iq-api-reference-338492.html

Handles GitHub App installation setup callback with OAuth + PKCE.

```APIDOC
## GET /api/v2/githubApp/setupInstallation

### Description
Handles GitHub App installation setup callback with OAuth + PKCE.

### Method
GET

### Endpoint
/api/v2/githubApp/setupInstallation
```

--------------------------------

### Example using poetry config

Source: https://help.sonatype.com/en/configure-pypi-with-nexus.html

Concrete example of adding a Nexus repository named 'nexus' with a sample URL and credentials. Replace the example credentials with your own.

```bash
poetry source add --priority=primary nexus http://example.nexus.com/repository/pypi-all/simple
poetry config http-basic.nexus admin admin123
```

--------------------------------

### curl example for GET /api/v2/securityOverrides with ownerId filter

Source: https://help.sonatype.com/en/security-vulnerability-override-api.html

Example curl command to communicate with the endpoint, filtering by ownerId. Uses admin credentials on a typical local installation.

```bash
curl -u admin:admin123 -X GET 'http://localhost:8070/api/v2/securityOverrides?ownerId=bef62081db3140b49274bb807bbbc60e'
```

--------------------------------

### Setup Sonatype CLI Action Usage Example

Source: https://help.sonatype.com/en/sonatype-github-actions.html

Example GitHub Actions workflow that uses the Sonatype CLI Setup Action (sonatype/actions/setup-iq-cli@v1) to install a specific Sonatype CLI version (1.179.0-01) on an ubuntu-latest runner. The iq-cli-version parameter accepts 'latest' or a full version like '2.1.0'.

```yaml
name: Sonatype Workflow
on: push
jobs:
  sonatype-cli:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Sonatype CLI
        uses: sonatype/actions/setup-iq-cli@v1
        with:
          iq-cli-version: 1.179.0-01
```

--------------------------------

### Example Docker and Podman commands

Source: https://help.sonatype.com/en/oci-cli-usage.html

Concrete examples of Docker and Podman commands for pulling, tagging, pushing, and multi-architectural builds using example.nexus.com URLs.

```bash
#docker pull
docker pull example.nexus.com/oci-proxy/nginx:1.27

#docker tag
docker tag nginx:1.27 example.nexus.com/oci-hosted/nginx:1.27

#docker push
docker push example.nexus.com/oci-hosted/nginx:1.27

#podman pull
podman pull example.nexus.com/oci-proxy/nginx:1.27

#podman push
podman push example.nexus.com/oci-hosted/nginx:1.27

#multi architecture images
docker buildx build \  --platform linux/amd64,linux/arm64 \  -t
repo.example.com/oci-hosted/sample-app:1.0.0 \  --push .
```

--------------------------------

### conda install numpy example

Source: https://help.sonatype.com/en/conda-cli-usage.html

Example of running conda install to download and install packages through the configured Nexus Repository.

```bash
$ conda install numpy
```

--------------------------------

### Example: Publish with uv and twine

Source: https://help.sonatype.com/en/pypi-cli-usage.html

Example of installing twine and uploading to a local Nexus hosted repository.

```bash
uv pip install twine
twine upload --repository-url http://localhost:8081/repository/pypi-hosted/ dist/*
```

--------------------------------

### Example: dart pub get and flutter pub get

Source: https://help.sonatype.com/en/pub-cli-usage.html

Example of retrieving Pub content using the dart pub get and flutter pub get commands.

```bash
dart pub get
flutter pub get
```

--------------------------------

### Example cli-params.txt

Source: https://help.sonatype.com/en/passing-cli-parameters-from-a-file.html

This example parameter file shows the format: each parameter and value on separate lines. Both short and long parameter names are supported. File paths are relative to the current process; absolute paths are supported. Include multiple paths as separate lines.

```text
-i 
Test123 
-a 
username:password 
-s
http://localhost:8070 
-t 
build 
./sample-application.zip
```

--------------------------------

### Example: Build Collection and Output Archive

Source: https://help.sonatype.com/en/ansible-cli-usage.html

Example of initializing, navigating to, and building a collection named myorg.mycollection. The output shows the created archive file myorg-mycollection-1.0.0.tar.gz.

```bash
ansible-galaxy collection init myorg.mycollection
cd myorg/mycollection
ansible-galaxy collection build
```

```text
#Output:
    myorg-mycollection-1.0.0.tar.gz
```

--------------------------------

### Example APT Snapshot Filter

Source: https://help.sonatype.com/en/apt-repositories.html

Example filter file that selects the i386 architecture and the restricted and universe components.

```text
Architectures: i386
Components: restricted universe 
```

--------------------------------

### Download a Module Example

Source: https://help.sonatype.com/en/go-cli-usage.html

Example of downloading a specific module version using go get.

```bash
go get github.com/user_account/module@v1.0.0
```

--------------------------------

### Get Transitive Violations by Stage ID - cURL Example

Source: https://help.sonatype.com/en/transitive-waivers-rest-api.html

Example cURL command to find transitive policy violations for a component using its packageUrl. Assumes a local installation of IQ Server with default configuration (admin:admin123) and uses the build stage for the npm application.

```bash
curl -u admin:admin123 --request GET 'http://localhost:8070/api/v2/policyViolations/transitive/application/npm/stages/build?packageUrl=pkg:npm/%40iarna/cli@1.2.0'
```

--------------------------------

### Example: Build and publish with Poetry

Source: https://help.sonatype.com/en/pypi-cli-usage.html

Example of building and publishing to the 'nexus-hosted' repository.

```bash
poetry build
poetry publish -r nexus-hosted
```

--------------------------------

### GET Copyrights Example

Source: https://help.sonatype.com/en/copyrights-rest-api.html

Example curl command to retrieve copyrights for a component using the GET endpoint.

```bash
curl -u username:password 'http://localhost:8070/api/experimental/licenseLegalMetadata/application/client-frameworks/component/copyright?componentIdentifier=%7B%22format%22%3A%22pypi%22%2C%22coordinates%22%3A%7B%22extension%22%3A%22whl%22%2C%22name%22%3A%22anyio%22%2C%22qualifier%22%3A%22py3-none-any%22%2C%22version%22%3A%223.6.1%22%7D%7D' -H 'Accept: application/json, text/plain, */*' 
```

--------------------------------

### Get Capabilities - example response

Source: https://help.sonatype.com/en/capabilities-api.html

Example response for the Get Capabilities endpoint, showing a firewall.audit capability.

```json
[
  {
    "id": "018b####-49##-30##-1e##-09347#######",
    "type": "firewall.audit",
    "notes": "",
    "enabled": false,
    "properties": {
      "quarantine": "true",
      "repository": "npm-proxy"
    }
  }
]
```

--------------------------------

### Example using Interactive Method

Source: https://help.sonatype.com/en/configure-pub-with-nexus.html

Complete example for the interactive method: sets PUB_HOSTED_URL, adds the token interactively, and includes a comment to enter your token.

```bash
export PUB_HOSTED_URL=https://example.nexus.com/repository/pub-hosted

dart pub token add https://example.nexus.com/repository/pub-hosted/

# Enter your token
```

--------------------------------

### Get Container Waivers example request

Source: https://help.sonatype.com/en/container-waivers-api.html

Example curl request to get container waivers with page and pageSize parameters.

```bash
curl -X GET 'https://iq-server.example/platform/api/v2/firewall/container-image/policyWaiver?page=1&pageSize=100'
```

--------------------------------

### Example: Sync dependencies with uv

Source: https://help.sonatype.com/en/pypi-cli-usage.html

Example of syncing dependencies using a local Nexus instance and the 'pypi-all' repository.

```bash
uv sync --index-url http://localhost:8081/repository/pypi-all/simple
```

--------------------------------

### Get Quarantined Containers example request

Source: https://help.sonatype.com/en/container-waivers-api.html

Example curl request to get quarantined containers with page and pageSize parameters.

```bash
curl -X GET 'https://iq-server.example/platform/api/v2/firewall/container-image/policyViolations/quarantined?page=1&pageSize=100'
```

--------------------------------

### Configure APT client with repository line

Source: https://help.sonatype.com/en/apt-repositories.html

Adds an APT repository to the client's sources.list file. Replace <repository URL> and <distribution> with the appropriate values for your repository.

```text
deb <repository URL> <distribution> main
```

--------------------------------

### GET list response JSON example

Source: https://help.sonatype.com/en/vulnerability-group-rest-api.html

Example JSON response for a GET list request, showing an array of vulnerability groups.

```json
[
  {
    "vulnerabilityGroupId": "19b5794c82a148a9a89b8b31306f7875",
    "groupName": "Group 1",
    "vulnerabilityIds": [
      "CVE-2021-21350",
      "CVE-2021-21342"
    ],
    "ownerId": "ROOT_ORGANIZATION_ID"
  },
  {
    "vulnerabilityGroupId": "bd40c64b493042f9944d73ac3241fab7",
    "groupName": "Group CVE fix",
    "vulnerabilityIds": [
      "CVE-2021-21350",
      "CVE-2021-21342"
    ],
    "ownerId": "ROOT_ORGANIZATION_ID"
  }
]
```
Tokens:
Raw