Skip to main content
POST
Create compliance runs

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json

At least one of templateIds, groupIds or checkIds is required

name
string
required
Required string length: 1 - 255
companyIds
string<uuid>[]
required

One run per company

Required array length: 1 - 100 elements
templateIds
string<uuid>[]

Run-template ids from the run-templates endpoint

Required array length: 1 - 100 elements
groupIds
string<uuid>[]

Compliance group ids

Required array length: 1 - 100 elements
checkIds
string<uuid>[]

Check-definition ids from the templates endpoint

Required array length: 1 - 100 elements
dueDate
string<date>

Due date for the assigned checks

notes
string
Maximum string length: 5000
hideFromCompanyUsers
boolean
idempotencyKey
string

Stable key for this request; a retry with the same key creates nothing new

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i

Response

Runs created; assignment is queued

data
object
required