Products Solutions Developer Pricing Get For Free Download Sign in Sign up
Show topics

Application General Settings Update

Updates the general settings for an application.

Request

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

Path Parameters

Parameter Type Required Description
appName string Yes Application name

Request Body

Parameter Type Required Description
data.attributes.description string No Application description
data.attributes.broadcastLimit integer | null No Maximum number of streams (null = unlimited)
data.attributes.statInterval integer No Statistics update interval (sec)
data.attributes.autoThumbnail.enabled boolean No Enable automatic thumbnails
data.attributes.autoThumbnail.interval integer No Thumbnail generation interval (sec)
data.attributes.autoThumbnail.thumbWidth integer | null No Thumbnail width in pixels
data.attributes.autoThumbnail.thumbHeight integer | null No Thumbnail height in pixels

Example Request

{
  "data": {
    "attributes": {
      "description": "Main streaming application",
      "broadcastLimit": 50,
      "statInterval": 2,
      "autoThumbnail": {
        "enabled": true,
        "interval": 10,
        "thumbWidth": 320,
        "thumbHeight": 180
      }
    }
  }
}

Response

Status Codes

Code Description
200 Success - Settings updated
400 Bad Request - Invalid parameters
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": {
    "attributes": {
      "description": {
        "editable": true,
        "value": "Main streaming application"
      },
      "broadcastLimit": {
        "editable": true,
        "value": 50
      },
      "statInterval": {
        "editable": true,
        "value": 2
      },
      "autoThumbnail": {
        "enabled": {
          "editable": true,
          "value": true
        },
        "interval": {
          "editable": true,
          "value": 10
        },
        "thumbWidth": {
          "editable": true,
          "value": 320
        },
        "thumbHeight": {
          "editable": true,
          "value": 180
        }
      }
    }
  },
  "meta": {
    "executionTime": 8,
    "generatedAt": 1766065976946
  },
  "message": "General Settings have been updated"
}

Response Body

General Settings

Parameter Type Description
data.attributes.description.value string Application description
data.attributes.description.editable boolean Indicates if the field can be modified
data.attributes.description.lockedBy string Locked by environment variable (if present)
data.attributes.broadcastLimit.value integer | null Maximum number of streams
data.attributes.broadcastLimit.editable boolean Indicates if the field can be modified
data.attributes.broadcastLimit.lockedBy string Locked by environment variable (if present)
data.attributes.statInterval.value integer Statistics update interval (sec)
data.attributes.statInterval.editable boolean Indicates if the field can be modified
data.attributes.statInterval.lockedBy string Locked by environment variable (if present)
data.attributes.autoThumbnail.enabled.value boolean Automatic thumbnails enabled
data.attributes.autoThumbnail.enabled.editable boolean Indicates if the field can be modified
data.attributes.autoThumbnail.enabled.lockedBy string Locked by environment variable (if present)
data.attributes.autoThumbnail.interval.value integer Thumbnail generation interval (sec)
data.attributes.autoThumbnail.interval.editable boolean Indicates if the field can be modified
data.attributes.autoThumbnail.interval.lockedBy string Locked by environment variable (if present)
data.attributes.autoThumbnail.thumbWidth.value integer | null Thumbnail width in pixels
data.attributes.autoThumbnail.thumbWidth.editable boolean Indicates if the field can be modified
data.attributes.autoThumbnail.thumbWidth.lockedBy string Locked by environment variable (if present)
data.attributes.autoThumbnail.thumbHeight.value integer | null Thumbnail height in pixels
data.attributes.autoThumbnail.thumbHeight.editable boolean Indicates if the field can be modified
data.attributes.autoThumbnail.thumbHeight.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)

Error Responses

Application Not Found (404)

{
  "message": "Application not found"
}

Error Response Body

Parameter Type Description
message string Human-readable error message