API Documentation

Use the Polaris API to access telemetry, device status, service lines.

Getting started

To get started, create a new access token in your account settings, then read about how to make requests for the resources you need to access using our HTTP APIs or dedicated client SDKs.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Pagination

Understand how to work with paginated responses.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Webhooks

Learn how to programmatically configure webhooks for your app.

Read more

Resources

Service Lines

Learn about the service line model and how to retrieve and list connected service lines.

Devices

Learn about the device model and how to filter device type either terminal, routers and etc.

Telemetry

Query our powerful Telemetry model where you can get information about realtime data about your devices

DownTimes

Identify common issues using Downtime model, set alerts and thresholds to get notified when something goes wrong.

Was this page helpful?