Covenant Eyes Developer Portal

Add A URL

Add a URL to a Filter user’s Block or Allow Lists. Protocols are required for entry of a url.

Method

POST

Authorizations

One of the following must be true:

  • The logged in user must be the Filter Guardian of the given username.
  • The given username must belong to the logged in user.

Additionally:

  • The given user may not add urls to their own allow list unless they have override permissions enabled or are also the Filter Guardian.

Call

POST /v2/user/(?P[^/]+)/filter/settings/url.(?Pxml|json)

Allowed Actions

  • Allow: Add to Allow List
  • Block: Add to Block List

Note: A url cannot exist simultaneously on both the Allow and Block list of a user.

Payload Structure

{'action': ('Required', '<Allow|Block>'),
'url': ('Required', '<protocol://server/path?vars>')}

Sample JSON

{"url": "http://www.hulu.com", "action": "Allow"}

Autodocs

https://api.cvnt.net/v2/user/s/filter/settings/url.doc