Headers

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

Params

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[username]
required

Username for FTP connection

Validations:

  • Must be a String

config[password]
required

Password for FTP connection

Validations:

  • Must be a String

config[path]
required

Path at FTP host

Validations:

  • Must be a String

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters