API v2

Security Parameters

headers
  • x-vsaas-api-key (string) : Watcher API Key

  • x-vsaas-session (string) : Session key, for logged in users

Collections

query
  • search (string): Substring to filter collection items (generally by name, title and comment)

  • limit (integer): Number of items returned (for collections)

  • offset (integer): Number of skipped items (for collections)

headers
  • X-Page-Limit (integer)

  • X-Page-Offset (integer)

HTTP codes

  • 200 Success

  • 400 ValidationError

  • 400 BadRequest

  • 403 Forbidden

  • 403 ApikeyExpired

  • 403 WrongApikey

  • 404 NotFound

  • 500 ApplicationError

Security Roles

  • guest

  • authenticated user

  • administrator