Application Settings

Returns the configuration settings for a specific application.

Request

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

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name

Response

Status Codes

Code	Description
200	Success
401	Unauthorized - Invalid or missing token
404	Not Found - Application does not exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Successful Response (200)

{
  "data": {
    "name": "edge",
    "type": "EDGE",
    "generalSettings": {
      "attributes": {
        "description": { "editable": true, "value": "Default application" },
        "broadcastLimit": { "editable": true, "value": 1 },
        "statInterval": { "editable": true, "value": 4 },
        "autoThumbnail": {
          "enabled": { "editable": true, "value": false },
          "interval": { "editable": true, "value": 3 },
          "thumbWidth": { "editable": true, "value": null },
          "thumbHeight": { "editable": true, "value": null }
        }
      }
    },
    "streamingClusterSettings": {
      "attributes": {
        "nodeHostname": { "editable": true, "value": "stormdev2.web-anatomy.com" },
        "nodePort": { "editable": true, "value": 443 },
        "nodeIsSSL": { "editable": true, "value": true },
        "copyOnPublish": { "editable": true, "value": true },
        "clusterManagers": [
          {
            "hostname": { "editable": true, "value": "127.0.0.1" },
            "port": { "editable": true, "value": 8080 },
            "isSSL": { "editable": true, "value": false },
            "priority": { "editable": true, "value": 1 },
            "secret": { "editable": true, "value": "xi4wIJ1lvcZINUw!" }
          }
        ]
      }
    },
    "playbackSettings": {
      "attributes": {
        "totalViewerLimit": { "editable": true, "value": null },
        "streamViewerLimit": { "editable": true, "value": null },
        "frameBufferSize": { "editable": true, "value": 0 },
        "harnessTypes": ["storm-hls", "storm-mse", "generic-hls", "rtmp"]
      }
    },
    "streamSecuritySettings": {
      "attributes": {
        "tokenProtectionEnabled": { "editable": true, "value": false },
        "domainAccessRights": [
          {
            "type": { "editable": true, "value": "allow" },
            "domain": { "editable": true, "value": "*" }
          },
          {
            "type": { "editable": true, "value": "deny" },
            "domain": { "editable": true, "value": "acme.com" }
          }
        ]
      }
    },
    "dvrSettings": {
      "attributes": {
        "enabled": { "editable": true, "value": false },
        "cacheSize": { "editable": true, "value": 100 }
      }
    },
    "streamKeyAliasSettings": {
      "attributes": {
        "enabled": { "editable": true, "value": true },
        "autoDiscovery": {
          "enabled": { "editable": true, "value": false }
        }
      }
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1766064601242
  }
}

Response Body

Application Info

Parameter	Type	Description
`data.name`	string	Application name
`data.type`	"MONO" \| "ORIGIN" \| "TRANSCODE" \| "EDGE"	Application type

Response includes all settings with editable and value properties. Available settings depend on the application type.

See Application Create for detailed settings documentation.

Settings Sections by Application Type

Setting	MONO	ORIGIN	TRANSCODE	EDGE
`generalSettings`	✓	✓	✓	✓
`ingestSettings`	✓	✓	-	-
`playbackSettings`	✓	-	-	✓
`streamSecuritySettings`	✓	-	-	✓
`liveTranscodingSettings`	✓	✓	✓	-
`dvrSettings`	✓	-	-	✓
`recordingSettings`	✓	✓	-	✓
`streamKeyAliasSettings`	✓	-	-	✓
`streamingClusterSettings`	-	✓	✓	✓

Metadata

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

Error Responses

Application Not Found (404)

{
  "message": "Application not found"
}

Error Response Body

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