Retrieve a Template Credential

GET query components

• Passing signature is required. For more information please check Signature Authentication.
• Passing params is required. It should be first JSON encoded and then URL Encoded with the keys as shown in the table below.

Supported keys inside the params query component

• auth

  Objectrequired

  Contains at least your Transloadit Auth Key in the key property.

  If you enable Signature Authentication, you'll also set an expiry date for the request in the expires property like so:

  {
    "key": "23c96d084c744219a2ce156772ec3211",
    "expires": "2023/01/01 16:53:14+00:00"
  }
  

  The referer property is a regular expression to match against the HTTP referer of this upload, such as "example\.org". Specify this key to make sure that uploads only come from your domain.

  Uploads without a referer will always pass (as they are turned off for some browsers) making this useful in just a handful of use cases. For details about regular expressions, see Mozilla's RegExp documentation.

  The max_size property can be used to set a maximum size that an upload can have in bytes, such as 1048576 (1 MB). Specify this to prevent users from uploading excessively large files.

  When using this key, make sure that it is specified as a hidden max_size form field, since setting max_size in a Template will have no effect.

  The file size is checked as soon as the upload is started and if it exceeds the maximum size, the entire upload process is canceled and the Assembly will error out, even if it contains files that do not exceed the max_size limitation.

  If you want to just ignore the files that exceed a certain size, but process all others, then please use 🤖/file/filter.

Response

Here’s an example response body:

                {
  "ok": "TEMPLATE_CREDENTIALS_READ",
  "message": "Your Template Credentials were successfully read.",
  "credential": {
    "id": "ca7644b763c848e6af4f4ccf3eaea622",
    "account_id": "xxx",
    "name": "example_credentials",
    "type": "s3",
    "created": "2022-09-20T11:09:34.000Z",
    "modified": "2022-09-20T11:09:34.000Z",
    "deleted": null,
    "content": {
      "key": "xyxy",
      "secret": "xyxyxyxy",
      "bucket": "mybucket.example.com",
      "bucket_region": "us-east-1"
    },
    "stringified": "{\"key\":\"xyxy\",\"secret\":\"xyxyxyxy\",\"bucket\":\"mybucket.example.com\",\"bucket_region\":\"us-east-1\"}"
  }
}
                ```