Creates a new benchmark from provided benchmark request

post

https://{region}.api.jamfcloud.com/compliance-benchmarks/v1/benchmarks

Creates a new benchmark from provided benchmark request and deploys associated artifacts to the MDM

Required Permissions: compliance-benchmarks:create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for creating a new compliance benchmark from a source baseline

title

string

required

length between 1 and 100

A short, descriptive name for the benchmark

description

string

length ≤ 1000

A detailed description of the benchmark

sourceBaselineId

string

required

length ≥ 1

The identifier of the source baseline from which this benchmark is derived

selectedOsVersions

array of objects, unique

length between 1 and 2147483647

The selected OS versions for this benchmark, default is all available baseline OS versions

selectedOsVersions

The selected OS versions for this benchmark, default is all available baseline OS versions

osType

string

enum

required

Operating system type

Allowed:

osVersion

int32

required

Operating system version number

rules

array of objects

required

The rules that make up this benchmark

rules*

target

object

required

The target device group IDs to which a benchmark is deployed

enforcementMode

string

enum

required

The enforcement mode for this benchmark

Allowed:

Headers

X-Environment-Id

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier.

Responses

400

Invalid benchmark request

401

Unauthorized request

403

Insufficient permissions

409

Benchmark with the same title exists already or database write conflict occurred

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Successful operation result