Application Ingest Settings Update

Updates the stream ingest settings for an application.

Request

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

Request

bash

curl -X PATCH "{BASE_URL}/api/applications/{appName}/settings/ingest" \
  -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/ingest" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Request Body

Parameter	Type	Required	Description
`data.attributes.allowStreamIngest`	boolean	No	Allow stream ingestion
`data.attributes.autoStreamPublish`	boolean	No	Auto-publish incoming streams
`data.attributes.allowStreamOverwrite`	boolean	No	Allow overwriting existing streams with the same key
`data.attributes.authorizationEnabled`	boolean	No	Enable ingest authorization
`data.attributes.authType`	"none" \| "managed" \| "request" \| "file" \| "local"	No	Authorization type (required if `authorizationEnabled` is `true`)

Additional parameters depend on the authType. See the Authorization Types section below.

No Authorization

json

{
  "data": {
    "attributes": {
      "allowStreamIngest": true,
      "autoStreamPublish": true,
      "allowStreamOverwrite": false,
      "authorizationEnabled": false
    }
  }
}

Managed Authorization

json

{
  "data": {
    "attributes": {
      "allowStreamIngest": true,
      "autoStreamPublish": true,
      "allowStreamOverwrite": false,
      "authorizationEnabled": true,
      "authType": "managed"
    }
  }
}

HTTP Request Authorization

json

{
  "data": {
    "attributes": {
      "allowStreamIngest": true,
      "autoStreamPublish": true,
      "allowStreamOverwrite": true,
      "authorizationEnabled": true,
      "authType": "request",
      "requestURL": "https://api.example.com/auth/stream/${streamKey}",
      "apiKey": "bd34ddawe34v51rxw6tbn"
    }
  }
}

File Authorization

json

{
  "data": {
    "attributes": {
      "allowStreamIngest": true,
      "autoStreamPublish": true,
      "allowStreamOverwrite": false,
      "authorizationEnabled": true,
      "authType": "file",
      "fileURL": "/home/storm/auth/publish_keys.xml"
    }
  }
}

Local Authorization

json

{
  "data": {
    "attributes": {
      "allowStreamIngest": true,
      "autoStreamPublish": true,
      "allowStreamOverwrite": true,
      "authorizationEnabled": true,
      "authType": "local",
      "authUsers": [
        {
          "username": "admin",
          "password": "qwerty123"
        },
      ]
    }
  }
}

Response Body

Ingest Settings

Parameter	Type	Description
`data.attributes.allowStreamIngest.value`	boolean	Allow stream ingestion
`data.attributes.allowStreamIngest.editable`	boolean	Indicates if the field can be modified
`data.attributes.allowStreamIngest.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.autoStreamPublish.value`	boolean	Auto-publish incoming streams
`data.attributes.autoStreamPublish.editable`	boolean	Indicates if the field can be modified
`data.attributes.autoStreamPublish.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.allowStreamOverwrite.value`	boolean	Allow overwriting existing streams
`data.attributes.allowStreamOverwrite.editable`	boolean	Indicates if the field can be modified
`data.attributes.allowStreamOverwrite.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.authorizationEnabled.value`	boolean	Ingest authorization enabled
`data.attributes.authorizationEnabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.authorizationEnabled.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.authType.value`	string	Authorization type
`data.attributes.authType.editable`	boolean	Indicates if the field can be modified
`data.attributes.authType.lockedBy`	string	Locked by environment variable (if present)
`message`	string	Response status message

Authorization Types

Type	Description
`"none"`	No authorization required for stream ingest (default)
`"managed"`	Authentication data is attached to dynamically created streams. Clients must include credentials when publishing
`"request"`	Validates stream ingest via external HTTP API
`"file"`	Validates stream ingest against an XML file with authorized keys
`"local"`	Validates stream ingest against a local list of users and tokens

Additional Parameters

Parameter	Type	Auth Type	Description
`data.attributes.requestURL`	string	`"request"`	Authorization API URL (use `${streamKey}` placeholder)
`data.attributes.apiKey`	string	`"request"`	API key for authorization requests
`data.attributes.fileURL`	string	`"file"`	Path to authorization XML file
`data.attributes.authUsers`	array	`"local"`	List of authorized users/tokens
`data.attributes.authUsers[].username`	string	`"local"`	Username (for username/password auth)
`data.attributes.authUsers[].password`	string	`"local"`	Password (for username/password auth)
`data.attributes.authUsers[].token`	string	`"local"`	Token (for token-based auth)
`data.attributes.authUsers[].expire`	integer	`"local"`	Token expiration (Unix timestamp in ms, optional)

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": {
      "allowStreamIngest": {
        "editable": true,
        "value": true
      },
      "autoStreamPublish": {
        "editable": true,
        "value": true
      },
      "allowStreamOverwrite": {
        "editable": true,
        "value": false
      },
      "authorizationEnabled": {
        "editable": true,
        "value": false
      },
      "authType": {
        "editable": true,
        "value": "none"
      }
    }
  },
  "meta": {
    "executionTime": 7,
    "generatedAt": 1766071325856
  },
  "message": "Ingest Settings have been updated"
}

Error Response (4xx/5xx)

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

Application Not Found (404)

json

{
  "message": "Application not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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