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

Modifying a Domain Name

Function

This API is used to modify details about a streaming domain name or an ingest domain name.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/domain

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

domain

Yes

String

Definition

Domain name, which cannot be changed.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

status

No

String

Definition

Status of the domain name.

Constraints

You can modify this parameter to enable or disable a domain name. You cannot enable or disable a domain name that is being configured.

Range

  • on: enabled

  • off: disabled

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

domain

String

Definition

Domain name.

Range

Length: 1 to 255 characters

domain_type

String

Definition

Domain name type.

Range

  • pull: streaming domain name

  • push: ingest domain name

domain_cname

String

Definition

CNAME record for the domain name.

Range

N/A

region

String

Definition

Region where the Live origin server is located.

Range

N/A

status

String

Definition

Status of the domain name.

Range

  • on: enabled

  • off: disabled

  • configuring: configuring

create_time

String

Definition

Time when the domain name was created. The value is a UTC time in the format of yyyy-mm-ddThh:mm:ssZ.

Range

N/A

status_describe

String

Definition

Status description.

Range

N/A

service_area

String

Definition

Acceleration area for the domain name.

Range

  • mainland_china: Chinese mainland

  • outside_mainland_china: outside the Chinese mainland

  • global: global acceleration

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

pull_protocol

String

Definition

Stream pull protocols supported by the domain name. This parameter is valid only when domain_type is set to pull.

Range

  • flv_rtmp: FLV and RTMP

  • hls: HLS

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Changes the status of a domain name to Disabled.

PUT https://{endpoint}/v1/{project_id}/domain

{
  "domain" : "play.example.com",
  "status" : "off"
}

Example Responses

Status code: 200

Domain name modified.

{
  "domain" : "play.example.com",
  "domain_type" : "pull",
  "domain_cname" : "play.example.com.c.cdnhwc3.com",
  "region" : "region1",
  "status" : "off",
  "create_time" : "2020-01-19T02:57:00Z"
}

Status code: 400

Incorrect parameter.

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

Status Codes

Status Code

Description

200

Domain name modified.

400

Incorrect parameter.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management