Storage

Update a storage destination

Partial update. provider is immutable — create a new destination to change it.

patch/v1/storage-destinations/{destination_id}

Request

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

Path parameters

destination_idstring required

Storage destination id (dst_…).

Request body

configobject
credentialsobject

Never returned again; send it only when it changes.

is_defaultboolean
keep_hosted_copyboolean
namestring
path_templatestring
provider's3' | 's3_compatible' | 'azure_blob' | 'gcs' | 'sftp'
  • 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.