Overview

The Pushly API is a JSON REST API with base path: https://api.pushly.com.

Authentication

The Pushly API uses API Tokens to allow access to the API.

A Domain API Token is available in the platform to Admin users. It can be generated by navigating to Domain Settings, page, clicking the API Tokenstab, and then clicking the Create Token button.

Additional guidance can be found in the API Access section of the platform documentation.

API Key Usage

Once you have generated your API Key it should be included in an X-API-KEY header included with each request to the API:

X-API-KEY: {key}

For example, a request using key ABCD would be constructed as:

curl --request GET \
     --url 'https://api.pushly.com/domains/1/' \
     --header 'X-API-KEY: ABCD'

API Key Expiration

API Keys have a lifetime expiration but can be revoked/regenerated via the platform organization settings page by an organization admin.