org.limiter.find

The org.limiter.find command is used to find a rate limit and provides the details of the rate limiter.

TR50 Request

{
  "cmd": {
    "command": "org.limiter.find",
    "params": {
	"id": "5bbbab8d1c5bd72a550fc9bb"
    }
  }
}

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true,
    "params": {
     	  {
	"id": "5bbbab67fe2a13625b9f49cc",
	"key": "api_thing",
	"orgId": "594ab4fefe2a1316f2d81fb0",
	"limitDuration": "1m",
	"countLimit": 200,
	"countInterval": "1s",
	"burstLimit": 400,
	"burstNum": 5,
	"burstInterval": "1m",
	"createdBy": "sadmin@telit.com",
	"createdOn": "2018-10-08T19:09:27.364Z",
	"updatedBy": "sadmin@telit.com",
	"updatedOn": "2018-10-08T19:09:27.364Z"
	}
    }
  }
}

Response Parameters

Name	Type	Description
id	String	The unique identifier of the rate limiter.
key	String	The Key of the rate limiter
orgId	String	The organization Id
limitDuration	Float	The limit (lockout) duration is the time period the client is locked out after exceeding the Rate Limit.
countLimit	Float	It is the number of APIs allowed within the countInterval.
countInterval	Float	The countInterval divides the Rate Limit into equal intervals
burstLimit	Float	The burstLimit are the maximum spikes (number of APIs) allowed with the set Interval (burstInterval)
burstInterval	String	The burstInterval is the time period within which certain number (burstNumber) of spikes are allowed.
createdBy	String	The creator of the rate limiter
createdOn	String	The created timestamp of the rate limit
updatedBy	String	The updater of the rate limiter
updatedOn	String	The updated timestamp of the rate limit