IBM Blockchain Platform APIs

This doc lists APIs that you can use to interact with your IBM Blockchain Platform console IBP console

MethodPathSummary
GET/ak/api/v3/components/{id}Get component data
DELETE/ak/api/v3/components/{id}Remove imported component
DELETE/ak/api/v3/kubernetes/components/{id}Delete component
POST/ak/api/v3/kubernetes/components/fabric-caCreate a CA
POST/ak/api/v3/components/fabric-caImport a CA
PUT/ak/api/v3/kubernetes/components/fabric-ca/{id}Update a CA
PUT/ak/api/v3/components/fabric-ca/{id}Edit data about a CA
POST/ak/api/v3/kubernetes/components/fabric-ca/{id}/actionsSubmit action to a CA
POST/ak/api/v3/kubernetes/components/fabric-peerCreate a peer
POST/ak/api/v3/components/fabric-peerImport a peer
PUT/ak/api/v3/components/fabric-peer/{id}Edit data about a peer
POST/ak/api/v3/kubernetes/components/fabric-peer/{id}/actionsSubmit action to a peer
PUT/ak/api/v3/kubernetes/components/fabric-peer/{id}Update a peer
POST/ak/api/v3/kubernetes/components/fabric-ordererCreate an ordering service
POST/ak/api/v3/components/fabric-ordererImport an ordering service
PUT/ak/api/v3/components/fabric-orderer/{id}Edit data about an orderer
POST/ak/api/v3/kubernetes/components/fabric-orderer/{id}/actionsSubmit action to an orderer
PUT/ak/api/v3/kubernetes/components/fabric-orderer/{id}Update an orderer node
PUT/ak/api/v3/kubernetes/components/{id}/configSubmit config block to orderer
POST/ak/api/v3/components/mspImport an MSP
PUT/ak/api/v3/components/msp/{id}Edit an MSP
GET/ak/api/v3/components/msps/{msp_id}Get MSP's public certificates
PUT/ak/api/v3/kubernetes/components/{id}/certsEdit admin certs on a component
GET/ak/api/v3/componentsGet all components
GET/ak/api/v3/components/types/{type}Get components of a type
GET/ak/api/v3/components/tags/{tag}Get components with tag
DELETE/ak/api/v3/components/tags/{tag}Remove components with tag
DELETE/ak/api/v3/kubernetes/components/tags/{tag}Delete components with tag
DELETE/ak/api/v3/kubernetes/components/purgeDelete all components
GET/ak/api/v3/settingsGet public IBP console settings
PUT/ak/api/v3/settingsChange IBP console settings
GET/ak/api/v3/kubernetes/fabric/versionsGet supported Fabric versions
GET/ak/api/v3/healthGet IBP console health stats
GET/ak/api/v3/notificationsGet all notifications
GET/ak/api/v3/signature_collectionsGet signature collection txs
POST/ak/api/v3/signature_collectionsCreate a signature collection tx
PUT/ak/api/v3/signature_collections/{id}Edit a signature collection tx
DELETE/ak/api/v3/signature_collections/{id}Delete a signature collection tx
POST/ak/api/v3/notifications/bulkArchive notifications
POST/ak/api/v3/restartRestart the IBP console
PUT/ak/api/v3/logs/file_settingsChange logging settings
DELETE/ak/api/v3/sessionsDelete all IBP console sessions
DELETE/ak/api/v3/notifications/purgeDelete all notifications
DELETE/ak/api/v3/cacheClear IBP console caches
GET/ak/api/v3/backupsGet backup ids
POST/ak/api/v3/backupsStart a database backup
PUT/ak/api/v3/backupsRestore databases via backup data
PUT/ak/api/v3/backups/{id}Restore databases via backup id
GET/ak/api/v3/backups/{id}Get a database backup
PUT/ak/api/v3/backups/{id}/attachments/{att_name}Attach data to a backup
GET/ak/api/v3/postmanGenerate Postman collection
GET/ak/api/v3/openapiDownload OpenAPI file
POST/ak/api/v3/permissions/keys(Software) - Create an IBP api key
GET/ak/api/v3/permissions/keys(Software) - List IBP api keys
DELETE/ak/api/v3/permissions/keys/{key_id}(Software) - Delete an api key
POST/ak/api/v3/permissions/users(Software) - Add users
DELETE/ak/api/v3/permissions/users(Software) - Delete users
PUT/ak/api/v3/permissions/users(Software) - Edit users
GET/ak/api/v3/permissions/users(Software) - List users
PUT/ak/api/v3/permissions/users/password/reset(Software) - Reset users' passwords