Application Stream Key Alias Settings Update

Updates the stream key alias settings for an application.

Request

Property	Value
Method	`PATCH`
URL	`/api/applications/{appName}/settings/aliases`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X PATCH "{BASE_URL}/api/applications/{appName}/settings/aliases" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name

Request

bash

curl -X PATCH "{BASE_URL}/api/applications/{appName}/settings/aliases" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Request Body

Parameter	Type	Required	Description
`data.attributes.enabled`	boolean	No	Enable stream key aliases
`data.attributes.autoDiscovery.enabled`	boolean	No	Enable auto-discovery
`data.attributes.autoDiscovery.requestURL`	string	No	Discovery API URL (use `${streamKey}` placeholder)
`data.attributes.autoDiscovery.xApiKey`	string	No	API key for discovery requests
`data.attributes.autoDiscovery.expireTime`	integer	No	Alias cache expiration in seconds

Example Request

json

{
  "data": {
    "attributes": {
      "enabled": true,
      "autoDiscovery": {
        "enabled": true,
        "requestURL": "https://api.example.com/alias/${streamKey}",
        "xApiKey": "bd34ddawe34v51rxw6tbn",
        "expireTime": 3600
      }
    }
  }
}

Response Body

Stream Key Alias Settings

Parameter	Type	Description
`data.attributes.enabled.value`	boolean	Stream key aliases enabled status
`data.attributes.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.enabled.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.autoDiscovery.enabled.value`	boolean	Auto-discovery enabled status
`data.attributes.autoDiscovery.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.autoDiscovery.enabled.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.autoDiscovery.requestURL.value`	string	Discovery API URL
`data.attributes.autoDiscovery.requestURL.editable`	boolean	Indicates if the field can be modified
`data.attributes.autoDiscovery.requestURL.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.autoDiscovery.xApiKey.value`	string	API key for discovery requests
`data.attributes.autoDiscovery.xApiKey.editable`	boolean	Indicates if the field can be modified
`data.attributes.autoDiscovery.xApiKey.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.autoDiscovery.expireTime.value`	integer	Alias cache expiration in seconds
`data.attributes.autoDiscovery.expireTime.editable`	boolean	Indicates if the field can be modified
`data.attributes.autoDiscovery.expireTime.lockedBy`	string	Locked by environment variable (if present)
`message`	string	Response status message

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "autoDiscovery": {
        "expireTime": {
          "editable": true,
          "value": 3600
        },
        "requestURL": {
          "editable": true,
          "value": "https://api.example.com/alias/${streamKey}"
        },
        "xApiKey": {
          "editable": true,
          "value": "bd34ddawe34v51rxw6tbn"
        },
        "enabled": {
          "editable": true,
          "value": true
        }
      },
      "enabled": {
        "editable": true,
        "value": true
      }
    }
  },
  "meta": {
    "executionTime": 8,
    "generatedAt": 1766071207823
  },
  "message": "Stream Key Alias Settings have been updated"
}

Error Responses

Application Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Application not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.