Endpoint

/v1/files/{ref}/streams/

GET

List all named streams on provided object

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
snapshot The snapshot ID that specifies the version of the filesystem to use. If not specified, use the head version. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_named_stream_attributes",
    "type": "object",
    "properties": {
      "name": {
        "description": "name",
        "type": "string"
      },
      "id": {
        "description": "id",
        "type": "string"
      },
      "size": {
        "description": "size",
        "type": "string"
      },
      "datablocks": {
        "description": "datablocks",
        "type": "string"
      },
      "data_revision": {
        "description": "data_revision",
        "type": "string"
      }
    }
  }
}

POST

Create a named stream on provided object

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
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_named_stream_entry",
  "type": "object",
  "properties": {
    "stream_name": {
      "description": "Stream name to be created.",
      "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",
      "type": "string"
    },
    "datablocks": {
      "description": "datablocks",
      "type": "string"
    },
    "data_revision": {
      "description": "data_revision",
      "type": "string"
    }
  }
}