Custom recording for an entry point

Enables or disables custom recording for all live streams under the specified entry point.

After calling the Set custom recording configuration API, custom recording is automatically enabled for all live streams under the entry point.

_1

PATCH https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/custom/auto

Parameter	Type	Description
appid	String	Required. The App ID retrieved from Agora Console.
entry_point	String	Required. The entry point name.

The request body is in the JSON Object type, and contains the following fields:

Field	Type	Description
enabled	Bool	Required. Whether to enable custom recording for all live streams under the specified entry point.

If the returned HTTP status code is 200, the request is successful.

If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status codes for possible reasons.

Request line

_1

PATCH https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/record/custom/auto HTTP/1.1

Request body

_3

{

_3

"enabled": false

_3

}

Response line

_1

HTTP/1.1 200 OK

Status code	Description
200	The request succeeds.
400	The parameter is invalid, for example the appid or the entry_point is empty, or the region parameter value is invalid.
401	Unauthorized (the customer ID and the customer secret do not match).
404	The server cannot find the resource according to the request, which means the requested entry point does not exist or the requested URI path is invalid.
500	An internal error occurs in the server, so the server is not able to complete the request.
504	An internal error occurs in the server. The gateway or the proxy server did not receive a timely request from the remote server.