Account Policy

API version

2.0

Last Update

6/15/2015

Authentication

YES

Response Format

JSON

HTTP Method

GET

Rate limited

YES

Requests per rate limit

10/min

Use this API to retrieve default device policy

API URL

https://gears.opswat.com/o/api/v2/account/policy

Request Parameters

Key

Datatype

Parameter Type

Required

Description

Default

access_token

string

Header

Yes

access token which archived from OAuth authentication step


Response HTTP Code

See details in the Response HTTP Code section in this page

Response Parameters

Key

Datatype

Description

policy

object

Policy configuration

policy.<category>

object

detailed configuration of a category

policy.<category>.<policy>

object

detailed policy in a category

policy.<category>.<policy>.desc

string

policy description

policy.<category>.<policy>.alert

int

Indicate if this policy is considered as an issue

policy.<category>.<policy>.critical

int

Indicates if this policy is considered as a critical issue

policy.<category>.<policy>.remediation

int

Indicates if a remediation option is turned on

policy.<category>.apply_to

object

Indicates if this option is applying to any device type

policy.<category>.apply_to.laptop

int

Indicates if this option is applying to laptop devices

policy.<category>.apply_to.desktop

int

Indicates if this option is applying to desktop devices

policy.<category>.apply_to.server

int

Indicates if this option is applying to server devices

policy.<category>.apply_to.vm

int

Indicates if this option is applying to virtual machine devices

Example

Request Example

https://gears.opswat.com/o/api/v2/account/policy?access_token=TEST7P9ZMJ2LBF8AMOMJLFNPMMLO953AVQ4C9YFF52R61234

Response Example

{…