find | Botbye | Documentation

GET /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}

This endpoint retrieves rate limiter details for a specific project within an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.
rate_limiter_id (string): The unique identifier of the rate limiter.

Response

The response for this request is a JSON object with the following schema:

1 {
2   "id": "",
3   "limit": 0,
4   "periodInSec": 0,
5   "name": "",
6   "action": "",
7   "isActive": true,
8   "condition": ""
9 }

id (string): The unique identifier of the rate limiter.
limit (number): The limit of the rate limiter.
periodInSec (number): The period in seconds for the rate limiter.
name (string): The name of the rate limiter.
action (string): The action of the rate limiter.
isActive (boolean): Indicates whether the rate limiter is active.
condition (string): The condition of the rate limiter.

### GET /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id} This endpoint retrieves rate limiter details for a specific project within an account. #### Request No request body parameters are required for this endpoint. - `base_url` (string): The base URL of the API. - `account_id` (string): The unique identifier of the account. - `project_id` (string): The unique identifier of the project. - `rate_limiter_id` (string): The unique identifier of the rate limiter. #### Response The response for this request is a JSON object with the following schema: ``` json { "id": "", "limit": 0, "periodInSec": 0, "name": "", "action": "", "isActive": true, "condition": "" } ``` - `id` (string): The unique identifier of the rate limiter. - `limit` (number): The limit of the rate limiter. - `periodInSec` (number): The period in seconds for the rate limiter. - `name` (string): The name of the rate limiter. - `action` (string): The action of the rate limiter. - `isActive` (boolean): Indicates whether the rate limiter is active. - `condition` (string): The condition of the rate limiter.

Path parameters

account_idstringRequired

project_idstringRequired

rate_limiter_idstringRequired

Response headers

Content-Lengthinteger

Connectionstring

Response

success

idstringformat: "uuid"

limitinteger

periodInSecinteger

namestring

actionstring

isActiveboolean

conditionstringformat: "style"

GET /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}

This endpoint retrieves rate limiter details for a specific project within an account.

Request

No request body parameters are required for this endpoint.

base_url (string): The base URL of the API.
account_id (string): The unique identifier of the account.
project_id (string): The unique identifier of the project.
rate_limiter_id (string): The unique identifier of the rate limiter.

Response

The response for this request is a JSON object with the following schema:

1 {
2   "id": "",
3   "limit": 0,
4   "periodInSec": 0,
5   "name": "",
6   "action": "",
7   "isActive": true,
8   "condition": ""
9 }

id (string): The unique identifier of the rate limiter.
limit (number): The limit of the rate limiter.
periodInSec (number): The period in seconds for the rate limiter.
name (string): The name of the rate limiter.
action (string): The action of the rate limiter.
isActive (boolean): Indicates whether the rate limiter is active.
condition (string): The condition of the rate limiter.

1	{
2	"id": "01919a18-c6dc-7036-bb4e-d6d53c3587b5",
3	"limit": 888,
4	"periodInSec": 5,
5	"name": "Tasty Soft Cheese",
6	"action": "block",
7	"isActive": false,
8	"condition": "{\"fieldName\":\"remote_addr\",\"predicate\":\"EQ\",\"value\":\"232.3.158.185\",\"type\":\"criteria\"}"
9	}

1	{
2	"id": "",
3	"limit": 0,
4	"periodInSec": 0,
5	"name": "",
6	"action": "",
7	"isActive": true,
8	"condition": ""
9	}