Getting Started
The HypeProxy.io API is organized around a REST architecture, all endpoints need to be authenticated, and keep in mind that this documentation describes only the v2 API.
Following the REST standard, you will often find a listing endpoint, an endpoint for retrieving a particular item, and sometimes a modification and/or deletion endpoint.

How to connect to the API?

We provide two base URLs, we advise you to use the first one.
curl "https://api.hypeproxy.io/v2/"
curl "https://hypeproxy-api.azurewebsites.net/v2/"

Authentication

Our API requires the use of a JWT token which can also be passed as a query string parameter.

Perform a Health Check

The API contains a health check endpoint that you can use if you have any impressions of failure.
The health check endpoint will also tell you if down bays have been detected.
curl "https://api.hypeproxy.io/health"

Status Page

We have been offering a new status page for a few months now which is accessible here.
HypeProxy.io Status Page Screenshot.
https://status.hypeproxy.io
status.hypeproxy.io

Copy link
Edit on GitHub
On this page
How to connect to the API?
Authentication
Perform a Health Check
Status Page