All REST Endpoints

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
Administrative Operations/Channel
REST API for channel operations
Add an organization to a channel (New in v19.1.3)
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/organizations
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 (new in v19.2.1)
Method: get
Path: /console/admin/api/v1.1/channels/{channelName}/orderingSettings
Remove an organization from a channel (New in v19.1.3)
Method: delete
Path: /console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}
Set Anchor Peers for a Channel
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}/anchorPeers
Update Capabilities for Channel (new in v19.2.1)
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/capabilities
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 (new in v19.2.1)
Method: patch
Path: /console/admin/api/v1.1/channels/{channelName}/orderingSettings
Update Policies of a Channel (new in v19.2.1)
Method: post
Path: /console/admin/api/v1.1/channels/{channelName}/policies
Administrative Operations/Nodes
REST API for nodes operations
Add a Peer Node
Method: post
Path: /console/admin/api/v1.1/nodes/peers
Download Node Logs for a Time Range (new in v19.2.1)
Method: get
Path: /console/admin/api/v1.1/nodes/log
Export Nodes
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 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 Nodes
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
Remove a Peer Node
Method: delete
Path: /console/admin/api/v1.1/nodes/peers/{peerId}
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}
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 (new in v19.2.1)
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
Application Operations/Events
Use these operations to subscribe or unsubscribe to chaincode events.
Event Subscribe
Method: post
Path: /{restproxy}/bcsgw/rest/v1/event/subscribe
Event Unsubscribe
Method: post
Path: /{restproxy}/bcsgw/rest/v1/event/unsubscribe
Query Subscribe List
Method: get
Path: /{restproxy}/bcsgw/rest/v1/event/querySub
Application Operations/Transactions
Use these operations to query and invoke chaincode transactions.
Get a Transaction ID
Method: get
Path: /{restproxy}/bcsgw/rest/v1/transaction/getTxID
Invoke a Method (Asynchronous)
Method: post
Path: /{restproxy}/bcsgw/rest/v1/transaction/asyncInvocation
Invoke a Method (Synchronous)
Method: post
Path: /{restproxy}/bcsgw/rest/v1/transaction/invocation
Invoke a Query
Method: post
Path: /{restproxy}/bcsgw/rest/v1/transaction/query
View Status for Multiple Transactions (Deprecated in 19.2.1)
Method: post
Path: /{restproxy}/bcsgw/rest/v1/transaction/waitStatus
View the Status of a Specified Transaction
Method: get
Path: /{restproxy}/bcsgw/rest/v1/transaction
Application Operations/Versions
Use these operations to query Oracle Blockchain Platform Gateway versions.
View Version
Method: get
Path: /{restproxy}/bcsgw/rest/version
Statistics
REST API for statistics operations (new in v19.1.3)
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
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
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