openapi: 3.2.0
info:
  title: IPFS RPC Filestore 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.
  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: File Store
paths:
  /api/v0/filestore/dups:
    post:
      operationId: filestore/dups
      description: List blocks that are both in the filestore and standard block storage.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-filestore-dups
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Err: <string>
                Ref: <string>
      tags:
      - File Store
      summary: Filestore/dups
      x-summary-source: derived
  /api/v0/filestore/ls:
    post:
      operationId: filestore/ls
      description: List objects in filestore.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-filestore-ls
      parameters:
      - name: arg
        in: query
        description: Cid of objects to list.
        schema:
          type: string
      - name: file-order
        in: query
        description: sort the results based on the path of the backing file.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                ErrorMsg: <string>
                FilePath: <string>
                Key:
                  /: <cid-string>
                Offset: <uint64>
                Size: <uint64>
                Status: <int32>
      tags:
      - File Store
      summary: Filestore/ls
      x-summary-source: derived
  /api/v0/filestore/verify:
    post:
      operationId: filestore/verify
      description: Verify objects in filestore.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-filestore-verify
      parameters:
      - name: arg
        in: query
        description: Cid of objects to verify.
        schema:
          type: string
      - name: file-order
        in: query
        description: verify the objects based on the order of the backing file.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                ErrorMsg: <string>
                FilePath: <string>
                Key:
                  /: <cid-string>
                Offset: <uint64>
                Size: <uint64>
                Status: <int32>
      tags:
      - File Store
      summary: Filestore/verify
      x-summary-source: derived
externalDocs:
  url: https://docs.ipfs.tech/reference/kubo/rpc/