Covenant Eyes Developer Portal

View Protocols

Get the protocols that the system will block or allow for the given user.

Method

GET

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.

Call

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

Response Structure

{'result': {'meta': {'executionTime': ('Optional', '<hh:mm:ss.uuuuuu>'),
'message': ('Optional', '<Error message if any>'),
'status': '<Success|Failure> OR <a descriptive identifier of an error>'},
'records': {'FTP': '<Block|Allow>',
'IRC': '<Block|Allow>',
'NNTP': '<Block|Allow>',
'P2P': '<Block|Allow>'}}}

Autodocs

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