Blockchain Platform Manager APIs

All REST Endpoints

Blockchain Platform Administrative Operations/Authentication

Use these operations to work with OIDC authentication.

Get Active OIDC Provider Name: Method: get
Path: /api/v1/auth/provider/active

Blockchain Platform Administrative Operations/Besu

Use these operations to administer Oracle Blockchain Platform Besu instances.

Create a new Besu Instance: Method: post
Path: /api/v1/besu/instance
Delete a Besu Instance: Method: delete
Path: /api/v1/besu/instance/{id}
Export Besu Genesis Metadata: Method: get
Path: /api/v1/besu/instance/{id}/export-genesis-metadata
Generate Unique Besu Instance Identifier: Method: get
Path: /api/v1/besu/instance/getUniqueId
Get All Activity Details: Method: get
Path: /api/v1/blockchainPlatforms/activities
Get Besu Client Credentials: Method: get
Path: /api/v1/besu/instance/{id}/client-credentials
Get Besu Instance Activity Details: Method: get
Path: /api/v1/besu/instance/{id}/activity
Get Besu Instance Details: Method: get
Path: /api/v1/besu/instance/{id}
Get Besu Instance Status: Method: get
Path: /api/v1/besu/instance/{id}/status
Get the Operation Status of a Besu Instance: Method: get
Path: /api/v1/besu/instance/{id}/operation/{opid}/status
List Besu Instances: Method: get
Path: /api/v1/besu/instance
Scale in a Besu Instance: Method: post
Path: /api/v1/besu/instance/{id}/scalein
Scale out a Besu Instance: Method: post
Path: /api/v1/besu/instance/{id}/scaleout
Start a Besu Instance: Method: post
Path: /api/v1/besu/instance/{id}/action/start
Stop a Besu Instance: Method: post
Path: /api/v1/besu/instance/{id}/action/stop

Blockchain Platform Administrative Operations/Configuration

Use these operations to configure your platform.

Add a User to the Default LDAP Server: Method: post
Path: /api/v1/configuration/ldapConfig/defaultLdap/ldapUser
Change the Default LDAP Password: Method: post
Path: /api/v1/configuration/ldapConfig/defaultPassword
Create OIDC Provider Configuration: Method: post
Path: /api/v1/configuration/oidcProviderConfig
Create or Update Multiple Control Plane Configurations: Method: post
Path: /api/v1/configuration/cpConfig/list
Delete OIDC Provider Configuration: Method: delete
Path: /api/v1/configuration/oidcProviderConfig/{id}
Delete the Control Plane Configuration: Method: delete
Path: /api/v1/configuration/cpConfig/{configName}
Get Available Configurations for Control Plane: Method: get
Path: /api/v1/configuration/cpConfig
Get Post Login Configuration Details: Method: post
Path: /api/v1/configuration/auth
Get the Control Plane Configuration: Method: get
Path: /api/v1/configuration/cpConfig/{configName}
Get the Default LDAP Configuration: Method: get
Path: /api/v1/configuration/ldapConfig
Get the Default LDAP Configuration by ID: Method: get
Path: /api/v1/configuration/ldapConfig/{id}
Get the Release Build Information: Method: get
Path: /api/v1/configuration/release/buildInfo
List OIDC Provider Configurations: Method: get
Path: /api/v1/configuration/oidcProviderConfig
Save or Update a Control Plane Configuration: Method: post
Path: /api/v1/configuration/cpConfig
Set OIDC Provider Configuration Active: Method: post
Path: /api/v1/configuration/oidcProviderConfig/active
Test the Given LDAP Configuration: Method: post
Path: /api/v1/configuration/ldapConfig/test
Update OIDC Provider Configuration: Method: post
Path: /api/v1/configuration/oidcProviderConfig/{id}
Update the Default LDAP Configuration by ID: Method: put
Path: /api/v1/configuration/ldapConfig/{id}

Blockchain Platform Administrative Operations/Rich History

Use these operations to work with the rich history database.

Create Rich History Configuration: Method: post
Path: /api/v1/configuration/richHistoryConfig
Create Rich History Configuration with Wallet Package: Method: post
Path: /api/v1/configuration/richHistoryConfig/multipart
Delete Rich History Configuration: Method: delete
Path: /api/v1/configuration/richHistoryConfig/{id}
Get Rich History Configuration: Method: get
Path: /api/v1/configuration/richHistoryConfig/{id}
List Rich History Configurations: Method: get
Path: /api/v1/configuration/richHistoryConfig
Update Rich History Configuration: Method: post
Path: /api/v1/configuration/richHistoryConfig/{id}
Update Rich History Configuration with Wallet Package: Method: post
Path: /api/v1/configuration/richHistoryConfig/{id}/multipart