---
title: "Sets a default desired compliance for incoming hosts from a pe server."
method: POST
path: "/v1/manage-default-desired-compliance"
tags: ["ManageDefaultDesiredCompliance"]
---

# Sets a default desired compliance for incoming hosts from a pe server.

`POST /v1/manage-default-desired-compliance`

## Request

- Base URL: `https://help.puppet.com/api/public`
- URL: `https://help.puppet.com/api/public/v1/manage-default-desired-compliance`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/puppet/apis/puppet-comply-api/docs/v1/manage-default-desired-compliance/post.ts> (a function with typed inputs; its response is checked against the schema)

To use this endpoint, you must have one of the following roles:
`comply-admin`
`comply-operator`

## Request body

- object
  - `benchmarkName` string, required: The id of the benchmark.
  - `customProfileName` string: The name of the custom profile.
  - `operatingSystemName` string, required: The name of the operating system.
  - `profileName` string: The name of the profile.
  - `updateAll` boolean: Whether to update all hosts with the given OS.

## Response `200`

ManageDefaultDesiredComplianceResponse is the response for setting a default desired compliance.

- object
  - `message` string

## Other responses

- `default`: ErrorResponse is the default error response.

---

[API](https://skmtc.dev/puppet/apis/puppet-comply-api.md) - [All operations](https://skmtc.dev/puppet/apis/puppet-comply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/puppet/apis/puppet-comply-api/revisions/0a7ac90117d7?raw)