StorageBackend

Test storage backend by ID

Changed on

Test connectivity of an existing saved storage backend using its stored credentials. Returns success=false with a sanitized error message on failure (the HTTP status stays 200).

post/storage-backends/{id}/test

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}/test
  • Auth
    • API key in header Authorization
    • or API key in header X-API-Key

Path parameters

idstring required

Storage backend ID

Response

Connectivity test result (success, error)

errorstring
successboolean

Example response

{
  "success": true
}

Changes