OpenAPI

Register endpoint

Users will hit this endpoint to register a new endpoint

POST/v1/register

Authorization

ApiKeyAuth

Body

application/x-www-form-urlencoded

endpoint*string

Endpoint to register

interval*enum

Interval, 1 = minute, 2 = hour, 3 = day, 4 = week, 5 = month

12345

max*integer

Max requests per interval

Response

201

Created

Body

text/plaintext/html

string

Request

JavaScriptCurlPython

const response = await fetch('/v1/register', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "endpoint": "text",
      "interval": 1
    }),
});
const data = await response.json();

Response

201

text

Update endpoint

Users will hit this endpoint to update an existing endpoint

POST/v1/update/{throttlrPath}

Authorization

ApiKeyAuth

Path parameters

throttlrPath*string

Throttlr path

Body

application/x-www-form-urlencoded

endpoint*string

Updated endpoint

interval*enum

Interval, 1 = minute, 2 = hour, 3 = day, 4 = week, 5 = month

12345

max*integer

Max requests per interval

Response

201

Created

Body

text/plaintext/html

string

Request

JavaScriptCurlPython

const response = await fetch('/v1/update/{throttlrPath}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "endpoint": "text",
      "interval": 1
    }),
});
const data = await response.json();

Response

201

text

Delete endpoint

Users will hit this endpoint to delete an existing endpoint

POST/v1/delete/{throttlrPath}

Authorization

ApiKeyAuth

Path parameters

throttlrPath*string

Throttlr path

Response

200

Deleted

Body

text/plaintext/html

string

Request

JavaScriptCurlPython

const response = await fetch('/v1/delete/{throttlrPath}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

text

Throttle endpoint

Users will hit this endpoint to access the throttled endpoint

GET/v1/endpoints/{throttlrPath}

Authorization

ApiKeyAuth

Path parameters

throttlrPath*string

Throttlr path

Response

429

Too many requests

Body

text/plainapplication/jsontext/html

string

Request

JavaScriptCurlPython

const response = await fetch('/v1/endpoints/{throttlrPath}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

429

text

Throttle endpoint

Users will hit this endpoint to access the throttled endpoint

POST/v1/endpoints/{throttlrPath}

Authorization

ApiKeyAuth

Path parameters

throttlrPath*string

Throttlr path

Response

429

Too many requests

Body

text/plainapplication/jsontext/html

string

Request

JavaScriptCurlPython

const response = await fetch('/v1/endpoints/{throttlrPath}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

429

text

Proxy endpoint

Users will hit this endpoint to access the proxied endpoint

POST/v1/proxy/{throttlrPath}

Authorization

ApiKeyAuth

Path parameters

throttlrPath*string

Throttlr path

Response

Request

JavaScriptCurlPython

const response = await fetch('/v1/proxy/{throttlrPath}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Proxy endpoint

Users will hit this endpoint to access the proxied endpoint

GET/v1/proxy/{throttlrPath}

Authorization

ApiKeyAuth

Path parameters

throttlrPath*string

Throttlr path

Response

Request

JavaScriptCurlPython

const response = await fetch('/v1/proxy/{throttlrPath}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();