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

AWS S3 Access key ID

Validations:

  • Must be a String

config[aws_secret_access_key]
required

AWS S3 secret access key

Validations:

  • Must be a String

config[bucket_name]
required

AWS S3 Bucket

Validations:

  • Must be a String

config[region_name]
required

AWS Region name

Validations:

  • Must be a String

config[endpoint_url]
required

URL for the AWS S3 bucket

Validations:

  • Must be a String

Errors

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