Update storage

Required roles:

  • can_write_storages
put/v1/storages/{storage_id}/

Request

Path parameters

storage_idstring required

Query parameters

send_storage_gateway_eventboolean

Send a restart event to the storage gateway (file storages only)

Headers

App-IDstring required
Auth-Tokenstring required

Request body

defaultboolean
descriptionstring nullable
idstring uuid
last_scannedstring date-time nullable
method'FILE' | 'HTTP' | 'FTP' | 'SFTP' | 'S3' | 'B2' | 'GCS' | 'PORTAL' | 'CUSTOM' | 'AZURE' | 'DROPBOX' required
namestring required
purpose'KEYFRAMES' | 'FILES' | 'PROXIES' | 'EXPORTS' | 'ARCHIVE' | 'FACES' required
scanner_statusstring nullable
settingsobject required
status'ACTIVE' | 'INACTIVE' | 'FAILING'
status_messagestring nullable
versionstring

Response

Returns an updated storage

defaultboolean
descriptionstring nullable
idstring uuid
last_scannedstring date-time nullable
method'FILE' | 'HTTP' | 'FTP' | 'SFTP' | 'S3' | 'B2' | 'GCS' | 'PORTAL' | 'CUSTOM' | 'AZURE' | 'DROPBOX' required
namestring required
purpose'KEYFRAMES' | 'FILES' | 'PROXIES' | 'EXPORTS' | 'ARCHIVE' | 'FACES' required
scanner_statusstring nullable
settingsobject required
status'ACTIVE' | 'INACTIVE' | 'FAILING'
status_messagestring nullable
versionstring

Changes

No recorded changes to this operation across all 1 revision of this API.