System Administration > Configuration > Fabric > Nodes > File Store

Associated URIs:

API Description API Path

List node files


GET /api/v1/node/file-store
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store
GET /api/v1/cluster/<cluster-node-id>/node/file-store

Create directory in remote file server


Create a directory on the remote remote server. Supports only SFTP.
You must provide the remote server's SSH fingerprint. See the
NSX Administration Guide for information and instructions
about finding the SSH fingerprint.
POST /api/v1/node/file-store?action=create_remote_directory
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store?action=create_remote_directory
POST /api/v1/cluster/<cluster-node-id>/node/file-store?action=create_remote_directory

Delete file


DELETE /api/v1/node/file-store/<file-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
DELETE /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>

Read file properties


GET /api/v1/node/file-store/<file-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>

Copy a remote file to the file store


Copy a remote file to the file store. If you use scp or sftp,
you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.
POST /api/v1/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_from_remote_file

Upload a file to the file store


When you issue this API, the client must specify:
- HTTP header Content-Type:application/octet-stream.
- Request body with the contents of the file in the filestore.
In the CLI, you can view the filestore with the get files command.
POST /api/v1/node/file-store/<file-name>
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>

Copy file in the file store to a remote file store


Copy a file in the file store to a remote server. If you use scp or
sftp, you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.
POST /api/v1/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_to_remote_file

Read file contents


GET /api/v1/node/file-store/<file-name>/data
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data

Replace file contents


PUT /api/v1/node/file-store/<file-name>/data
PUT /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
PUT /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data

Read file thumbprint


GET /api/v1/node/file-store/<file-name>/thumbprint
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/thumbprint
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/thumbprint