IPFS Id API

openapi: 3.0.0
info:
  title: IPFS RPC Add Id 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: Id
paths:
  /api/v0/id:
    post:
      operationId: id
      description: Show IPFS node id info.
      externalDocs:
        url: https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-id
      parameters:
      - name: arg
        in: query
        description: Peer.ID of node to look up.
        schema:
          type: string
      - name: format
        in: query
        description: Optional output format.
        schema:
          type: string
      - name: peerid-base
        in: query
        description: 'Encoding used for peer IDs: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}.'
        schema:
          type: string
          default: b58mh
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                Addresses:
                - <string>
                AgentVersion: <string>
                ID: <string>
                ProtocolVersion: <string>
                Protocols:
                - <string>
                PublicKey: <string>
      tags:
      - Id
externalDocs:
  url: https://docs.ipfs.tech/reference/kubo/rpc/