POST

/getDataEndpoint

http://kinesisvideo.{region}.amazonaws.com/getDataEndpoint

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the <code>GetMedia</code> or <code>GetMediaForFragmentList</code> operations) or write to it (using the <code>PutMedia</code> operation). <note> The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. </note> In the request, specify the stream either by <code>StreamName</code> or <code>StreamARN</code>.

Access Token Required: API Key

Body Params

APINamestringrequired

The name of the API action for which to get an endpoint.

StreamARNstring

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a <code>StreamName</code> in the request.

StreamNamestring

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a <code>StreamARN</code> in the request.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://kinesisvideo.{region}.amazonaws.com/getDataEndpoint' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}