Cluster Settings

Returns the cluster configuration settings.

Request

Property	Value
Method	`GET`
URL	`/api/cluster/settings`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/cluster/settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Code	Description
200	Success
401	Unauthorized - Invalid or missing token
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

General Settings

Parameter	Type	Description
`data.attributes.enabled.value`	boolean	Cluster manager enabled
`data.attributes.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.identity.value`	string	Cluster manager identity name
`data.attributes.identity.editable`	boolean	Indicates if the field can be modified
`data.attributes.globalStatistics.value`	boolean	Enable global statistics collection
`data.attributes.globalStatistics.editable`	boolean	Indicates if the field can be modified

Authentication Settings

Parameter	Type	Description
`data.attributes.authentication.secret.value`	string	Authentication secret for cluster nodes
`data.attributes.authentication.secret.editable`	boolean	Indicates if the field can be modified
`data.attributes.authentication.ipWhiteList.value`	string[]	List of whitelisted IP addresses
`data.attributes.authentication.ipWhiteList.editable`	boolean	Indicates if the field can be modified

Cluster Transcoding Settings

Parameter	Type	Description
`data.attributes.clusterTranscoding.enabled.value`	boolean	Enable cluster transcoding
`data.attributes.clusterTranscoding.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.active.value`	boolean	Cluster transcoding currently active
`data.attributes.clusterTranscoding.active.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.aliasMode.value`	boolean	Enable alias mode for transcoding
`data.attributes.clusterTranscoding.aliasMode.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.minimalSourceResolution.value`	string	Minimum source resolution for transcoding
`data.attributes.clusterTranscoding.minimalSourceResolution.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.streamEvaluationInterval.value`	integer	Stream evaluation interval in seconds
`data.attributes.clusterTranscoding.streamEvaluationInterval.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.streamGraceTimeout.value`	integer	Stream grace timeout in seconds
`data.attributes.clusterTranscoding.streamGraceTimeout.editable`	boolean	Indicates if the field can be modified

Stream Weights Settings

Parameter	Type	Description
`data.attributes.clusterTranscoding.streamWeights.enabled.value`	boolean	Enable stream weights
`data.attributes.clusterTranscoding.streamWeights.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.streamWeights.requestURL.value`	string	API URL for stream weights
`data.attributes.clusterTranscoding.streamWeights.requestURL.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.streamWeights.apiKey.value`	string	API key for stream weights requests
`data.attributes.clusterTranscoding.streamWeights.apiKey.editable`	boolean	Indicates if the field can be modified
`data.attributes.clusterTranscoding.streamWeights.weightTimeout.value`	integer	Weight cache timeout in seconds
`data.attributes.clusterTranscoding.streamWeights.weightTimeout.editable`	boolean	Indicates if the field can be modified

AWS Module Settings

Parameter	Type	Description
`data.attributes.awsModule.enabled.value`	boolean	Enable AWS module
`data.attributes.awsModule.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.awsModule.accessKeyID.value`	string	AWS access key ID
`data.attributes.awsModule.accessKeyID.editable`	boolean	Indicates if the field can be modified
`data.attributes.awsModule.secretAccessKey.value`	string	AWS secret access key
`data.attributes.awsModule.secretAccessKey.editable`	boolean	Indicates if the field can be modified
`data.attributes.awsModule.regions.value`	string[]	List of enabled AWS regions
`data.attributes.awsModule.regions.editable`	boolean	Indicates if the field can be modified

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": {
      "enabled": {
        "editable": true,
        "value": true
      },
      "identity": {
        "editable": true,
        "value": "mother superior"
      },
      "globalStatistics": {
        "editable": true,
        "value": true
      },
      "authentication": {
        "secret": {
          "editable": true,
          "value": "xi4wIJ1lvcZINUw!"
        },
        "ipWhiteList": {
          "editable": true,
          "value": []
        }
      },
      "clusterTranscoding": {
        "enabled": {
          "editable": true,
          "value": true
        },
        "active": {
          "editable": true,
          "value": false
        },
        "aliasMode": {
          "editable": true,
          "value": false
        },
        "minimalSourceResolution": {
          "editable": true,
          "value": "1280x720"
        },
        "streamEvaluationInterval": {
          "editable": true,
          "value": 30
        },
        "streamGraceTimeout": {
          "editable": true,
          "value": 301
        },
        "streamWeights": {
          "enabled": {
            "editable": true,
            "value": true
          },
          "requestURL": {
            "editable": true,
            "value": ""
          },
          "apiKey": {
            "editable": true,
            "value": ""
          },
          "weightTimeout": {
            "editable": true,
            "value": 3600
          }
        }
      },
      "awsModule": {
        "enabled": {
          "editable": true,
          "value": false
        },
        "accessKeyID": {
          "editable": true,
          "value": ""
        },
        "secretAccessKey": {
          "editable": true,
          "value": ""
        },
        "regions": {
          "editable": true,
          "value": ["us-east-2", "us-east-1"]
        }
      }
    }
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1767346862640
  }
}

Error Response (4xx/5xx)

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

json

{
  "message": "Error message"
}

Support Needed?

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