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

Was this helpful?

OpenAPI

PreviousAccessing Endpoints

Last updated 9 months ago

Was this helpful?

Delete endpoint

post

Users will hit this endpoint to delete an existing endpoint

Authorizations
Path parameters
throttlrPathstringRequired

Throttlr path

Responses
200
Deleted
Responsestring
post
POST /v1/delete/{throttlrPath} HTTP/1.1
Host: 
Accept: */*
200

Deleted

text

Throttle endpoint

get

Users will hit this endpoint to access the throttled endpoint

Authorizations
Path parameters
throttlrPathstringRequired

Throttlr path

Responses
429
Too many requests
Responsestring
get
GET /v1/endpoints/{throttlrPath} HTTP/1.1
Host: 
Accept: */*
429

Too many requests

text

Throttle endpoint

post

Users will hit this endpoint to access the throttled endpoint

Authorizations
Path parameters
throttlrPathstringRequired

Throttlr path

Responses
429
Too many requests
Responsestring
post
POST /v1/endpoints/{throttlrPath} HTTP/1.1
Host: 
Accept: */*
429

Too many requests

text

Proxy endpoint

post

Users will hit this endpoint to access the proxied endpoint

Authorizations
Path parameters
throttlrPathstringRequired

Throttlr path

Responses
post
POST /v1/proxy/{throttlrPath} HTTP/1.1
Host: 
Accept: */*

Proxy endpoint

get

Users will hit this endpoint to access the proxied endpoint

Authorizations
Path parameters
throttlrPathstringRequired

Throttlr path

Responses
get
GET /v1/proxy/{throttlrPath} HTTP/1.1
Host: 
Accept: */*
  • 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
201
Created
Responsestring
post
POST /v1/register HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"endpoint='text'&interval=1&max=1"
201

Created

text

Update endpoint

post

Users will hit this endpoint to update an existing endpoint

Authorizations
Path parameters
throttlrPathstringRequired

Throttlr path

Body
endpointstringRequired

Updated endpoint

intervalintegerRequired

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

maxintegerRequired

Max requests per interval

Responses
201
Created
Responsestring
post
POST /v1/update/{throttlrPath} HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"endpoint='text'&interval=1&max=1"
201

Created

text