Home » API Reference » Encoding Settings » General Output Settings » Base URL

base_url

:String permalink

API Versions: V1, V2

Parent: outputs

Valid Values: A valid S3, Cloud Files, GCS, Aspera, FTP, FTPS, or SFTP URL, without a filename.

Compatible Job Types: All

Example:

  • s3://my-output-bucket/
  • cf+uk://username:api_key@container/
  • gcs://access_key:secret_key@gcs-bucket/
  • ftp://user:password@ftp.example.com/path/to
  • http://s3.amazonaws.com/my-output-bucket/
  • aspera://user:password@host:ssh-port/path/to/

Description:

A base S3, Cloud Files, GCS, FTP, FTPS, or SFTP directory URL where the transcoded file will be uploaded, without a filename. If filename is not specified, a random filename plus an appropriate extension will be generated.

Notes on S3:

You must grant write permissions to Zencoder on the output bucket before submitting a job to Zencoder. Please note that it is the S3 bucket, and not the S3 "path" which needs write permission. For example, an asset at http://s3.amazonaws.com/my_files/0000/video.mp4 needs write access added to "my_files" (the bucket name), not "my_files/0000" (the path).

You may provide the region of the S3 bucket by setting the URL's protocol to s3+region-name, where "region-name" is defined by this document. For example, to access a file from a bucket in the Asia Pacific (Singapore) region, set the URL to s3+ap-southeast-1://my-bucket/.

Notes on Cloud Files:

You can specify the region to use (DFW, ORD, or UK) by adding it to the protocol, like cf+ord://username:api_key@container/object. Currently the only Cloud Files regions supported are DFW, ORD and UK.

Any special characters in the container name must be URL encoded.

Notes on Google Cloud Storage:

GCS access keys can be found under the "Interoperable Access" section in the Google APIs console. Access keys must be properly escaped.

GCS bucket names that include dots are not supported.

Notes on Azure:

If the URL contains authentication with special characters, make sure that they are properly escaped.

Notes on FTP:

If the URL contains authentication with special characters, make sure that they are properly escaped.

We try to write from the root of your server, so use an absolute path for your URL to ensure that we can write to your server successfully.

Notes on Aspera:

The ssh-port portion of the URL is not required, and will default to 22.

Notes on HTTP:

We officially support HTTP upload to S3, GCS, Cloud Files, and Akamai.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "base_url": "s3://my-output-bucket/"
    }
  ]
}
      
<api_request>
  <input>s3://zencodertesting/test.mov</input>
  <outputs type="array">
    <output>
      <base_url>s3://my-output-bucket/</base_url>
    </output>
  </outputs>
</api_request>