Browse guides

Access Overview

The API is a RESTful interface with JSON payloads that uses standard HTTP methods and status codes. It is served from https://portal.watcheye.com.au/api/v1 and authenticated with an API key.

API keys are created and managed in the WatchEye portal at https://portal.watcheye.com.au (login required). The portal is also where you view your API usage and access logs, manage users and check your account balance.

Programmatic API Access

The API can be accessed programmatically by authenticating using an API key. You can create multiple API keys and restrict them to particular IP addresses or subnets.