depot-service/io.dataos.ds.client.apis/DepotApi/archive

archive

@PATCH(value = "api/v2/depots/{depot}/archived")

abstract fun archive(@Path(value = "depot") depotString: String, @Body request: DepotFlagRequest, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<DepotResponse>

Makes a PATCH request to archive a depot.

Return

a Call object with a response of type DepotResponse

Parameters

depotString

the name of the depot to archive

request

the depot flag request indicating that the depot should be archived

correlationId

the correlation ID to use in the request header (optional, defaults to a new UUID if not provided)