Storage

Create a storage destination

credentials are encrypted at rest and never returned; reads answer {"configured": true}. Reference the destination from delivery.storage[] on a render. On Amazon S3, config.storage_class sets the class of every uploaded object and of the connection test's probe: STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING or GLACIER_IR; leave it out for the bucket's default. Archive classes (GLACIER, DEEP_ARCHIVE) and classes on other providers answer 400. config.force_path_style (S3 and S3-compatible) puts the bucket in the path (true, <endpoint>/<bucket>/<key>) or in the host name (false, <bucket>.<endpoint host>); left out, it is false for Amazon S3 and true for S3-compatible services. Bucket names with dots, underscores or capitals and IP-address endpoints always use the path. Uploaded objects get the file's content type.

post/v1/storage-destinations

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/storage-destinations
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Request body

configobject required
credentialsobject

Never returned again; send it only when it changes.

is_defaultboolean
keep_hosted_copyboolean
namestring required
path_templatestring
provider's3' | 's3_compatible' | 'azure_blob' | 'gcs' | 'sftp' required
  • s3 - Amazon S3
  • s3_compatible - S3-compatible
  • azure_blob - Azure Blob Storage
  • gcs - Google Cloud Storage
  • sftp - SFTP

Response

configobject required

Provider settings: bucket, region, endpoint, prefix, …; for SFTP host, port, username, prefix and host_key.

created_atstring date-time required
credentialsobject required

Write-only: reads return {"configured": true|false}.

idstring required

dst_…

is_defaultboolean required
keep_hosted_copyboolean required
namestring required
objectstring
path_templatestring required

Jinja path for uploaded files.

provider's3' | 's3_compatible' | 'azure_blob' | 'gcs' | 'sftp' required
  • s3 - Amazon S3
  • s3_compatible - S3-compatible
  • azure_blob - Azure Blob Storage
  • gcs - Google Cloud Storage
  • sftp - SFTP
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.