Bigchaindb Root API

openapi: 3.0.3
info:
  title: BigchainDB HTTP Assets Root API
  version: v1
  description: The BigchainDB HTTP Client-Server API. BigchainDB is an open-source blockchain database that combines high throughput, low latency, immutable data storage and built-in asset support with decentralized control. This document is a faithful transcription of the operations, parameters and status codes published in the official BigchainDB Server HTTP API reference; BigchainDB does not publish its own machine-readable OpenAPI, so this spec was generated by the API Evangelist enrichment pipeline from the documented endpoint reference.
  x-apievangelist-generated: true
  x-source: https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: BigchainDB GmbH
    url: https://www.bigchaindb.com/
servers:
- url: https://{host}:9984
  description: A BigchainDB node (self-hosted or hosted network). Default node port is 9984.
  variables:
    host:
      default: test.ipdb.io
      description: Hostname of a BigchainDB node (the IPDB test network historically ran at test.ipdb.io).
tags:
- name: Root
  description: Node discovery endpoints.
paths:
  /:
    get:
      tags:
      - Root
      operationId: getApiRoot
      summary: Discover node version and API endpoints
      description: Returns the BigchainDB node software version and the set of available API endpoint URLs.
      responses:
        '200':
          description: Node information and endpoint map.
  /api/v1/:
    get:
      tags:
      - Root
      operationId: getApiV1Root
      summary: List available API v1 resources
      description: Returns the list of available resource endpoints under the v1 API.
      responses:
        '200':
          description: Map of available v1 resource URLs.
externalDocs:
  description: BigchainDB Server HTTP Client-Server API
  url: https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html