API documentation

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Param name	Description
name required	Publishing channel name Validations: Must be a String
private optional	Is channel private Validations: Must be one of: `true`, `false`.
users optional	User ID Validations: Must be an array of Integer
config required	Configuration for the channel Validations: Must be a Hash
config[host] required	Host address Validations: Must be a String
config[port] required	Port for the ASCP connection Validations: Must be a String
config[username] required	Username for the ASCP connection Validations: Must be a String
config[password] optional	Password for the ASCP connection Validations: Must be a String
config[pkey] optional	Private key for the ASCP connection Validations: Must be a String
config[path] required	Path at ASCP host Validations: Must be a String
config[create_folder] optional	Option, create folder if does not exist Validations: Must be one of: `true`, `false`.
config[overwrite_behaviour] optional	Option, file overwrite behaviour Validations: Must be one of: `default`, `older`, `never`.
config[required_segments] optional	Option, required string segments Validations: Must be an array of String
config[excluded_segments] optional	Option, forbidden string segments Validations: Must be an array of String