Delete rule

This method deletes a specified banning rule.

• Method: DELETE
• Endpoint: https://api.agora.io/dev/v1/kicking-rule

Request header

The Content-Type field in all HTTP request headers is application/json. All requests and responses are in JSON format. All request URLs and request bodies are case-sensitive.

The Agora Channel Management RESTful APIs only support HTTPS. Before sending HTTP requests, you must generate a Base64-encoded credential with the Customer ID and Customer Secret provided by Agora, and pass the credential to the Authorization field in the HTTP request header. See RESTful authentication for details.

Request body

The following parameters are required in the request body:

{  "appid": "4855xxxxxxxxxxxxxxxxxxxxxxxxeae2",  "id": 1953}

Parameter	Type	Required/Optional	Description
appid	String	Required	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_key field in the response body.
id	Number	Required	The ID of the rule that you want to delete.

Test this request in Postman or use one of the following code examples:

Sample request:

Select a language:curlHTTPiewgetFetchXMLHTTPRequestjQueryAxiosNativeRequestUnirestFetchAxiosPython 3RequestsHTTPClientRestSharpAsyncHttpNetHttpOkHttpUnirestcURLGuzzleWebRequestRestMethodGoCObjective-COCamlHttp 1.1ClojureKotlinplaintextRubySwift

curl --request DELETE \
    --url http://api.sd-rtn.com/dev/v1/kicking-rule \
    --header 'Accept: application/json' \
    --header 'Authorization: '

For details about possible response status codes, see Response status codes.

If the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.

If the status code is 200, the request succeeds, and the response body includes the following parameters:

Parameter	Type	Description
status	String	The status of this request. success means the request succeeds.
id	String	The ID of the rule that you want to delete.

The following is a response example for a successful request:

{  "status": "success",  "id": 1953}