Upload Signature Data Model

Provides signature and headers required for uploading a new theme asset to Live Editor’s S3 file store.

This resource is a part of the Uploading Assets Workflow.

All of the data provided by this resource will suffice for uploading a single file to S3 via either a browser POST or any other type of client. See documentation for the Simple Storage Service REST API for more information about how to use the data provided by this endpoint.

Sample JSON Data

      {
        "data": {
          "type": "upload-signatures",
          "id": "3a32f563-c336-4c9b-9602-5962989620cf&qupt;,
          "attributes" {
            "filename": "images/water.jpg",
            "key": "1234/1234567890/images/water.jpg",
            "acl": "private",
            "content-type": "image/jpeg",
            "policy": "eyJleHBpcmF0aW8uIjoiMjAxNi0wMy0u...",
            "endpoint": "https://s3.amazonaws.com/uploads.liveeditor",
            "x-amz-credential": "VKIAI67ZPNBGNIXAFQTQ/20160302/us-east-1/s3/aws4_request",
            "x-amz-algorithm": "AWS4-HMAC-SHA256",
            "x-amz-date": "20120423T182543Z",
            "x-amz-signature": "b88837ce4394b0f5b25532074c1a232bd83b76de081f1e445a305d9f2745a0f7"
          }
        }
      }

Attributes

Attribute Type Required Description
filename string Yes Filename relative to theme’s assets folder. (See assets folder section of File and Directory Structure Guide for more information.)
key string Read-only S3 object key representing where file is to be stored after upload. After the actual file upload is finished, this key will need to be communicated to the theme asset creation endpoint for further processing.
acl string Read-only Canned ACL that is applied to the file after it is uploaded.
content-type string Yes MIME type of file to be uploaded.
policy string Read-only Base64-encoded version of this POST policy.
endpoint string Read-only S3 URL to post the file upload to.
x-amz-credential string Read-only AWS Credential to be used in header when uploading the file.
x-amz-algorithm string Read-only The algorithm that was used to calculate the signature.
x-amz-date string Read-only Date that was used to calculate the signature.
x-amz-signature string Read-only The 256-bit upload signature expressed as 64 lowercase hexadecimal characters.

Relationships

None.

Related