Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Modifying Origin Pull Settings
Updated on 2026-04-22 GMT+08:00
View PDF

Modifying Origin Pull Settings

Function

This API is used to modify origin pull settings. Only RTMP and FLV domain names are supported.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/domain/pull-sources

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

play_domain

Yes

String

Definition

Streaming domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

source_type

Yes

String

Definition

Origin pull method.

Constraints

N/A

Range

  • domain: Origin pull from your origin server using its domain name. Multiple domain names can be configured. If origin pull from a domain name fails, the system will poll them in sequence until the origin pull succeeds.

  • ipaddr: Origin pull from your origin server using its IP address. Multiple IP addresses can be configured. If origin pull using an IP address fails, the system will poll them in sequence until the origin pull succeeds. In addition, you can configure a maximum of one domain name for origin pull. If specified, this domain name should be used as the Host header for HTTP-FLV and the tcUrl field for RTMP. Otherwise, the current IP address will serve as the Host header.

  • huawei: Origin pull from the Huawei origin server. This is the default setting after a domain name is created.

Default Value

huawei

sources

No

Array of strings

Definition

List of origin domain names. Array length: 0 to 10.

Constraints

  • This parameter is mandatory when the origin pull method is set to domain. If multiple domain names are configured and the origin pull from one fails, domain names are polled based on the configured sequence until the origin pull succeeds.

  • A maximum of one domain name for origin pull can be configured when the origin pull method is set to ipaddr. If specified, this domain name should be used as the Host header for HTTP-FLV and the tcUrl field for RTMP. Otherwise, the current IP address will serve as the Host header.

sources_ip

No

Array of strings

Definition

List of origin IP addresses. Array length: 0 to 10.

Constraints

  • This parameter is mandatory when the origin pull method is set to ipaddr. If multiple IP addresses are configured and the origin pull from one fails, IP addresses are polled based on the configured sequence until the origin pull succeeds.

source_port

No

Integer

Definition

Origin port.

Constraints

N/A

Default Value

N/A

Value range:

1~65535

scheme

No

String

Definition

Origin protocol.

Constraints

This parameter is mandatory when the origin pull method is not huawei.

Range

  • http

  • rtmp

Default Value

N/A

additional_args

No

Map<String,String>

Definition

Parameter included in the URL for origin pull from your origin server.

Constraints

  • A maximum of 50 key-value pairs can be included.

  • The total length of all parameter names and values cannot exceed 1,024 characters.

Response Parameters

Status code: 200

Origin pull settings modified.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Modifies origin pull settings. Only RTMP and FLV domain names are supported.

PUT https://{endpoint}/v1/{project_id}/domain/pull-sources

{
  "play_domain" : "pull.example.test.com",
  "source_type" : "domain",
  "sources" : [ "example1.test.com", "example2.test.com" ],
  "scheme" : "http",
  "additional_args" : {
    "key1" : "value1",
    "key2" : "value2"
  }
}

Example Responses

Status code: 400

Invalid parameter.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

200

Origin pull settings modified.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management