Query streaming key

This method queries a streaming key information, such as the associated UID, channel name, validity period, and so on.

• Method: GET
• Endpoint: https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys/:streamkey

Authentication

• HTTP Basic Authentication

  Every time you send an HTTP request, you must pass in a credential in the Authorization field in the HTTP request header. See RESTful Authentication on how to generate it.

  Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.

  Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

• HTTP HMAC Authentication

  Every time you send an HTTP request, you must pass in an API key in the Authorization field in the HTTP request header. See RESTful Authentication on how to generate it.

  Example: Authorization: 123

Path parameters

Parameter	Data type	Required/Optional	Description
appId	String	Required	The app ID provided by Agora to each developer. After creating a project in Agora Console, you can get an app ID. The app ID is a unique identifier for a project.
region	String	Required	Create an area for pushing the streaming key. Agora supports creation of stream keys by region. Currently, the following regions are supported: na: North America eu: Europe ap: Asia, except mainland China cn: Mainland China Important Make sure that: The region value is the same as for the input source stream. The domain names for setting the region parameter and streaming are the same. The region value is in the lowercase.
streamkey	String	Required	The streaming key for which you need information.

Headers

Header	Data type	Description
X-Request-ID	String	The UUID (Universally Unique Identifier) of the request. After passing in this field, the Agora server will return this field in the response header. It is recommended to assign X-Request-ID a value. If no value is assigned, the Agora server will automatically generate a UUID and pass it in.

_2

curl --location 'https://api.agora.io/ap/v1/projects/9d2498880e934632b38b0a68fa2f1622/rtls/ingress/streamkeys/:streamkey

_2

'

Headers

Header	Data type	Description
X-Request-ID	String	The UUID (Universally Unique Identifier) of the request. The value is in its X-Request-ID header. If a request error occurs, print the value in the log to troubleshoot the problem. A 401 (Unauthorized) response status code means that there is no such field in the response header.

Response body

For details about possible response status codes, see Response status codes.

If the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.

If the status code is 200, the request succeeds, and the response body includes the following parameters:

Parameter	Type	Description
status	String	The status of this request. success means the request succeeds.
data	Object	Includes the following fields: streamKey: String, the queried streaming key. channel: String. The name of the Agora channel associated with the streaming key. uid: String, the user UID in the Agora channel associated with the streaming key. expiresAfter: Integer, the validity period of the streaming key from the time of creation, in seconds. createdAt: String, the Unix timestamp for when the streaming key was created, in seconds.

The following is a response example for a successful request:

_10

{

_10

"status" : "success" ,

_10

"data" : {

_10

"streamKey" : "2dfMTR****fys" ,

_10

"channel" : "shx001" ,

_10

"uid" : "1001" ,

_10

"expiresAfter" : 0 ,

_10

"createdAt" : "1686820170"

_10

}

_10

}

Info

To explore the RESTful API parameters, obtain sample code in various client languages, or test Media Gateway requests, refer to the Postman API reference.