REST API for Oracle Blockchain Platform Enterprise Edition

All REST Endpoints

Application Operations

REST API for administrative operations

Get Version of Blockchain Platform, Hyperledger Fabric and Admin API: Method: get
Path: /console/admin/api/instanceVersion
Get Version of REST Proxy API: Method: get
Path: /restproxy/api/version

Application Operations/Atomic Transactions

Use these operations to query and invoke chaincode transactions spanning multiple channels which are committed atomically.

Invoke Atomic Transaction: Method: post
Path: /restproxy/api/v2/atomicTransactions
Query Atomic Transaction: Method: get
Path: /restproxy/api/v2/atomicTransactions/{globalTransactionId}
Unlock Atomic Transaction: Method: put
Path: /restproxy/api/v2/atomicTransactions/{globalTransactionId}

Application Operations/Audit Log Events

The operations from the Application Operations/Audit Log Events category.

List Audit Log Event Subscriptions: Method: get
Path: /restproxy/api/v2/auditlog/event-subscriptions
Subscribe to an Audit Log Event: Method: post
Path: /restproxy/api/v2/auditlog/event-subscriptions
Unsubscribe from an Audit Log Event: Method: delete
Path: /restproxy/api/v2/auditlog/event-subscriptions

Application Operations/Events

Use these operations to subscribe or unsubscribe to chaincode events.

List Event Subscriptions: Method: get
Path: /restproxy/api/v2/channels/{channelName}/event-subscriptions
Subscribe to an Event: Method: post
Path: /restproxy/api/v2/channels/{channelName}/event-subscriptions
Unsubscribe from an Event: Method: delete
Path: /restproxy/api/v2/channels/{channelName}/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/{channelName}/transaction-id
Get Response of Asynchronous Transaction: Method: get
Path: /restproxy/api/v2/channels/{channelName}/transactions/async/{trackingID}
Get Transaction Information: Method: get
Path: /restproxy/api/v2/channels/{channelName}/transactions/{transactionId}
Query a Chaincode: Method: post
Path: /restproxy/api/v2/channels/{channelName}/chaincode-queries
Send a Transaction: Method: post
Path: /restproxy/api/v2/channels/{channelName}/transactions
Send an Asynchronous Transaction: Method: post
Path: /restproxy/api/v2/channels/{channelName}/transactions/async

Blockchain Network Administrative Operations/Chaincode

REST API for chaincode operations

Delete Installed Chaincode Package: Method: delete
Path: /console/admin/api/v2/chaincodes/{packageID}
Get Chaincode Package from Peer: Method: get
Path: /console/admin/api/v2/chaincodes/{packageID}
Get Installed Chaincode List: Method: get
Path: /console/admin/api/v2/chaincodes
Install a Chaincode: Method: post
Path: /console/admin/api/v2/chaincodes

Blockchain Network Administrative Operations/Channel

REST API for channel operations

Add an OSN to a Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/orderers/joinOSN
Add an OSN to the System Channel: Method: post
Path: /console/admin/api/v2/channels/syschannel/addOSN
Add Organization to Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/organizations
Approve Chaincode Definition in Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/approve
Check Commit Readiness: Method: post
Path: /console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/checkCommitReadiness
Commit Chaincode Definition in a Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/commit
Create a Channel: Method: post
Path: /console/admin/api/v2/channels
Get a List of Block's Data: Method: get
Path: /console/admin/api/v2/channels/{channelName}/blocks
Get Channel Block Data: Method: get
Path: /console/admin/api/v2/channels/{channelName}/blocks/{blockId}
Get Channel Information: Method: get
Path: /console/admin/api/v2/channels/{channelName}
Get Channel List: Method: get
Path: /console/admin/api/v2/channels
Get Orderer Attributes for Channel: Method: get
Path: /console/admin/api/v2/channels/{channelName}/orderingSettings
Get the System Channel's Configuration Block: Method: get
Path: /console/admin/api/v2/channels/syschannel/configblock
Query Chaincode Definition in a Channel: Method: get
Path: /console/admin/api/v2/channels/{channelName}/chaincodeDefinitions
Remove an OSN from a Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/orderers/removeOSN
Remove Organization from Channel: Method: delete
Path: /console/admin/api/v2/channels/{channelName}/organizations/{mspId}
Set Anchor Peers for Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/organizations/{mspId}/anchorPeers
Update Orderer Advanced Attributes for a Channel: Method: patch
Path: /console/admin/api/v2/channels/{channelName}/orderingSettings
Update Policies of a Channel: Method: post
Path: /console/admin/api/v2/channels/{channelName}/policies

Blockchain Network Administrative Operations/Nodes

REST API for nodes operations

Associate REST Client User With a Custom Enrollment: Method: post
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}/users
Create Custom Enrollment for REST Proxy: Method: post
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments
Delete Custom Enrollment for REST Proxy: Method: delete
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}
Get Configuration of a CA Node: Method: get
Path: /console/admin/api/v2/nodes/fabricCAs/{caId}/
Get List of REST Client Users Associated with the Custom Enrollment: Method: get
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}/users
Get Node List: Method: get
Path: /console/admin/api/v2/nodes
Get Orderer Information: Method: get
Path: /console/admin/api/v2/nodes/orderers/{ordererId}/exportOSN
Get Orderer Node Configuration: Method: get
Path: /console/admin/api/v2/nodes/orderers/{ordererId}
Get Peer Attributes: Method: get
Path: /console/admin/api/v2/nodes/peers/{peerId}
Get Peer List: Method: get
Path: /console/admin/api/v2/nodes/peers
Get REST Proxy Node Configuration: Method: get
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}
Import Configuration Block to Orderer: Method: post
Path: /console/admin/api/v2/nodes/orderers/{ordererId}/importNCB
Join a Peer to a Channel: Method: post
Path: /console/admin/api/v2/nodes/peers/{peerId}/joinChannel
List Custom Enrollments for REST Proxy: Method: get
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments
Remove Association Between REST Client User and a Custom Enrollment: Method: delete
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}/users/{userName}
Start a CA Node: Method: post
Path: /console/admin/api/v2/nodes/fabricCAs/{caId}/start
Start a REST Proxy Node: Method: post
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/start
Start an Orderer Node: Method: post
Path: /console/admin/api/v2/nodes/orderers/{ordererId}/start
Start Peer Node: Method: post
Path: /console/admin/api/v2/nodes/peers/{peerId}/start
Stop a CA Node: Method: post
Path: /console/admin/api/v2/nodes/fabricCAs/{caId}/stop
Stop a REST Proxy Node: Method: post
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}/stop
Stop an Orderer Node: Method: post
Path: /console/admin/api/v2/nodes/orderers/{ordererId}/stop
Stop Peer Node: Method: post
Path: /console/admin/api/v2/nodes/peers/{peerId}/stop
Update CA Node Configuration: Method: patch
Path: /console/admin/api/v2/nodes/fabricCAs/{caId}/
Update Orderer Node Configuration: Method: patch
Path: /console/admin/api/v2/nodes/orderers/{ordererId}
Update Peer Node Configuration: Method: patch
Path: /console/admin/api/v2/nodes/peers/{peerId}
Update REST Proxy Node Configuration: Method: patch
Path: /console/admin/api/v2/nodes/restproxies/{restProxyId}
Verify Blocks: Method: get
Path: /console/admin/api/v2/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/v2/organizations/{orgName}/joinNewOrgs
Download Connection Profile: Method: get
Path: /console/admin/api/v2/organizations/{orgName}/connectionProfile/{zip}
Get All Organizations: Method: get
Path: /console/admin/api/v2/organizations
Get Orderer Service Settings: Method: get
Path: /console/admin/api/v2/organizations/{orgName}/orderingService
Get Organization Admin Credentials: Method: get
Path: /console/admin/api/v2/organizations/{orgName}/adminCredentials
Get Organization Certificates: Method: get
Path: /console/admin/api/v2/organizations/{orgName}/certificates
Set Orderer Service for an Organization: Method: post
Path: /console/admin/api/v2/organizations/{orgName}/setOrderingService

Blockchain Platform Administrative Operations/Configuration

Use these operations to work with platform configurations.

Add User to Default LDAP Server: Method: post
Path: /api/v1/configuration/ldapConfig/defaultLdap/ldapUser
Create or Update Control Plane Configuration: Method: post
Path: /api/v1/configuration/cpConfig/list
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 Post Login Configuration Details: Method: post
Path: /api/v1/configuration/auth
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 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.

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 Instance Activity Details: Method: get
Path: /api/v1/blockchainPlatforms/instances/{id}/activity
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
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

Statistics

REST API for statistics operations

Get Audit Log Information: Method: get
Path: /console/admin/api/v2/dashboard/statistics/auditlog
Get Current Channels and Peers Joined on Each Channel: Method: get
Path: /console/admin/api/v2/dashboard/statistics/channelInfo
Get Current Number and List of Channels Joined by the Specified Peer: Method: get
Path: /console/admin/api/v2/dashboard/statistics/channelsJoined
Get Node Health Status: Method: get
Path: /console/admin/api/v2/dashboard/statistics/nodeHealth
Get the Native Fabric Metrics for Peer or Orderer: Method: get
Path: /console/admin/api/v2/dashboard/statistics/metrics
Get the Number of Asynchronous Invocations: Method: get
Path: /console/admin/api/v2/dashboard/statistics/proxyAsyncInvocation
Get the Number of Blocks: Method: get
Path: /console/admin/api/v2/dashboard/statistics/blocks
Get the Number of Commits: Method: get
Path: /console/admin/api/v2/dashboard/statistics/commits
Get the Number of Endorsements: Method: get
Path: /console/admin/api/v2/dashboard/statistics/endorsements
Get the Number of Synchronous Invocations: Method: get
Path: /console/admin/api/v2/dashboard/statistics/proxySyncInvocation
Get the Number of User Transactions for Peer, Channel, or Network: Method: get
Path: /console/admin/api/v2/dashboard/statistics/userTrans