REST API Reference

Back Next

Standard operations

You can use the following standard operational commands:

PWD: Use the PWD (Print Working Directory) command to retrieve the current working directory on the server. The response includes the absolute path to the current working directory as part of the X-GDX-Reply header message. The path is enclosed in double quotes.
For example,
https://localhost:15400/fileservers/pwd

delete: Use this command to remove files from the server. Include the relative or absolute file path to delete in the file parameter.
For example,
https://10.60.40.11:15400/fileservers/delete?file=/abc/1.txt

rename: Use this command to rename files on the server. If the current working directory contains the files that you want to rename, then the
from
and
to
parameters might contain only the file names. You can also use the rename command to move files on the server. To move files, include the full paths in the
from
and
to
parameters.
For example, the following command changes the name of the
newInput.txt
file to
Input.txt
:

https://10.60.40.11:15400/fileservers/rename?from=/newInput.txt&;to=/Input.txt

For example, the following command moves the
newInput.txt
file from the current working directory to the parent directory:

https://10.60.40.11:15400/fileservers/rename?from=/newInput.txt&to=/aa/newInput.txt

Include the following parameters in the request:

Request Type
Parameters

GET or POST

from: The relative or absolute path of the file or directory to rename.
to: The relative or absolute path of the new name.

Request Type	Parameters
GET or POST	from: The relative or absolute path of the file or directory to rename. to: The relative or absolute path of the new name.

list: Use this command to list the contents of a directory on the server. Include the target directory as a parameter to this command. If you do not include the directory, the command lists the contents of the current working directory.
For example,
https://10.60.40.11:15400/fileservers/list?dir=/

The response body includes the contents of the directory in content type
text/plain
. The following example shows the format of the directory listing:

2009-12-03 14:02:19 D 0 backup

The response includes the following information delimited by a tab (\t) character:
The last modified date of the file or directory. The timestamp is in ISO format yyyy-MM-dd HH:mm:ss. The hour(hh) is displayed as a 24-hour clock.
Whether the content type is a file, a directory, or unknown.
The size of the file in bytes.
The name of the file or directory.

checksum: Use this command to calculate the hash of a remote file. The reply is returned on the first line of the response body. You can compare the response with the hash value of the downloaded local file to verify data integrity.
For example,
https://10.60.40.11:15400/fileservers/hash?file=/input.txt

The supported hash algorithms are SHA1, MD5, and CRC32. Include the following parameters in the request:

Request Type
Parameters

GET or POST

file: Required. The path relative to the current working directory, or an absolute path to the file.
algorithm: The hash algorithm to use when calculating a checksum. Valid values are SHA1, MD5, or CRC32. Default is SHA1.
length: The starting position within the file. This value is used for calculating partial file checksums. The default value is 0, which performs the checksum on the entire file.

Request Type	Parameters
GET or POST	file: Required. The path relative to the current working directory, or an absolute path to the file. algorithm: The hash algorithm to use when calculating a checksum. Valid values are SHA1, MD5, or CRC32. Default is SHA1. length: The starting position within the file. This value is used for calculating partial file checksums. The default value is 0, which performs the checksum on the entire file.

CD (Change Directory): Use this command to change the current working directory. The absolute path to the new working directory returns as part of the X-GDX-Reply header message. The path is enclosed in double quotes.
For example,
https://10.60.40.11:15400/fileservers/cd?dir=/

CDUP (Change Directory Up): Use this command to change the current working directory to the parent directory. The absolute path to the new working directory returns as part of the X-GDX-Reply header message. The path is enclosed in double quotes.
For example,
https://10.60.40.11:15400/fileservers/cdup

MKDIR (Make Directory): Use this command to create a new directory on the server. The absolute path to the newly created directory returns as part of the X-GDX-Reply header message. The path is enclosed in double quotes.
For example,
https://10.60.40.11:15400/fileservers/mkdir?dir=/a/b/c/mkdri1

file information: Use this command to retrieve information about a specific file or directory. The response includes the information in the response body with content type
text/plain
. The format of the file information is identical to the listing returned from the List command. If no information is returned in the response body, then the file or directory does not exist.
For example,
https://10.60.40.11:15400/fileservers/fileInfo?file=/TEST.txt