Skip to navigation
BotBye APIProtectionRate Limiters

find

View as Markdown

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:

{
  "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.

Accepted permissions Project → Project → Rate limit

Token scope Project View

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
project_idstringRequired
rate_limiter_idstringRequired

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

success
idstringformat: "uuid"
limitinteger
periodInSecinteger
namestring
actionstring
isActiveboolean
conditionstringformat: "style"