Get Decisions

Returns a paginated list of policy decisions. If a dryRunId is provided, the return value has a field indicating whether the dry run is complete.

Request

URI

GET

https://{api_host}/policy/api/policyDecisions

COPY

Query Parameters

integer

page

Optional

Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer

size

Optional

Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array

sort

Optional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string

dryRunId

Optional

dryRunId

string

projectId

Optional

Matches will only include decisions with this project ID

string

policyTypeId

Optional

Matches will only include policies of this type

string

Optional

Matches will start with this string in their policy name or target name or have this string somewhere in their description.

integer

$top

Optional

Number of records you want

$top example

integer

$skip

Optional

Number of records you want to skip

$skip example

string

$orderby

Optional

Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Operation doesn't return any data structure

401

Unauthorized

Returns PagePolicyDecisionObjectNode of type(s) application/json

"PagePolicyDecisionObjectNode Object"

array of object

content

Optional

A decision made to enforce policies.

boolean

empty

Optional

empty

boolean

first

Optional

first

boolean

last

Optional

last

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

object

pageable

Optional

pageable

integer As int32 As int32

size

Optional

size

array of object

sort

Optional

sort

integer As int64 As int64

totalElements

Optional

totalElements

integer As int32 As int32

totalPages

Optional

totalPages

403

Forbidden

Returns PagePolicyDecisionObjectNode of type(s) application/json

"PagePolicyDecisionObjectNode Object"

array of object

content

Optional

A decision made to enforce policies.

boolean

empty

Optional

empty

boolean

first

Optional

first

boolean

last

Optional

last

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

object

pageable

Optional

pageable

integer As int32 As int32

size

Optional

size

array of object

sort

Optional

sort

integer As int64 As int64

totalElements

Optional

totalElements

integer As int32 As int32

totalPages

Optional

totalPages

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/policy/api/policyDecisions

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Policy Decisions Operations