# Custom recording configuration (/en/api-reference/api-ref/broadcast-streaming/custom-recording/configuration) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). Custom recording enables you to use third-party cloud storage services, while standard recording does not. ## Set custom recording configuration [#set-custom-recording-configuration] Sets the custom recording configuration for all live streams under the specified entry point. ### HTTP request [#http-request] ```bash PATCH https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/custom/regions/{region} ``` #### Path parameter [#path-parameter] | Parameter | Type | Description | | :------------ | :----- | :------------------------------------------------------ | | `appid` | String | Required. The App ID corresponding to the entry point. | | `entry_point` | String | Required. The entry point name. | | `region` | String | Required. The configured region when adding the domain. | #### Request body [#request-body] The request body is in the JSON Object type, and contains the following fields: | Field | Type | Description | | :-------------- | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `mp4Config` | JSON Object | Optional. For the configuration of the MP4 recording files, see [mp4Config](#mp4config). | | `hlsConfig` | JSON Object | Optional. For the configuration of the HLS recording files, see [HlsConfig](#hlsconfig). | | `storageConfig` | JSON Object | Optional (required when setting recording options for the first time). For the storage configuration of the recording files, see [StorageConfig](#storageconfig). | ### HTTP response [#http-response] 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 code](#http-code) for possible reasons. ### Example [#example] **Request line** ```bash PATCH https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/record/custom/regions/cn HTTP/1.1 ``` **Request body** ```json { "hlsConfig": { "enabled": true }, "mp4Config": { "enabled": true }, "storageConfig": { "accessKey": "{your access key}", "bucket": "{your bucket}", "region": 3, "secretKey": "{your secret key}", "vendor": 2 } } ``` **Response line** ```bash HTTP/1.1 200 OK ``` ## Get custom recording configuration [#get-custom-recording-configuration] Gets the custom recording configuration for the specified entry point. ### HTTP request [#http-request-1] ```bash GET https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/custom/regions/{region} ``` #### Path parameter [#path-parameter-1] | Parameter | Type | Description | | :------------ | :----- | :------------------------------------------------------ | | `appid` | String | Required. The App ID corresponding to the entry point. | | `entry_point` | String | Required. The entry point name. | | `region` | String | Required. The configured region when adding the domain. | ### HTTP response [#http-response-1] If the returned HTTP status code is 200, the request is successful, and the response body contains the following fields: | Field | Type | Description | | :-------------- | :---------- | :----------------------------------------------------------------------------------------- | | `mp4Config` | JSON Object | For the configuration of the MP4 recording files, see [mp4Config](#mp4config). | | `hlsConfig` | JSON Object | For the configuration of the HLS recording files, see [HlsConfig](#hlsconfig). | | `storageConfig` | JSON Object | For the storage configuration of the recording files, see [StorageConfig](#storageconfig). | If the returned HTTP status code is not 200, the request fails. You can refer to the [HTTP status code](#http-code) for possible reasons. ### Example [#example-1] **Request line** ```bash GET https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/record/custom/regions/cn HTTP/1.1 ``` **Response line** ```bash HTTP/1.1 200 OK ``` **Request body** ```json { "hlsConfig": { "enabled": true }, "mp4Config": { "enabled": true }, "storageConfig": { "accessKey": "{your accesskey}", "region": 3, "secretKey": "{your secretkey}", "vendor": 2 } } ``` ## Parameter type [#parameter-type] ### mp4Config [#mp4config] The configuration of the MP4 recording files, including the following fields: `enabled`: Bool type, optional. Whether to enable recording in the MP4 format. ### HlsConfig [#hlsconfig] The configuration of the HLS recording files, including the following fields: `enabled`: Bool type, optional. Whether to enable recording in the HLS format. ### StorageConfig [#storageconfig] The storage configuration of the recording files, including the following fields: * `vendor`: Number. The third-party cloud storage vendor. * `0`: [Qiniu Cloud](https://www.qiniu.com/en/products/kodo) * `1`: [Amazon S3](https://aws.amazon.com/s3/?nc1=h_ls) * `2`: [Alibaba Cloud](https://www.alibabacloud.com/product/oss) * `3`: [Tencent Cloud](https://intl.cloud.tencent.com/product/cos) * `4`: [Kingsoft Cloud](https://en.ksyun.com/nv/product/KS3.html) * `5`: [Microsoft Azure](https://azure.microsoft.com/en-us/services/storage/blobs/) * `6`: [Google Cloud](https://cloud.google.com/storage) * `7`: [Huawei Cloud](https://www.huaweicloud.com/intl/en-us/product/obs.html) * `8`: [Baidu AI Cloud](https://intl.cloud.baidu.com/product/bos.html) * `region`: Number. The region information specified for the third-party cloud storage. The recording service only supports regions in the following lists: In order to improve the success rate and real-time performance when uploading recording files, if you set the `region` of the cloud recording service in the `acquire` method, make sure that the region of the third-party cloud storage corresponds to the same geographical region. For example, if the region of the cloud recording service is set to `NA` (North America), the third-party cloud storage needs to be set to a location within North America. \:::
When the third-party cloud storage is Qiniu Cloud ( vendor \= 0):
When the third-party cloud storage is Amazon S3 ( vendor \= 1):
When the third-party cloud storage is Alibaba Cloud ( vendor \= 2): For details, see Alibaba Cloud Documentation.
When the third-party cloud storage is Tencent Cloud ( vendor \= 3):
When the third-party cloud storage is Kingsoft Cloud ( vendor \= 4):
When the third-party cloud storage is Microsoft Azure ( vendor \= 5): The region parameter has no effect, whether or not it is set.
When the third-party cloud storage is Google Cloud ( vendor \= 6): The region parameter has no effect, whether or not it is set.
When the third-party cloud storage is Huawei Cloud ( vendor \= 7):
When the third-party cloud storage is Baidu AI Cloud ( vendor \= 8):
* `bucket`: String. The bucket name of the third-party cloud storage. * `accessKey`: String. The access key of the third-party cloud storage. Agora suggests that you use a write-only access key. * `secretKey`: String. The secret key of the third-party cloud storage. ## HTTP status code [#http-status-code] | 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. |