All REST Endpoints

Application Operations
REST API for administrative operations
Get Version of REST Proxy API
Method: get
Path: /restproxy/api/version
Application Operations/Events
Use these operations to subscribe or unsubscribe to chaincode events.
List Event Subscriptions
Method: get
Path: /restproxy/api/v2/channels/{channelId}/event-subscriptions
Subscribe to an Event
Method: post
Path: /restproxy/api/v2/channels/{channelId}/event-subscriptions
Unsubscribe from an Event
Method: delete
Path: /restproxy/api/v2/channels/{channelId}/event-subscriptions
Application Operations/Transactions
Use these operations to query and invoke chaincode transactions.
Get a New Transaction ID and Nonce
Method: get
Path: /restproxy/api/v2/channels/{channelId}/transaction-id
Get Transaction Information
Method: get
Path: /restproxy/api/v2/channels/{channelId}/transactions/{transactionId}
Query a Chaincode
Method: post
Path: /restproxy/api/v2/channels/{channelId}/chaincode-queries
Send a Transaction
Method: post
Path: /restproxy/api/v2/channels/{channelId}/transactions
Blockchain Network Administrative Operations/Chaincode
REST API for chaincode operations
Get Chaincode Information
Method: get
Path: /console/admin/api/v1.1/chaincodes/{chaincodeName}
Get Installed Chaincode List
Method: get
Path: /console/admin/api/v1.1/chaincodes
Install a Chaincode
Method: post
Path: /console/admin/api/v1.1/chaincodes
Instantiate a Chaincode
Method: post
Path: /console/admin/api/v1.1/chaincodes/{chaincodeName}/instantiate
Blockchain Network Administrative Operations/Channel
REST API for channel operations
Add an organization to a channel
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/organizations
Add an OSN to a Channel
Method: post
Path: /console/admin/api/v1.1/console/admin/api/v1.1/channels/{channelName}/orderers/joinOSN
Add an OSN to the System Channel
Method: post
Path: /console/admin/api/v1.1/console/admin/api/v1.1/channels/syschannel/addOSN
Create a Channel
Method: post
Path: /console/admin/api/v1.1/channels
Get a List of Block's Data
Method: get
Path: /console/admin/api/v1.1/channels/{channelName}/blocks
Get Channel Block Data
Method: get
Path: /console/admin/api/v1.1/channels/{channelName}/blocks/{blockId}
Get Channel Information
Method: get
Path: /console/admin/api/v1.1/channels/{channelName}
Get Channel List
Method: get
Path: /console/admin/api/v1.1/channels
Get Orderer Advanced Attributes for a Channel
Method: get
Path: /console/admin/api/v1.1/channels/{channelName}/orderingSettings
Get the System Channel's Configuration Block
Method: get
Path: /console/admin/api/v1.1/console/admin/api/v1.1/channels/syschannel/configblock
Remove an organization from a channel
Method: delete
Path: /console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}
Remove an OSN from a Channel
Method: post
Path: /console/admin/api/v1.1/console/admin/api/v1.1/channels/{channelName}/orderers/removeOSN
Set Anchor Peers for a Channel
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}/anchorPeers
Update Channel Configuration (Deprecated in v19.1.3)
Method: patch
Path: /console/admin/api/v1.1/channels/{channelName}
Update Orderer Advanced Attributes for a Channel
Method: patch
Path: /console/admin/api/v1.1/channels/{channelName}/orderingSettings
Update Policies of a Channel
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/policies
Blockchain Network Administrative Operations/Nodes
REST API for nodes operations
Download Node Logs for a Time Range
Method: get
Path: /console/admin/api/v1.1/nodes/log
Export Nodes (Deprecated in 20.3.1)
Method: get
Path: /console/admin/api/v1.1/nodes/export
Get Configuration of a CA Node
Method: get
Path: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/
Get Node List
Method: get
Path: /console/admin/api/v1.1/nodes
Get Orderer information
Method: get
Path: /console/admin/api/v1.1/console/admin/api/v1.1/nodes/orderers/{ordererId}/exportOSN
Get Orderer Node Configuration
Method: get
Path: /console/admin/api/v1.1/nodes/orderers/{ordererId}
Get Peer Attributes
Method: get
Path: /console/admin/api/v1.1/nodes/peers/{peerId}
Get Peer List
Method: get
Path: /console/admin/api/v1.1/nodes/peers
Get REST Proxy Node Configuration
Method: get
Path: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}
Import Configuration Block to Orderer
Method: post
Path: /console/admin/api/v1.1/console/admin/api/v1.1/nodes/orderers/{ordererId}/importNCB
Import Nodes (Deprecated in 20.3.1)
Method: post
Path: /console/admin/api/v1.1/nodes/import
Join a Peer to a Channel
Method: post
Path: /console/admin/api/v1.1/nodes/peers/{peerId}/joinChannel
Start a CA Node
Method: post
Path: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/start
Start a Peer Node
Method: post
Path: /console/admin/api/v1.1/nodes/peers/{peerId}/start
Start a REST Proxy Node
Method: post
Path: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}/start
Start an Orderer Node
Method: post
Path: /console/admin/api/v1.1/nodes/orderers/{ordererId}/start
Stop a CA Node
Method: post
Path: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/stop
Stop a Peer
Method: post
Path: /console/admin/api/v1.1/console/admin/api/v1.1/nodes/peers/{peerId}/stop
Stop a REST Proxy Node
Method: post
Path: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}/stop
Stop an Orderer Node
Method: post
Path: /console/admin/api/v1.1/nodes/orderers/{ordererId}/stop
Update CA Node Configuration
Method: patch
Path: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/
Update Orderer Node Configuration
Method: patch
Path: /console/admin/api/v1.1/nodes/orderers/{ordererId}
Update Peer Node Configuration
Method: patch
Path: /console/admin/api/v1.1/nodes/peers/{peerId}
Update REST Proxy Node Configuration
Method: patch
Path: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}
Blockchain Network Administrative Operations/Organizations
REST API for organizations operations
Add Organization to Network
Method: post
Path: /console/admin/api/v1.1/organizations/{orgName}/joinNewOrgs
Download Connection Profile
Method: get
Path: /console/admin/api/v1.1/console/admin/api/v1.1/organizations/{orgName}/connectionProfile/{zip}
Get All Organizations
Method: get
Path: /console/admin/api/v1.1/organizations
Get Orderer Service Settings
Method: get
Path: /console/admin/api/v1.1/organizations/{orgName}/orderingService
Get Organization Admin Credentials
Method: get
Path: /console/admin/api/v1.1/organizations/{orgName}/adminCredentials
Get Organization Certificates
Method: get
Path: /console/admin/api/v1.1/organizations/{orgName}/certificates
Set Orderer Service for an Organization
Method: post
Path: /console/admin/api/v1.1/organizations/{orgName}/setOrderingService
Blockchain Platform Administrative Operations
The operations from the Blockchain Platform Administrative Operations category.
Change Blockchain Platform Compartment
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/actions/changeCompartment
Create Blockchain Platform OSN
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/osns
Create Blockchain Platform Peer
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/peers
Create New Blockchain Platform
Method: post
Path: /20191010/blockchainPlatforms
Delete Blockchain Platform
Method: delete
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}
Delete Blockchain Platform OSN
Method: delete
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/osns/{osnId}
Delete Blockchain Platform Peer
Method: delete
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/peers/{peerId}
Delete Work Request
Method: delete
Path: /20191010/workRequests/{workRequestId}
Get Blockchain Platform By Hostname
Method: get
Path: /20191010/blockchainPlatforms/hostnames/{hostname}
Get Blockchain Platform Information
Method: get
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}
Get Blockchain Platform Metadata
Method: get
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/metadata/{paramName}
Get Blockchain Platform OSN
Method: get
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/osns/{osnId}
Get Blockchain Platform Peer
Method: get
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/peers/{peerId}
Get Work Request Status
Method: get
Path: /20191010/workRequests/{workRequestId}
List Blockchain Platform OSNs
Method: get
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/osns
List Blockchain Platform Peers
Method: get
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/peers
List Blockchain Platforms
Method: get
Path: /20191010/blockchainPlatforms
List Work Request Logs
Method: get
Path: /20191010/workRequests/{workRequestId}/logs
List Work Requests
Method: get
Path: /20191010/workRequests
Lists Work Request Errors
Method: get
Path: /20191010/workRequests/{workRequestId}/errors
Preview Scale Blockchain Platform
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/actions/scale/preview
Scale Blockchain Platform
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/actions/scale
Start a Blockchain Platform
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/actions/start
Stop Blockchain Platform
Method: post
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/actions/stop
Update Blockchain Platform
Method: put
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}
Update Blockchain Platform OSN
Method: put
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/osns/{osnId}
Update Blockchain Platform Peer
Method: put
Path: /20191010/blockchainPlatforms/{blockchainPlatformId}/peers/{peerId}
Statistics
REST API for statistics operations
Get Current Channels and Peers Joined on Each Channel
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/channelInfo
Get Current Number and List of Channels Joined by the Specified Peer
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/channelsJoined
Get the Current Number and List of Installed Chaincodes on the Specified Peer
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/chaincodeInstalled
Get the Current Number of Instantiated Chaincodes on the Specified Channel
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/chaincodeInstantiated
Get the List of Configured Chaincodes (Deprecated in 20.3.1)
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/proxyConfiguredCC
Get the Native Fabric Metrics for Peer or Orderer
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/metrics
Get the Node Health Status
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/nodeHealth
Get the Node Usage Related Metrics (Deprecated in 20.3.1)
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/nodeRes
Get the Number of Asynchronous Invocations
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/proxyAsyncInvocation
Get the Number of Billable Transactions
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/billableTrans
Get the Number of Blocks
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/blocks
Get the Number of Commits
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/commits
Get the Number of Endorsements
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/endorsements
Get the Number of Synchronous Invocations
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/proxySyncInvocation
Get the Number of User Transactions for Peer, Channel, or Network
Method: get
Path: /console/admin/api/v1.1/dashboard/statistics/userTrans