Throttlr
  • Welcome!
  • Registering Endpoints
  • Accessing Endpoints
  • OpenAPI
Powered by GitBook
On this page

Was this helpful?

OpenAPI

PreviousAccessing Endpoints

Last updated 7 months ago

Was this helpful?

Delete endpoint

post

Users will hit this endpoint to delete an existing endpoint

Authorizations
Path parameters
throttlrPathanyrequired

Throttlr path

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/delete/{throttlrPath}'
200
text/plain
text/html
text

Deleted

Throttle endpoint

get

Users will hit this endpoint to access the throttled endpoint

Authorizations
Path parameters
throttlrPathanyrequired

Throttlr path

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/endpoints/{throttlrPath}'
429
text/plain
application/json
text/html
text

Too many requests

Throttle endpoint

post

Users will hit this endpoint to access the throttled endpoint

Authorizations
Path parameters
throttlrPathanyrequired

Throttlr path

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/endpoints/{throttlrPath}'
429
text/plain
application/json
text/html
text

Too many requests

Proxy endpoint

post

Users will hit this endpoint to access the proxied endpoint

Authorizations
Path parameters
throttlrPathanyrequired

Throttlr path

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/proxy/{throttlrPath}'

Proxy endpoint

get

Users will hit this endpoint to access the proxied endpoint

Authorizations
Path parameters
throttlrPathanyrequired

Throttlr path

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/proxy/{throttlrPath}'
  • POSTRegister endpoint
  • POSTUpdate endpoint
  • POSTDelete endpoint
  • GETThrottle endpoint
  • POSTThrottle endpoint
  • POSTProxy endpoint
  • GETProxy endpoint

Register endpoint

post

Users will hit this endpoint to register a new endpoint

Authorizations
Body
endpointstringrequired

Endpoint to register

intervalintegerrequired

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

maxintegerrequired

Max requests per interval

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/register' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'endpoint=text&interval=1&max=1'
201
text/plain
text/html
text

Created

Update endpoint

post

Users will hit this endpoint to update an existing endpoint

Authorizations
Path parameters
throttlrPathanyrequired

Throttlr path

Body
endpointstringrequired

Updated endpoint

intervalintegerrequired

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

maxintegerrequired

Max requests per interval

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/update/{throttlrPath}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'endpoint=text&interval=1&max=1'
201
text/plain
text/html
text

Created