IPFS

IPFS Repo API

The Repo API from IPFS — 5 operation(s) for repo.

Documentation GitHub OpenAPI

Operations 5

POST /api/v0/repo/gc Repo/gc #

POST /api/v0/repo/ls Repo/ls #

POST /api/v0/repo/stat Repo/stat #

POST /api/v0/repo/verify Repo/verify #

POST /api/v0/repo/version Repo/version #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ipfs:ipfs-repo-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: IPFS RPC Repo 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: Repo
paths:
  /api/v0/repo/gc:
    post:
      operationId: repo/gc
      description: Perform a garbage collection sweep on the repo.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-gc
      parameters:
      - name: stream-errors
        in: query
        description: Stream errors.
        schema:
          type: boolean
      - name: quiet
        in: query
        description: Write minimal output.
        schema:
          type: boolean
      - name: silent
        in: query
        description: Write no output.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Error: <string>
                Key:
                  /: <cid-string>
      tags:
      - Repo
      summary: Repo/gc
      x-summary-source: derived
  /api/v0/repo/ls:
    post:
      operationId: repo/ls
      description: List all local references.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-ls
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Err: <string>
                Ref: <string>
      tags:
      - Repo
      summary: Repo/ls
      x-summary-source: derived
  /api/v0/repo/stat:
    post:
      operationId: repo/stat
      description: Get stats for the currently used repo.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-stat
      parameters:
      - name: size-only
        in: query
        description: Only report RepoSize and StorageMax.
        schema:
          type: boolean
      - name: human
        in: query
        description: Print sizes in human readable format (e.g., 1K 234M 2G).
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                NumObjects: <uint64>
                RepoPath: <string>
                SizeStat:
                  RepoSize: <uint64>
                  StorageMax: <uint64>
                Version: <string>
      tags:
      - Repo
      summary: Repo/stat
      x-summary-source: derived
  /api/v0/repo/verify:
    post:
      operationId: repo/verify
      description: Verify all blocks in repo are not corrupted.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-verify
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Msg: <string>
                Progress: <int>
      tags:
      - Repo
      summary: Repo/verify
      x-summary-source: derived
  /api/v0/repo/version:
    post:
      operationId: repo/version
      description: Show the repo version.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-version
      parameters:
      - name: quiet
        in: query
        description: Write minimal output.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Version: <string>
      tags:
      - Repo
      summary: Repo/version
      x-summary-source: derived
externalDocs:
  url: https://docs.ipfs.tech/reference/kubo/rpc/