Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Authentication
• Status Codes
• cURL Access
• Querying Hyperledger Fabric Metrics APIs
• New, Changed and Deprecated APIs

Tasks

• Application Operations
  • Get Version of REST Proxy API
  • Events
    • List Event Subscriptions
    • Subscribe to an Event
    • Unsubscribe from an Event
  • Transactions
    • Get a New Transaction ID and Nonce
    • Get Transaction Information
    • Query a Chaincode
    • Send a Transaction
• Blockchain Network Administrative Operations
  • Chaincode
    • Get Chaincode Information
    • Get Installed Chaincode List
    • Install a Chaincode
    • Instantiate a Chaincode
  • Channel
    • Add an organization to a channel
    • Add an OSN to a Channel
    • Add an OSN to the System Channel
    • Create a Channel
    • Get a List of Block's Data
    • Get Channel Block Data
    • Get Channel Information
    • Get Channel List
    • Get Orderer Advanced Attributes for a Channel
    • Get the System Channel's Configuration Block
    • Remove an organization from a channel
    • Remove an OSN from a Channel
    • Set Anchor Peers for a Channel
    • Update Channel Configuration (Deprecated in v19.1.3)
    • Update Orderer Advanced Attributes for a Channel
    • Update Policies of a Channel
  • Nodes
    • Export Nodes (Deprecated in 21.1.2)
    • Get Configuration of a CA Node
    • Get Node List
    • Get Orderer information
    • Get Orderer Node Configuration
    • Get Peer Attributes
    • Get Peer List
    • Get REST Proxy Node Configuration
    • Import Configuration Block to Orderer
    • Import Nodes (Deprecated in 21.1.2)
    • Join a Peer to a Channel
    • Start a CA Node
    • Start a Peer Node
    • Start a REST Proxy Node
    • Start an Orderer Node
    • Stop a CA Node
    • Stop a Peer
    • Stop a REST Proxy Node
    • Stop an Orderer Node
    • Update CA Node Configuration
    • Update Orderer Node Configuration
    • Update Peer Node Configuration
    • Update REST Proxy Node Configuration
    • Verify Blocks
  • Organizations
    • Add Organization to Network
    • Download Connection Profile
    • Get All Organizations
    • Get Orderer Service Settings
    • Get Organization Admin Credentials
    • Get Organization Certificates
    • Set Orderer Service for an Organization
• Blockchain Platform Administrative Operations
  • Configuration
    • Create LDAP Configuration
    • Create or Update Control Plane Configuration
    • Delete Control Plane Configuration
    • Delete LDAP Configuration
    • Get All Configurations for Control Plane
    • Get Control Plane Configuration
    • Get LDAP Configuration
    • Get Release Build Information
    • List LDAP Configurations
    • Save or Update a Control Plane Configuration
    • Test LDAP Configuration
    • Update LDAP Configuration
  • Platform
    • Apply Patch to Target Instances
    • Create New Blockchain Platform Instance
    • Delete a Blockchain Platform Instance
    • Get All Activity Details
    • Get Blockchain Platform Instance Details
    • Get Blockchain Platform Status
    • Get External Load Balancer Port Mapping
    • Get Instance Activity Details
    • Get Instance Patch Details
    • Get Load Balancer Port Mapping for Instance Creation
    • Get Load Balancer Port Mapping for Scaleout
    • Get Operation Status of an Instance
    • List Blockchain Platform Instances
    • List Blockchain Platform Patch Targets
    • List Blockchain Platform Patches
    • Patch a Blockchain Platform Instance
    • Register a New Blockchain Platform Patch
    • Rollback Patch on a Blockchain Platform Instance
    • Scale In a Blockchain Platform Instance
    • Scale Out a Blockchain Platform Instance
    • Start a Blockchain Platform Instance
    • Stop a Blockchain Platform Instance
    • Test HSM Connectivity
    • Update a Blockchain Platform Instance
• Statistics
  • Get Current Channels and Peers Joined on Each Channel
  • Get Current Number and List of Channels Joined by the Specified Peer
  • Get the Current Number and List of Installed Chaincodes on the Specified Peer
  • Get the Current Number of Instantiated Chaincodes on the Specified Channel
  • Get the Native Fabric Metrics for Peer or Orderer
  • Get the Node Health Status
  • Get the Number of Asynchronous Invocations
  • Get the Number of Billable Transactions
  • Get the Number of Blocks
  • Get the Number of Commits
  • Get the Number of Endorsements
  • Get the Number of Synchronous Invocations
  • Get the Number of User Transactions for Peer, Channel, or Network