/api/v0/get

Download IPFS objects.

Arguments

• arg [string]: The path to the IPFS object(s) to be outputted. Required: yes.

• output [string]: The path where the output should be stored. Required: no.

• archive [bool]: Output a TAR archive. Required: no.

• compress [bool]: Compress the output with GZIP compression. Required: no.

• compression-level [int]: The level of compression (1-9). Required: no.

• progress [bool]: Stream progress data. Default: true. Required: no.

Response

On success, the call to this endpoint will return with 200 and the following body:

This endpoint returns a `text/plain` response body.

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/get?arg=<ipfs-path>&output=<value>&archive=<value>&compress=<value>&compression-level=<value>&progress=true"