Skip to content

Change your web filter policy

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.

POST
/v1/web-filter/policy
curl --request POST \  --url https://api.xovris.ai/v1/web-filter/policy \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "problems": [ { "path": "string", "problem": "string", "send": "string" } ], "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 } }'

Send an Idempotency-Key: a repeat with the same key never acts twice and is marked Idempotent-Replayed, answering this call’s own repeat (a secret shown once is not shown again).

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
problems
Array<object>
object
path
required
string
problem
required
string
send
required
string
policy
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

{  "problems": [    {      "path": "string",      "problem": "string",      "send": "string"    }  ],  "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  }}

Done.

Media typeapplication/json
object
replayed
required
boolean

Example

{  "replayed": true}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
version
required
number
previous
required
number
decisionId
string
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
router
required
object
text
required
string
names
required
number
digest
required
string
undo
required
object
previousVersion
required
number
next
required
string

Example

{  "version": 1,  "previous": 1,  "decisionId": "string",  "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"  },  "router": {    "text": "string",    "names": 1,    "digest": "string"  },  "undo": {    "previousVersion": 1  },  "next": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.