Endpoint

/v1/files/{ref}/streams/{stream_id}/punch-hole

POST

Create a hole in a region of a stream. Destroys all data within the hole so that subsequent reads will return zeroes. Returns the post-operation attributes of the stream.

Parameters

Name Description Required
ref The file ID or the absolute path to the file system object. File IDs can be found in the id field of responses of APIs that return file attributes. You must URL-encode the paths. The APIs & Tools page in the Qumulo Core Web UI URL-encodes the paths. Yes
stream_id Stream ID (u64) to be modified Yes
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_files_punch_hole",
  "type": "object",
  "properties": {
    "offset": {
      "description": "Offset in bytes specifying the start of the hole to create.",
      "type": "string"
    },
    "size": {
      "description": "Size in bytes of the hole to create.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_named_stream_attributes",
  "type": "object",
  "properties": {
    "name": {
      "description": "name",
      "type": "string"
    },
    "id": {
      "description": "id",
      "type": "string"
    },
    "size": {
      "description": "Size of the stream in bytes",
      "type": "string"
    },
    "datablocks": {
      "description": "Number of data blocks used by the stream on this cluster",
      "type": "string"
    },
    "logical_datablocks": {
      "description": "Number of data blocks used by the stream",
      "type": "string"
    },
    "data_revision": {
      "description": "Counter that increases with every data change to the stream",
      "type": "string"
    }
  }
}