ManageDefaultDesiredCompliance

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

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

post/v1/manage-default-desired-compliance

Request

Base URL
https://help.puppet.com/api/public
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.

benchmarkNamestring required

The id of the benchmark.

customProfileNamestring

The name of the custom profile.

operatingSystemNamestring required

The name of the operating system.

profileNamestring

The name of the profile.

updateAllboolean

Whether to update all hosts with the given OS.

{
  "benchmarkName": "4.0.0 CIS Apple macOS 11.0 Big Sur",
  "operatingSystemName": "macOS 11.0",
  "profileName": "Level 1"
}

ManageDefaultDesiredComplianceResponse is the response for setting a default desired compliance.

messagestring

No recorded changes to this operation across all 1 revision of this API.