Update a storage gateway cluster

patch/v1/storage_gateway_clusters/{cluster_id}/

Request

Base URL
https://app.iconik.io/API/files
Auth
none declared. Required headers: App-ID, Auth-Token
TypeScript
https://skmtc.dev/iconik/apis/iconik-files/docs/v1/storage_gateway_clusters/:cluster_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

cluster_idstring required

Headers

App-IDstring required

Auth-Tokenstring required

Request body

date_createdstring date-time

date_modifiedstring date-time

db_connection_uristring

Database connection URI

descriptionstring

enabledboolean required

Application toggle. If turned off ISG will enter idle state waiting to get enabled again.

idstring uuid

namestring required

status'OFFLINE' | 'ACTIVE' | 'WARNING' | 'ERROR' | 'STOPPED'

storage_idsstring[] required

total_files_numberinteger

Total number of files

transcode_queue_totalinteger

Total number of scheduled transcode jobs

uploads_queue_totalinteger

Total number of scheduled auto-uploads

visibility_timeoutinteger

The number of seconds jobs should remain invisible to other nodes

Response

Cluster updated successfully