IPFS Tar API

The Tar API from IPFS — 2 operation(s) for tar.

OpenAPI Specification

ipfs-tar-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: IPFS RPC Add Tar API
  version: v0
  description: 'When a Kubo IPFS node is running as a daemon, it exposes an HTTP RPC API that allows you to control the node and run the same commands you can from the command line.


    In many cases, using this RPC API is preferable to embedding IPFS directly in your program — it allows you to maintain peer connections that are longer lived than your app and you can keep a single IPFS node running instead of several if your app can be launched multiple times. In fact, the `ipfs` CLI commands use this RPC API when operating in online mode.'
  x-providerName: IPFS
  x-logo:
    url: https://raw.githubusercontent.com/ipfs/ipfs-docs/55fe8bc6a53ba3b9023951fb4b432efbbc81fba5/docs/.vuepress/public/images/ipfs-logo.svg
servers:
- description: Local IPFS node
  url: http://localhost:5001
- description: Local IPFS node
  url: http://127.0.0.1:5001
- description: Infura hosted IPFS node
  url: https://ipfs.infura.io:5001
tags:
- name: Tar
paths:
  /api/v0/tar/add:
    post:
      operationId: tar/add
      description: Import a tar file into IPFS.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-tar-add
      deprecated: true
      parameters: []
      requestBody:
        description: Argument `file` is of file type. This endpoint expects one or several files (depending on the command) in the body of the request as 'multipart/form-data'.
        content: {}
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Bytes: <int64>
                Hash: <string>
                Name: <string>
                Size: <string>
      tags:
      - Tar
  /api/v0/tar/cat:
    post:
      operationId: tar/cat
      description: Export a tar file from IPFS.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-tar-cat
      deprecated: true
      parameters:
      - name: arg
        in: query
        description: ipfs path of archive to export.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      tags:
      - Tar
externalDocs:
  url: https://docs.ipfs.tech/reference/kubo/rpc/