Transloadit

Edit a Template Credential

PUThttps://api2.transloadit.com/template_credentials/{CREDENTIALS_ID_OR_NAME}?signature={SIGNATURE}

Updates the Template Credentials represented by CREDENTIALS_ID (or CREDENTIALS_NAME) with the new Template Credentials name, type and content.

PUT fields

  • Passing signature is required. For more information, please check Signature Authentication.
  • Passing params is required. It should contain a JSON encoded object with the keys as shown in the table below.

Supported keys inside the params field

  • auth — required

    object

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

    If you enable Signature Authentication, you must also set an expiry date for the request in the expires property:

    {
  "key": "23c96d084c744219a2ce156772ec3211",
  "expires": "2009-08-28T01:02:03.000Z"
}

    We strongly recommend including the nonce property — a randomly generated, unique value per request that prevents duplicate processing upon retries, can aid in debugging, and avoids attack vectors such as signature key reuse:

    {
  // …
  "nonce": "04ac6cb6-df43-41fb-a7fd-e5dd711a64e1"
}

    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.

    This can be set as part of the Assembly request or as part of the Template.

    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.

  • name — required

    string

    Name of the Template Credentials. Must be longer than 3 characters, can only contain dashes and latin letters.

  • type — required

    azure | backblaze | cloudflare | companion | digitalocean | dropbox | ftp |

    The service to create credentials for.

  • content — required

    object

    Key and value pairs which fill in the details of the Template Credentials. For example, for an S3 bucket, this would be a valid content object to send:

    {
  "content": {
    "key": "xyxy",
    "secret": "xyxyxyxy",
    "bucket" : "mybucket.example.com",
    "bucket_region": "us-east-1"
  }
}

Response

Here’s an example response body:

{
  "ok": "TEMPLATE_CREDENTIALS_UPDATED",
  "message": "Your Template Credentials were successfully updated.",
  "credential": {
    "id": "a569fa76fe214728bd3a1ddd8d8a4496",
    "account_id": "72a70fba93ce41cba617cfd7c2a44b1a",
    "name": "change_name_example",
    "type": "s3",
    "created": "2022-09-20T13:01:37.000Z",
    "modified": "2022-09-20T13:02:01.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\"}"
  }
}

Upon error, the error key will contain the corresponding error status code.