Set pinning mode

Metadata mode is only available with Filers on version 8.5 and higher.

SecurityAuthToken

Request

path Parameters

volume_guid required	string Volume identifier
filer_serial required	string Filer object identifier

Request Body schema: application/json
required

The folder to enable pinning on and optionally the mode

path	string Path of the pinned folder.
mode	string Default: "metadata_and_data" Specifies the pinning mode to enable. "metadata" - Enable pinning only on metadata. "metadata_and_data" - Enable pinning on metadata and data. Enum: "metadata" "metadata_and_data"

Responses

202

Accepted - Filer has been sent a message.

400

Validation error

401

Authentication failure

403

Permission denied

404

Resource not found

405

Method not allowed

409

Conflict

429

Request throttled

post/volumes/{volume_guid}/filers/{filer_serial}/pinned-folders/

Request samples

Payload
Python
curl
JavaScript
Node.js

application/json

{"path": "string",
"mode": "metadata"
}

Response samples

application/json

{"message": {"id": "string",
"filer_serial_number": "string",
"description": "string",
"code": "string",
"status": "synced",
"send_time": "string",
"expiration_time": "string",
"response_time": "string",
"initiated_by": "string",
"links": {"self": {"href": "string",
"method": "string"
},
"filer": {"href": "string",
"method": "string"
},
"acknowledge": {"href": "string",
"method": "string"
},
"applied_resource": {"href": "string",
"method": "string"
}
},
"error": {"code": "error",
"description": "string"
}
}
}

Set pinning mode

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required