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

url

:String permalink

API Versions: V1, V2

Parent: outputs

Valid Values: A valid S3, Cloud Files, GCS, FTP, FTPS, SFTP, Aspera, HTTP or RTMP URL.

Compatible Job Types: All

Example:

  • s3://my-output-bucket/final.mp4
  • cf://username:api_key@container/object
  • cf+uk://username:api_key@container/object
  • gcs://access_key:secret_key@gcs-bucket/object
  • ftp://user:password@ftp.example.com/final.mp4
  • sftp://user:password@sftp.example.com/final.mp4
  • aspera://user:password@host:ssh-port/path/to/file.mp4
  • rtmp://user:pass@server.akamaientrypoint.net/EntryPoint/live_01_300@63239

Description:

A full URL, including a filename, to which the output file will be uploaded. Please see base_url for more information about providers.

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).

To create keys containing special characters that are not valid in URLs (? or #), you must URL encode them (%3F and %23, respectively). No other characters need to be URL encoded.

Notes on Cloud Files:

You can specify the region to use (US or UK) by adding it to the protocol, like cf+uk://username:api_key@container/object. The US region will be used by default.

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.

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.

Zencoder runs an Aspera Client on the video encoding servers, which connects to your Aspera Enterprise or Connect Server, which hosts the files.

This is a similar situation to you running an FTP server to make your files available and Zencoder using an FTP client for file transfer.

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