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

Endpoint

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

GET

Retrieve the Base64-encoded user-defined metadata value for the current file by using the specified key.

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
`key`	The user-defined metadata key 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

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_files_user_metadata_value",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "description": "The bytes that represent the Base64-encoded value of the user-defined metadata entry.",
        "type": "number"
      }
    }
  }
}

POST

Add a user-defined metadata value to the current file by using the specified key and user-defined metadata type.

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
`key`	The user-defined metadata key on which to operate.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_files_user_metadata_value",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "description": "The bytes that represent the Base64-encoded value of the user-defined metadata entry.",
        "type": "number"
      }
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

PUT

Add or update the user-defined metadata value for the current file by using the specified key.

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
`key`	The user-defined metadata key on which to operate.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_files_user_metadata_value",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "description": "The bytes that represent the Base64-encoded value of the user-defined metadata entry.",
        "type": "number"
      }
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

DELETE

Delete the user-defined metadata entry for the current file by using the specified key.

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
`key`	The user-defined metadata key on which to operate.	Yes
`If-Match`	ETag for expected version	No

Response

Codes

Code	Description
200	Return value on success