v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Hash a single file

Returns the hash of a single file using the specified hash algorithm.

post/operations/hashsumfile

Query parameters

fsstring

Remote name or path containing the file to hash.

remotestring

Path to the specific file within fs to hash.

hashTypestring

Hash algorithm to use, e.g. md5, sha1, or another supported name.

downloadboolean

Set to true to force reading the data instead of using remote checksums.

base64boolean

Set to true to emit the hash value in base64 rather than hexadecimal.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Headers

Prefer'respond-async'

Set to "respond-async" with _async=true to receive HTTP 202 instead of 200.

Request body

fsstring

Remote name or path containing the file to hash.

remotestring

Path to the specific file within fs to hash.

hashTypestring

Hash algorithm to use, e.g. md5, sha1, or another supported name.

downloadboolean

Set to true to force reading the data instead of using remote checksums.

base64boolean

Set to true to emit the hash value in base64 rather than hexadecimal.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Response

Hash algorithm used and the hash value for a single file from operations/hashsumfile.

hashTypestring required

The hash algorithm that was used.

hashstring required

The hash value of the file.