StorageBackend

Update storage backend

Changed on

Update a storage backend's mutable fields (name, credentials, status). Provider and physical location (endpoint, region, bucket, path prefix) are immutable; use storage migration to move data. Environment-sourced backends are read-only. Redacted secret placeholders preserve the stored credentials.

put/storage-backends/{id}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/storage-backends/{id}
  • Auth
    • API key in header Authorization
    • or API key in header X-API-Key

Path parameters

idstring required

Storage backend ID

Request body

namestring required
providerstring required
statusstring

Response

Updated storage backend

successboolean

Example response

{
  "success": true
}

Changes