v1

latestOpenAPI 3.0.32026-07-232011984.8 KB
policy

create policy

post/policies

Query parameters

run-tests-firstboolean

set this field to false to exclude running tests prior to saving

set this field to false to exclude running tests prior to saving

run-tests-onlyboolean

set this field to true if you want to run tests without saving

set this field to true if you want to run tests without saving

Request body

bodystring required

The python body of the policy

descriptionstring

The description of the policy

displayNamestring

The display name of the policy

enabledboolean

Determines whether or not the policy is active

idstring required

The id of the policy

managedboolean

Determines if the policy is managed by panther

outputIDsstring[]

Destination IDs that override default alert routing based on severity

referencestring

A URL or note for additional reference material

reportsobject

Reports

resourceTypesstring[]

Resource types

severity'INFO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' required
suppressionsstring[]

Resources to ignore via a pattern that matches the resource id

tagsstring[]

The tags for the policy

Response

OK response.

bodystring

The python body of the policy

createdAtstring
createdByExternalstring

The text of the user-provided CreatedBy field when uploaded via CI/CD

descriptionstring

The description of the policy

displayNamestring

The display name of the policy

enabledboolean

Determines whether or not the policy is active

idstring

The id of the policy

lastModifiedstring
managedboolean

Determines if the policy is managed by panther

outputIDsstring[]

Destination IDs that override default alert routing based on severity

referencestring

A URL or note for additional reference material

reportsobject

Reports

resourceTypesstring[]

Resource types

severity'INFO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'
suppressionsstring[]

Resources to ignore via a pattern that matches the resource id

tagsstring[]

The tags for the policy