Skip to content

Read your web filter policy and the version your devices run

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/web-filter/policy
curl --request GET \  --url https://api.xovris.ai/v1/web-filter/policy \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
device
required
object
policy
required
object
name
required
string
rules
required
Array<object>
object
id
required
string
name
required
string
action
required
string
Allowed values: warn block log allow
categories
required
Array<string>
domains
required
Array<string>
groups
required
Array<string>
people
required
Array<string>
devices
required
Array<string>
schedule
required
One of:
object
days
required
Array<number>
from
required
string
to
required
string
timeZone
required
string
enabled
required
boolean
securityDefault
required
string
Allowed values: warn block
safeSearch
required
boolean
youtube
required
string
Allowed values: moderate off strict
defaultAction
required
string
Allowed values: log allow
appeals
required
boolean
version
required
number
digest
required
string
version
required
number
policy
required
object
name
required
string
rules
required
Array<object>
object
id
required
string
name
required
string
action
required
string
Allowed values: warn block log allow
categories
required
Array<string>
domains
required
Array<string>
groups
required
Array<string>
people
required
Array<string>
devices
required
Array<string>
schedule
required
One of:
object
days
required
Array<number>
from
required
string
to
required
string
timeZone
required
string
enabled
required
boolean
securityDefault
required
string
Allowed values: warn block
safeSearch
required
boolean
youtube
required
string
Allowed values: moderate off strict
defaultAction
required
string
Allowed values: log allow
appeals
required
boolean

Example

{  "device": {    "policy": {      "name": "string",      "rules": [        {          "id": "string",          "name": "string",          "action": "warn",          "categories": [            "string"          ],          "domains": [            "string"          ],          "groups": [            "string"          ],          "people": [            "string"          ],          "devices": [            "string"          ],          "schedule": {            "days": [              1            ],            "from": "string",            "to": "string",            "timeZone": "string"          },          "enabled": true        }      ],      "securityDefault": "warn",      "safeSearch": true,      "youtube": "moderate",      "defaultAction": "log",      "appeals": true    },    "version": 1,    "digest": "string"  },  "version": 1,  "policy": {    "name": "string",    "rules": [      {        "id": "string",        "name": "string",        "action": "warn",        "categories": [          "string"        ],        "domains": [          "string"        ],        "groups": [          "string"        ],        "people": [          "string"        ],        "devices": [          "string"        ],        "schedule": {          "days": [            1          ],          "from": "string",          "to": "string",          "timeZone": "string"        },        "enabled": true      }    ],    "securityDefault": "warn",    "safeSearch": true,    "youtube": "moderate",    "defaultAction": "log",    "appeals": true  }}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.