API Overview

The following tables list the Live APIs. Before calling a Live API, obtain a user token. The obtained token can then be used to authenticate the calling of other APIs. For details about how to call a Live API, see Example 1: Creating a Transcoding Template.

Domain Name Management APIs

**Table 1** Domain name management APIs
API	Description
POST /v1/{project_id}/domain	Creating a Domain Name
DELETE /v1/{project_id}/domain	Deleting a Domain Name
PUT /v1/{project_id}/domain	Modifying a Domain Name
GET /v1/{project_id}/domain	Querying Domain Names
PUT /v1/{project_id}/domains_mapping	Mapping Domain Names
DELETE /v1/{project_id}/domains_mapping	Deleting a Domain Name Mapping
PUT /v1/{project_id}/domain/ipv6-switch	Configuring the Domain Name IPv6 Switch
PUT /v1/{project_id}/domain/delay	Modifying the Streaming Domain Name Delay
GET /v1/{project_id}/domain/delay	Querying the Streaming Domain Name Delay
PUT /v1/{project_id}/domain/hls	Modifying the HLS Configuration of a Domain Name
GET /v1/{project_id}/domain/hls	Querying HLS Configurations of Domain Names
PUT /v1/{project_id}/domain/pull-sources	Modifying Origin Pull Settings
GET /v1/{project_id}/domain/pull-sources	Querying Origin Pull Settings

Transcoding Template Management APIs

**Table 2** Transcoding template management APIs
API	Description
POST /v1/{project_id}/template/transcodings	Creating a Transcoding Template
DELETE /v1/{project_id}/template/transcodings	Deleting a Transcoding Template
PUT /v1/{project_id}/template/transcodings	Modifying a Transcoding Template
GET /v1/{project_id}/template/transcodings	Querying Transcoding Templates

Stream Management APIs

**Table 3** Stream management APIs
API	Description
POST /v1/{project_id}/stream/blocks	Disabling a Push Stream
GET /v1/{project_id}/stream/blocks	Querying Disabled Streams
DELETE /v1/{project_id}/stream/blocks	Resuming a Push Stream
PUT /v1/{project_id}/stream/blocks	Modifying the Attribute of a Disabled Stream
POST /v1/{project_id}/stream/block-once	Pausing Stream Push

Notification Management APIs

**Table 4** Notification management APIs
API	Description
PUT /v1/{project_id}/notifications/publish	Adding and Modifying Stream Notification Configurations
GET /v1/{project_id}/notifications/publish	Querying Stream Notification Configurations
DELETE /v1/{project_id}/notifications/publish	Deleting Stream Notification Configurations

Access Control APIs

**Table 5** Access control APIs
API	Description
PUT /v1/{project_id}/guard/referer-chain	Configuring a Referer Validation ACL
DELETE /v1/{project_id}/guard/referer-chain	Deleting a Referer Validation ACL
GET /v1/{project_id}/guard/referer-chain	Querying Referer Validation ACLs
GET /v1/{project_id}/guard/ip	Querying IP Address ACLs
PUT /v1/{project_id}/guard/ip	Modifying an IP Address ACL
POST /v1/{project_id}/auth/chain	Generating a Signed URL
GET /v1/{project_id}/domain/geo-blocking	Querying Supported Areas of a Streaming Domain Name
PUT /v1/{project_id}/domain/geo-blocking	Modifying Supported Areas of a Streaming Domain Name
GET /v1/{project_id}/guard/key-chain	Querying the URL Validation Configuration of a Specified Domain Name
PUT /v1/{project_id}/guard/key-chain	Modifying the URL Validation Configuration of a Specified Domain Name
DELETE /v1/{project_id}/guard/key-chain	Deleting the URL Validation Configuration of a Specified Domain Name

HTTPS Certificate Management APIs

**Table 6** HTTPS certificate management APIs
API	Description
GET /v2/{project_id}/certificates	Querying HTTPS Certificate Information
PUT /v1/{project_id}/guard/https-cert	Modifying the HTTPS Certificate Configuration of a Specified Domain Name
GET /v1/{project_id}/guard/https-cert	Querying the HTTPS Certificate Configuration of a Specified Domain Name
DELETE /v1/{project_id}/guard/https-cert	Deleting the HTTPS Certificate Configuration of a Specified Domain Name

OBS Bucket Management APIs

**Table 7** OBS bucket management APIs
API	Description
PUT /v1/{project_id}/obs/authority	Granting or Canceling Authorization of Accessing OBS Buckets

Livestreaming Watermark Management APIs

**Table 8** Livestreaming watermark management APIs
API	Description
POST /v1/{project_id}/watermark/templates	Creating a Watermark Template
GET /v1/{project_id}/watermark/templates	Querying Watermark Templates
PUT /v1/{project_id}/watermark/templates/{id}	Modifying a Watermark Template
DELETE /v1/{project_id}/watermark/templates/{id}	Deleting a Watermark Template
GET /v1/{project_id}/watermark/templates/{id}	Querying Watermark Template Configurations
POST /v1/{project_id}/watermark/rules	Creating a Watermark Rule
GET /v1/{project_id}/watermark/rules	Querying Watermark Rules
PUT /v1/{project_id}/watermark/rules/{id}	Modifying a Watermark Rule
DELETE /v1/{project_id}/watermark/rules/{id}	Deleting a Watermark Rule
GET /v1/{project_id}/watermark/rules/{id}	Querying Watermark Rule Configurations

Statistics Analysis APIs

**Table 9** Statistics analysis APIs
API	Description
GET /v2/{project_id}/stats/bandwidth/peak	Querying Peak Bandwidth
GET /v2/{project_id}/stats/traffic/summary	Querying Total Traffic
GET /v2/{project_id}/stats/httpcodes	Querying HTTP Status Codes for Pulling Live Streams
GET /v2/{project_id}/stats/transcode	Querying the Duration of Transcoded Outputs
GET /v2/{project_id}/stats/up-bandwidth/detail	Querying Upstream Bandwidth
GET /v2/{project_id}/stats/stream-count	Querying the Number of Stream Push Channels
GET /v2/{project_id}/stats/history/streams	Querying Historical Streams
GET /v2/{project_id}/stats/stream-portraits	Querying Playback Profiles
GET /v2/{project_id}/stats/area/detail	Querying the Distribution of Livestreaming Metrics by Region

Stream Analytics APIs

**Table 10** Stream analytics APIs
API	Description
GET /v2/{project_id}/stats/stream/framerate	Querying the Stream Frame Rate
GET /v2/{project_id}/stats/stream/bitrate	Querying the Stream Bitrate
GET /v2/{project_id}/stats/stream-detail	Querying Stream Push Monitoring Data
GET /v2/{project_id}/stats/up-stream/detail	Querying CDN Upstream Streaming Quality Data
GET /v1/{project_id}/realtime/streams	Querying Ongoing Streams

Previous topic: Before You Start

Next topic: Calling APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.