org.limiter.list

The org.limiter.list command is used to list the existing rate limits.

TR50 Request

{
  "cmd": {
    "command": "org.limiter.list"
  }
}

Request Parameters

Name Type Required Description
offset Integer The starting list offset, used for pagination, defaults to 0 if not specified.
limit Integer Limits the number of results returned. The maximum you can set is 2000. Defaults to 2000.

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": {
      "count":2,
      "result": [
	  {
		"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"
	},
	{
		"id": "5bbbab8d1c5bd72a550fc9bb",
		"key": "api_user",
		"orgId": "594ab4fefe2a1316f2d81fb0",
		"limitDuration": "1m",
		"countLimit": 250,
		"countInterval": "2s",
		"burstLimit": 340,
		"burstNum": 4,
		"burstInterval": "1m",
		"createdBy": "sadmin@telit.com",
		"createdOn": "2018-10-08T19:10:05.967Z",
		"updatedBy": "sadmin@telit.com",
		"updatedOn": "2018-10-08T19:10:05.967Z"
	}
      ]
    }
  }
}

Response Parameters

Name Type Description
result Array Array of result objects.

Result Object

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