Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: XNATRestClient -> XnatDataClient. Add HTTPie example.

Depending on the tool you are using to PUT files to the server, you may need to add an inbody=true query string parameter to force XNAT to treat the contents of your HTTP message as the actual file rather then as multi-part form data.


The XNAT team has developed some simple java based tools which can be used as command prompt tools to access the REST API.





The XnatDataClient is built specifically to facilitate user interaction with the REST API from the command prompt. Uploading files with this tool should be straightforward. You use the -local variable to identify the Use the -l (or --local) flag to give the path to the local file you are uploading. You use the -remote variable to identify the location you are PUTinig the file to.

Code Block
XnatDataClient -host -u USERUSERNAME -p PASSPASSWORD -m PUT -remoter "http:/data/archive/" -locall filename./file.txt


Most UNIX operating systems come pre-installed with 'Curl' which is a tool for transferring data to or from a server. Because XNAT Servers are secured, you will need to provide a username and password to access the api. If you use the -F tag, the file will be sent to the server as part of a multipart-form message (similar to a browser post).  Without the -F tag, curl would post the file as the body of the message and you would need to set the mime-type of your message for XNAT to process it correctly (or use the ?inbody=true parameter).  For convenience, the -F works effectively.

Code Block
curl -u USERNAME:PASSWORD -X PUT " TO DESTINATION" -F "filename.txtfile=@filename.txt"

For more information on using curl, please review its documentation (


This tool was written in python (using the requests library) to mimic the syntax of curl while being better "unix citizen" than curl in how it reads stdin and writes stdout.

Code Block
http -a USERNAME:PASSWORD --form PUT file=@filename.txt

See more about HTTPie at its home or by reading its documentation.

Compressed file upload

The REST API supports the upload of compressed files that can be extracted on the server after successful upload. There are a few caveats: