# Sonatype Scan Health Configuration API

**Canonical:** https://apis.io/apis/sonatype/sonatype-scan-health-configuration-api/  
**Provider:** Sonatype — https://apis.io/providers/sonatype/  
**Base URL:** https://{iq-server-host}/  
**Documentation:** https://help.sonatype.com/en/iq-api-reference.html

Sonatype Scan Health Configuration API is one of 67 APIs that [Sonatype](https://apis.io/providers/sonatype/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Scan Health Configuration. The published artifact set on APIs.io includes an OpenAPI specification.

Use this REST API to manage Scan Health configuration. This includes settings for failing scans with zero components detected. Configurations can be set at organization or application level and are inherited from the organization hierarchy.

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v2/config/scanHealth/{ownerType}/{ownerId}` | Get configuration 6 |
| PUT | `/api/v2/config/scanHealth/{ownerType}/{ownerId}` | Save configuration |
| DELETE | `/api/v2/config/scanHealth/{ownerType}/{ownerId}` | Delete configuration 6 |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/openapi/sonatype-scan-health-configuration-api-openapi.yml

## Other Sonatype APIs (12)

- [Sonatype Advanced Search API](https://apis.io/apis/sonatype/sonatype-advanced-search-api/)
- [Sonatype Application Categories API](https://apis.io/apis/sonatype/sonatype-application-categories-api/)
- [Sonatype Application Report Data API](https://apis.io/apis/sonatype/sonatype-application-report-data-api/)
- [Sonatype Applications API](https://apis.io/apis/sonatype/sonatype-applications-api/)
- [Sonatype Audit Logs API](https://apis.io/apis/sonatype/sonatype-audit-logs-api/)
- [Sonatype Auto Policy Waiver Exclusions API](https://apis.io/apis/sonatype/sonatype-auto-policy-waiver-exclusions-api/)
- [Sonatype Auto Policy Waivers API](https://apis.io/apis/sonatype/sonatype-auto-policy-waivers-api/)
- [Sonatype CI Configuration API](https://apis.io/apis/sonatype/sonatype-ci-configuration-api/)
- [Sonatype Claim Components API](https://apis.io/apis/sonatype/sonatype-claim-components-api/)
- [Sonatype Component Labels API](https://apis.io/apis/sonatype/sonatype-component-labels-api/)
- [Sonatype Component Search API](https://apis.io/apis/sonatype/sonatype-component-search-api/)
- [Sonatype Components API](https://apis.io/apis/sonatype/sonatype-components-api/)

## Tags

Scan Health Configuration

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sonatype/sonatype-scan-health-configuration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sonatype/.