/api/v0/cat

Show IPFS object data.

Arguments

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

  • offset [int64]: Byte offset to begin reading from. Required: no.

  • length [int64]: Maximum number of bytes to read. 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/cat?arg=<ipfs-path>&offset=<value>&length=<value>&progress=true"


Last updated