Manage output configuration using the API

name ^required

string

Enter the name of the relay that contains the output configuration you want to retrieve.

200

Successful response. Relay output configuration retrieved.

400

Bad request. The specific error will be shown in the message.

403

Forbidden request.

404

Relay not found.

405

Method not allowed.

name ^required

string

Enter the name of the relay that contains the output configuration you want to update.

memoryBufferSize ^required

number

Memory buffer size in bytes.

The minimum value is 128 MB, and the maximum value is 1024 TB. The default value is 128 MB.

diskBufferSize ^required

number

Disk buffer size in bytes.

The minimum value is 128 MB, and the maximum value is 1024 TB. The default value is 128 MB.

socketTimeout ^required

integer

Socket timeout in seconds.

The minimum and default value is 0.

socketBufferSize ^required

integer

Socket buffer size in bytes.

The minimum value is 128 kB, and the maximum value is 4096 kB. The default is 200 kB.

socketKeepAlive ^required

boolean

Set this option to true if you want to receive a signal to check that the output socket is operating properly.

compression ^required

string

Choose the required compression type between gzip and none.

The default value is none.

200

Successful response. Relay output configuration updated.

400

Bad request. The specific error will be shown in the message.

403

Forbidden request.

404

Relay not found.

405

Method not allowed.