REST API for Oracle Blockchain Platform Enterprise Edition

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
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
Remove an organization from a channel: 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 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

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
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}
Verify Blocks: Method: get
Path: /console/admin/api/v1.1/nodes/peers/{peerId}/blockaudit/{channelName}

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/Configuration

Use these operations to work with platform configurations.

Create LDAP Configuration: Method: post
Path: /api/v1/configuration/ldapConfig
Create or Update Control Plane Configuration: Method: post
Path: /api/v1/configuration/cpConfig/list
Delete Control Plane Configuration: Method: delete
Path: /api/v1/configuration/cpConfig/{configName}
Delete LDAP Configuration: Method: delete
Path: /api/v1/configuration/ldapConfig/{id}
Get All Configurations for Control Plane: Method: get
Path: /api/v1/configuration/cpConfig
Get Control Plane Configuration: Method: get
Path: /api/v1/configuration/cpConfig/{configName}
Get LDAP Configuration: Method: get
Path: /api/v1/configuration/ldapConfig/{id}
Get Release Build Information: Method: get
Path: /api/v1/configuration/release/buildInfo
List LDAP Configurations: Method: get
Path: /api/v1/configuration/ldapConfig
Save or Update a Control Plane Configuration: Method: post
Path: /api/v1/configuration/cpConfig
Test LDAP Configuration: Method: post
Path: /api/v1/configuration/ldapConfig/test
Update LDAP Configuration: Method: post
Path: /api/v1/configuration/ldapConfig/{id}

Blockchain Platform Administrative Operations/Platform

Use these operations to administer Oracle Blockchain Platform.

Apply Patch to Target Instances: Method: post
Path: /api/v1/blockchainPlatforms/patches/{patchId}/apply
Create New Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances
Delete a Blockchain Platform Instance: Method: delete
Path: /api/v1/blockchainPlatforms/instances/{id}
Get All Activity Details: Method: get
Path: /api/v1/blockchainPlatforms/activities
Get Blockchain Platform Instance Details: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}
Get Blockchain Platform Status: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}/status
Get External Load Balancer Port Mapping: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}/lbrportmapping
Get Instance Activity Details: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}/activity
Get Instance Patch Details: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}/patch
Get Operation Status of an Instance: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}/operation/{opid}/status
List Blockchain Platform Instances: Method: get
Path: /api/v1/blockchainPlatforms/instances
List Blockchain Platform Patch Targets: Method: get
Path: /api/v1/blockchainPlatforms/patches/{patchId}/targets
List Blockchain Platform Patches: Method: get
Path: /api/v1/blockchainPlatforms/patches
Patch a Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances/{id}/patch
Register a New Blockchain Platform Patch: Method: post
Path: /api/v1/blockchainPlatforms/patches
Rollback Patch on a Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances/{id}/rollback
Scale In a Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances/{id}/scalein
Scale Out a Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances/{id}/scaleout
Start a Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances/{id}/action/start
Stop a Blockchain Platform Instance: Method: post
Path: /api/v1/blockchainPlatforms/instances/{id}/action/stop
Update a Blockchain Platform Instance: Method: put
Path: /api/v1/blockchainPlatforms/instances/{id}

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: 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