Skip to navigation
BotBye APIProtectionRate Limiters

set isActive

View as Markdown

PATCH /api/v1/{account_id}/projects/{project_id}/rate_limiters/{rate_limiter_id}/active

This endpoint updates the active status of a rate limiter for a specific project within an account.

Request

  • 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.

Request Body

  • isActive: (boolean) Indicates the new active status of the rule.

Response

200 with an empty JSON object — this endpoint returns no data.

{}

Accepted permissions Project → Project → Rate limiting rules → Update

Token scope Project Action

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

Request

This endpoint expects an object.
isActivebooleanRequired

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

success

Errors

500
Internal Server Error