List Device Posture Rules

List Device Posture Rules for an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (device-posture-rules) {8}]

allOf {2}

One of

array[object (device-posture-rules) {8}]

object

description

string

device-posture-rules_components-schemas-description

optional

The description of the Device Posture Rule.

Example:

The rule for admin serial numbers

expiration

string

schemas-expiration

optional

Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.

Example:

string

device-posture-rules_components-schemas-uuid

optional

API uuid tag.

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

input

object

schemas-input

optional

The value to be checked against.

match

array[object (match_item) {1}]

schemas-match

optional

The conditions that the client must match to run the rule.

name

string

device-posture-rules_components-schemas-name

optional

The name of the Device Posture Rule.

Example:

Admin Serial Numbers

schedule

string

schedule

optional

Polling frequency for the WARP client posture check. Default: 5m (poll every five minutes). Minimum: 1m.

Example:

type

enum<string>

device-posture-rules_components-schemas-type

optional

The type of Device Posture Rule.

Allowed values:

fileapplicationserial_numbertaniumgatewaywarp

Example:

file

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "description": "The rule for admin serial numbers",
            "expiration": "1h",
            "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
            "input": {
                "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
            },
            "match": [
                {
                    "platform": "windows"
                }
            ],
            "name": "Admin Serial Numbers",
            "schedule": "1h",
            "type": "file"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Device Posture Rules

Request

Request samples

Responses