Update the expiration time of a banning rule
Updated
Updates the expiration time of a specified banning rule.
https://api.agora.io/dev/v1/kicking-ruleUse this endpoint to update the expiration time of a specified banning rule.
Request
-
The request URL and request body is case-sensitive. All requests must use HTTPS.
-
Content-Type:application/json -
The request header must contain the
Authorizationfield. For details, see RESTful authentication.
Request Body
application/json
The App ID of the project. You can get it through one of the following methods:
- Copy from the Agora Console
- Call the Get all projects API, and read the value of the
vendor_keyfield in the response body.
The ID of the rule to update.
The time duration (in minutes) to ban the user. Values outside the range [1,1440] are clamped to the nearest bound. Setting this to 0 disables the rule: users are set offline but can rejoin immediately.
time_in_seconds takes effect. If neither is set, the default ban duration is 60 minutes (3600 seconds).
Note
Use either time or time_in_seconds, not both. If both are set,
[1, 1440]The time duration (in seconds) to ban the user. Values outside the range [10,86430] are clamped to the nearest bound. Setting this to 0 disables the rule: users are set offline but can rejoin immediately.
[10, 86430]Response
-
A
200status code indicates success. The response body contains the following parameters: -
If the status code is not
200, the request fails. See themessagefield in the response body for the reason for this failure. Refer to Response status codes for details.
Response Body
application/json
Response schema
200application/jsonA 200 status code indicates success. The response body contains the result of the request.
defaultapplication/jsonThe request failed. See the message field in the response body for the reason. Refer to Response status codes for details.
Request examples
curl --request PUT \ --url https://api.sd-rtn.com/dev/v1/kicking-rule \ --header 'Accept: application/json' \ --header 'Authorization: Basic <your_base64_encoded_credentials>' \ --header 'Content-Type: application/json' \ --data '{ "appid": "4855xxxxxxxxxxxxxxxxxxxxxxxxeae2", "id": 1953, "time": 60}'Response example
{ "status": "success", "result": { "id": 1953, "ts": "2026-01-09T08:45:54.545Z" }}