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 Blockchain Platform, Hyperledger Fabric and Admin API
  • Get Version of REST Proxy API
  • Atomic Transactions
    • Invoke Atomic Transaction
    • Query Atomic Transaction
    • Unlock Atomic Transaction
  • Audit Log Events
    • List Audit Log Event Subscriptions
    • Subscribe to an Audit Log Event
    • Unsubscribe from an Audit Log Event
  • Events
    • List Event Subscriptions
    • Subscribe to an Event
    • Unsubscribe from an Event
  • Transactions
    • Get a New Transaction ID and Nonce
    • Get Response of Asynchronous Transaction
    • Get Transaction Information
    • Query a Chaincode
    • Send a Transaction
    • Send an Asynchronous Transaction
• Blockchain Network Administrative Operations
  • Chaincode
    • Delete Installed Chaincode Package
    • Get Chaincode Package from Peer
    • Get Installed Chaincode List
    • Install a Chaincode
  • Channel
    • Add an OSN to a Channel
    • Add an OSN to the System Channel
    • Add Organization to Channel
    • Approve Chaincode Definition in Channel
    • Check Commit Readiness
    • Commit Chaincode Definition in a Channel
    • Create a Channel
    • Get a List of Block's Data
    • Get Channel Block Data
    • Get Channel Information
    • Get Channel List
    • Get Orderer Attributes for Channel
    • Get the System Channel's Configuration Block
    • Query Chaincode Definition in a Channel
    • Remove an OSN from a Channel
    • Remove Organization from Channel
    • Set Anchor Peers for Channel
    • Update Orderer Advanced Attributes for a Channel
    • Update Policies of a Channel
  • Nodes
    • Associate REST Client User With a Custom Enrollment
    • Create Custom Enrollment for REST Proxy
    • Delete Custom Enrollment for REST Proxy
    • Get Configuration of a CA Node
    • Get List of REST Client Users Associated with the Custom Enrollment
    • 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
    • Join a Peer to a Channel
    • List Custom Enrollments for REST Proxy
    • Remove Association Between REST Client User and a Custom Enrollment
    • Start a CA Node
    • Start a REST Proxy Node
    • Start an Orderer Node
    • Start Peer Node
    • Stop a CA Node
    • Stop a REST Proxy Node
    • Stop an Orderer Node
    • Stop Peer 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
    • Add User to Default LDAP Server
    • Create or Update Control Plane Configuration
    • Get All Configurations for Control Plane
    • Get Control Plane Configuration
    • Get LDAP Configuration
    • Get Post Login Configuration Details
    • Get Release Build Information
    • List LDAP Configurations
    • Save or Update Control Plane Configuration
    • Test LDAP Configuration
    • Update LDAP Configuration
  • Platform
    • Create New Blockchain Platform Instance
    • Delete a Blockchain Platform Instance
    • Get All Activity Details
    • Get Blockchain Platform Instance Details
    • Get Blockchain Platform Status
    • Get Instance Activity Details
    • Get Operation Status of an Instance
    • List Blockchain Platform Instances
    • Scale In a Blockchain Platform Instance
    • Scale Out a Blockchain Platform Instance
    • Start a Blockchain Platform Instance
    • Stop a Blockchain Platform Instance
• Statistics
  • Get Audit Log Information
  • Get Current Channels and Peers Joined on Each Channel
  • Get Current Number and List of Channels Joined by the Specified Peer
  • Get Node Health Status
  • Get the Native Fabric Metrics for Peer or Orderer
  • Get the Number of Asynchronous Invocations
  • 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