Endpoint

/v1/files/{ref}/user-metadata/{type}/

GET

Retrieve the user-defined metadata of a specified type for the current file. Values are base 64 encoded.

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
type The user-defined metadata type on which to operate. Yes
snapshot The snapshot ID that specifies the version of the filesystem to use. If not specified, use the head version. No
after Return entries after the given key (keys are returned in the paging object) No
limit Return no more than this many entries; the system may choose a smaller limit. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_files_user_metadata_range_result",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "The list of user metadata entries.",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "GENERIC",
              "S3"
            ],
            "description": "The type of user metadata. Generic user metadata is visible through the S3 api as object tags. S3 metadata is visible to the S3 protocol as object metadata.:\n * `GENERIC` - FS_USER_METADATA_TYPE_GENERIC,\n * `S3` - FS_USER_METADATA_TYPE_S3"
          },
          "key": {
            "description": "The key used to reference the user metadata.",
            "type": "string"
          },
          "value": {
            "type": "array",
            "items": {
              "description": "The data that the user-defined metadata entry stores.",
              "type": "number"
            }
          }
        }
      }
    }
  }
}