Start a peer node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"startPeers", "parameters":[ { "name":"peerId", "in":"path", "description":"peer ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"action result messages", "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"up", "enum":[ "up" ] } } } }, "400":{ "description":"Invalid Arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Resource Not Found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-start-post" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a Peer", "description":"Stop designated peers.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"stopPeers", "parameters":[ { "name":"peerId", "in":"path", "description":"Peer ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Node status message", "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"down", "enum":[ "down" ] } } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-stop-post" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}/blockaudit/{channelName}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Verify Blocks", "description":"Verifies blocks against a channel owned by the given peer.", "operationId":"getPeerBlockAudit", "produces":[ "application/json" ], "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer", "required":true, "type":"string" }, { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Response with block audit result" }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-blockaudit-{channelName}-get", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-blockaudit-channelname-get" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Peer Attributes", "description":"Get all configuration attributes of a peer.", "operationId":"getPeerAttributes", "produces":[ "application/json" ], "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer being queried", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Peer attributes", "schema":{ "$ref":"#/definitions/peerAttributes" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-get", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update Peer Node Configuration", "description":"Use this endpoint to modify the configuration attributes of a peer.", "operationId":"updatePeerAttributes", "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer being modified", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"Updated peerPatchAttributes object", "required":true, "schema":{ "$ref":"#/definitions/peerPatchAttributes" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "$ref":"#/definitions/peerPatchActionResult" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-patch", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-patch" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}/joinChannel":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Join a Peer to a Channel", "description":"You can add a peer node to a channel so that the node can use it to exchange private transaction information with other peer nodes on the channel.", "operationId":"joinChannel", "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer to join the channel", "required":true, "type":"string" }, { "name":"joinchannelbody", "in":"body", "description":"Channel name", "required":true, "schema":{ "$ref":"#/definitions/joinChannel" } } ], "responses":{ "200":{ "description":"Peer joined channel successfully", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-joinChannel-post", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-joinchannel-post" } }, "/console/admin/api/v1.1/nodes/export":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Export Nodes (Deprecated in 21.1.2)", "description":"Export a node. nodeType specifies a node type list to be exported. nodes specifies an object which points out which nodes to be exported.", "operationId":"exportNodes", "parameters":[ { "name":"nodeType", "in":"query", "description":"Types of nodes to export", "required":true, "type":"string", "default":"[\"peer\"]" }, { "name":"nodes", "in":"query", "description":"Nodes to export", "required":false, "type":"string", "default":"{\"peers\":[\"defaultPeerId\"]}" } ], "responses":{ "200":{ "description":"Nodes exported successfully", "schema":{ "$ref":"#/definitions/exportedNodes" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-export-get", "x-filename-id":"console-admin-api-v1.1-nodes-export-get" } }, "/console/admin/api/v1.1/nodes/import":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Import Nodes (Deprecated in 21.1.2)", "description":"Import a node.", "operationId":"importNodes", "parameters":[ { "name":"nodes", "in":"body", "description":"Nodes to import", "required":true, "schema":{ "$ref":"#/definitions/exportedNodes" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-import-post", "x-filename-id":"console-admin-api-v1.1-nodes-import-post" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start an Orderer Node", "description":"Start an orderer node. This should be done after any changes are made to the node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"startOrderers", "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer being started", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer status", "schema":{ "type":"object", "example":{ "status":"up" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-start-post" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop an Orderer Node", "description":"Stop an orderer node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"stopOrderers", "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer being stopped", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer status", "schema":{ "type":"object", "example":{ "status":"down" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-stop-post" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Orderer Node Configuration", "description":"An orderer node's configuration determines how the node performs and behaves on the network. Use this endpoint to see an orderer node's configuration.", "operationId":"getOrdererAttributes", "produces":[ "application/json" ], "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer to fetch", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer attributes", "schema":{ "$ref":"#/definitions/getOrdererAttributes" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-get", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update Orderer Node Configuration", "description":"An orderer node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify an orderer node's configuration.", "operationId":"updateOrdererAttributes", "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer", "required":true, "type":"string" }, { "name":"patchOrdererBody", "in":"body", "description":"Updated orderer attributes", "required":true, "schema":{ "$ref":"#/definitions/setOrdererAttributes" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "type":"object", "example":{ "status":"Success", "message":"content" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-patch", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-patch" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}/exportOSN":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Orderer information", "description":"Gets an orderer node's information.", "operationId":"exportOSNInfo", "produces":[ "application/json" ], "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of the orderer being queried", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Response with the OSN information object", "schema":{ "$ref":"#/definitions/exportOSNInfo" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-exportOSN-get", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-exportosn-get" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}/importNCB":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Import Configuration Block to Orderer", "description":"Imports a system channel's latest configuration block to an orderer. You must have previously exported the configuration block in order to upload it.", "operationId":"importConfigBlock", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of the orderer the block is being imported to", "required":true, "type":"string" }, { "in":"formData", "name":"channel.block", "type":"file", "description":"The file to upload." } ], "responses":{ "200":{ "description":"Response with OSN information object", "schema":{ "$ref":"#/definitions/exportOSNInfo" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-importNCB-post", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-importncb-post" } }, "/console/admin/api/v1.1/nodes/fabricCAs/{caId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start a CA Node", "description":"Start a Fabric CA node. This should be done after any changes are made to the node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"startFabricCAs", "parameters":[ { "name":"caId", "in":"path", "description":"ID of Fabric CA node", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Fabric CA status message", "schema":{ "type":"object", "example":{ "status":"up" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-start-post" } }, "/console/admin/api/v1.1/nodes/fabricCAs/{caId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a CA Node", "description":"Stop a CA node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"stopFabricCAs", "parameters":[ { "name":"caId", "in":"path", "description":"Fabric CA ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Fabric CA status message", "schema":{ "type":"object", "example":{ "status":"down" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-stop-post" } }, "/console/admin/api/v1.1/nodes/fabricCAs/{caId}/":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Configuration of a CA Node", "description":"A certificate authority (CA) node's configuration determines how the node performs and behaves on the network. Use this endpoint to get the configuration of a CA node.", "operationId":"getFabricCAAttributes", "produces":[ "application/json" ], "parameters":[ { "name":"caId", "in":"path", "description":"ID of Fabric CA to fetch", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Fabric CA attributes", "schema":{ "$ref":"#/definitions/fabricCAAttributes" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}--get", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update CA Node Configuration", "description":"A certificate authority (CA) node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify the configuration of a CA node.", "operationId":"updateFabricCAAttributes", "parameters":[ { "name":"caId", "in":"path", "description":"ID of Fabric CA", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"Updated Fabric CA attributes", "required":true, "schema":{ "$ref":"#/definitions/fabricCAWritableAttributes" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "type":"object", "example":{ "status":"Success", "message":"content" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}--patch", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-patch" } }, "/console/admin/api/v1.1/nodes/restproxies/{restProxyId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get REST Proxy Node Configuration", "description":"A REST proxy node's configuration determines how the node performs and behaves on the network. Use this endpoint to get a REST proxy node configuration.", "operationId":"getRestProxyConfig", "produces":[ "application/json" ], "parameters":[ { "name":"restProxyId", "in":"path", "description":"Unique ID of the REST node", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"REST Proxy configuration", "schema":{ "$ref":"#/definitions/restProxyConfig" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-get", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update REST Proxy Node Configuration", "description":"A REST proxy node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify the REST proxy node configuration.
On Oracle Cloud Infrastructure (Gen 2), you can only use this API to configure attributes such as the wait times and log level. You can't use it to specify the channel, chaincode, or endorser or an error will be returned.
", "operationId":"updateRestProxyConfig", "parameters":[ { "name":"restProxyId", "in":"path", "description":"Unique ID of the REST Proxy", "required":true, "type":"string" }, { "name":"configRestProxyBody", "in":"body", "description":"Updated REST proxy configuration", "required":true, "schema":{ "$ref":"#/definitions/restProxyWritableConfig" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "type":"object", "example":{ "status":"Success", "message":"content" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-patch", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-patch" } }, "/console/admin/api/v1.1/nodes/restproxies/{restProxyId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start a REST Proxy Node", "description":"Start a REST proxy node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"startRestProxy", "parameters":[ { "name":"restProxyId", "in":"path", "description":"Array of REST proxy IDs", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Gateway node status", "schema":{ "type":"object", "example":{ "status":"up" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-start-post" } }, "/console/admin/api/v1.1/nodes/restproxies/{restProxyId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a REST Proxy Node", "description":"Stop a REST proxy node.
On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.
", "operationId":"stopRestProxys", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST proxy ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Gateway node status", "schema":{ "type":"object", "example":{ "status":"down" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-stop-post" } }, "/console/admin/api/v1.1/channels":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Channel List", "description":"Get a list of channels, optionally filtering by whether they have a given chaincode instantiated or a given peer joined.", "operationId":"listChannels", "produces":[ "application/json" ], "parameters":[ { "name":"chaincode", "in":"query", "description":"List channels where this chaincode is instantiated", "required":false, "type":"string" }, { "name":"peerID", "in":"query", "description":"List channels that this peer has joined", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"List of channels meeting query criteria", "schema":{ "$ref":"#/definitions/channels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-get", "x-filename-id":"console-admin-api-v1.1-channels-get" }, "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Create a Channel", "description":"Create a channel on your blockchain network. ", "operationId":"creatChannel", "parameters":[ { "name":"createchannelbody", "in":"body", "description":"Create a channel. Only certificates from v1.1 API can be used.", "required":true, "schema":{ "$ref":"#/definitions/createchannel" } } ], "responses":{ "201":{ "description":"Channel created", "schema":{ "type":"object", "example":{ "status":"SUCCESS" } } }, "202":{ "description":"In progress", "schema":{ "type":"object", "example":{ "status":"IN PROGRESS" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-post", "x-filename-id":"console-admin-api-v1.1-channels-post" } }, "/console/admin/api/v1.1/channels/{channelName}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Channel Information", "description":"You can query by channel name to get information for a channel.", "operationId":"getChannelInfo", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Information for the channel", "schema":{ "$ref":"#/definitions/channelinfo" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Channel Configuration (Deprecated in v19.1.3)", "description":"You can modify a channel's configuration by supplying updated channel configuration information.", "operationId":"updateChannelOld", "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"patchChannelBody", "in":"body", "description":"Updated channel information", "required":true, "schema":{ "$ref":"#/definitions/patchChannel" } } ], "responses":{ "200":{ "description":"Success" }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-patch", "x-filename-id":"console-admin-api-v1.1-channels-channelname-patch" } }, "/console/admin/api/v1.1/channels/{channelName}/blocks/{blockId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Channel Block Data", "description":"If you have the channel name and block ID, you can get one block of data from a channel.", "operationId":"getBlockData", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"blockId", "in":"path", "description":"Block id", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Block data", "schema":{ "$ref":"#/definitions/blockData" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-blocks-{blockId}-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-blocks-blockid-get" } }, "/console/admin/api/v1.1/channels/{channelName}/blocks":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get a List of Block's Data", "description":"Using the channel name, a block ID range, and a time range, you can get a list of the block's data for a range of blocks on a channel, including transactions, deployments, and invocations. The time range and id range can not be enabled together. If id range is specified, time range won't take effect. This API returns 1000 blocks data at most. If no parameter is specified, it will return the latest 1000 blocks. If only fromId(since) is input, the toId(until) will be set as the current ledger height by default. If only toId(until) is input, the fromId(since) will be set as 0 by default. If the query range is beyond this value, an error message will be returned.", "operationId":"getBlocksData", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"fromId", "in":"query", "description":"The beginning ID of the selected block range", "required":false, "type":"number" }, { "name":"toId", "in":"query", "description":"The end ID of the selected block range", "required":false, "type":"number" }, { "name":"since", "in":"query", "description":"The beginning UTC time of the selected block range in the format YYYYMMDDHHmmSS", "required":false, "type":"string" }, { "name":"until", "in":"query", "description":"The end UTC time of the selected block range in the format YYYYMMDDHHmmSS", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieved block statistics information successfully", "schema":{ "$ref":"#/definitions/blockStatistic" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-blocks-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-blocks-get" } }, "/console/admin/api/v1.1/channels/{channelName}/policies":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Policies of a Channel", "description":"Update the policies of a channel.", "operationId":"updateChannelPolicies", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"channelPolicies", "in":"body", "description":"The new policies", "required":true, "schema":{ "type":"object", "properties":{ "policies":{ "type":"object", "properties":{ "readers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } }, "writers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } } } } } } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-policies-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-policies-post" } }, "/console/admin/api/v1.1/channels/{channelName}/orderingSettings":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Orderer Advanced Attributes for a Channel", "description":"Get orderer advanced attributes for a channel.", "operationId":"getOrderingSettings", "parameters":[ { "name":"channelName", "in":"path", "description":"the specified channel name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer attributes", "schema":{ "type":"object", "example":{ "ordererAddress":[ "example.com:30021" ], "absoluteMessageBytes":102760448, "maxMessageCount":10, "preferredMessageBytes":524288, "batchTimeout":"2s", "ordererType":"raft" } } }, "400":{ "description":"Invalid argument" }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Resource not found", "schema":{ "$ref":"#/definitions/404errorModels" } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-orderingSettings-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-orderingsettings-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Orderer Advanced Attributes for a Channel", "description":"Update orderer advanced attributes for a channel.", "operationId":"updateOrderingSettings", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"orderingSettings", "in":"body", "description":"New orderer attributes to be updated for this channel. Note that 'batchTimeout' should be specified with a string, such as '2s'.", "required":true, "schema":{ "type":"object", "properties":{ "absoluteMessageBytes":{ "type":"number", "default":98, "example":98 }, "maxMessageCount":{ "type":"number", "default":10, "example":10 }, "preferredMessageBytes":{ "type":"number", "default":512, "example":512 }, "batchTimeout":{ "type":"string", "default":"2s", "example":"2s" } } } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-orderingSettings-patch", "x-filename-id":"console-admin-api-v1.1-channels-channelname-orderingsettings-patch" } }, "/console/admin/api/v1.1/channels/{channelName}/organizations":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Add an organization to a channel", "operationId":"updateChannel", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"postChannelBody", "in":"body", "description":"New organization configuration to be added. Only certificates exported from the v1.1 API can be used.", "required":true, "schema":{ "$ref":"#/definitions/postChannelNewOrg" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-organizations-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-organizations-post" } }, "/console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}":{ "delete":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Remove an organization from a channel", "operationId":"removeOrgInChannel", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"mspId", "in":"path", "description":"The organization ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"set success", "schema":{ "type":"object", "example":{ "status":"Success" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Error message for unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-organizations-{mspId}-delete", "x-filename-id":"console-admin-api-v1.1-channels-channelname-organizations-mspid-delete" } }, "/console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}/anchorPeers":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Set Anchor Peers for a Channel", "description":"Each member on your network must designate an anchor peer. Anchor peers are primary network contact points and are used to discover additional peers in the network. You can designate one or more peers in your organization as an anchor peer on a channel. For a high availability network, you can specify two or more anchor peers. All members using the network channel must designate one or more of their peer nodes as anchor peers. ", "operationId":"setAnchorPeers", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"mspId", "in":"path", "description":"Organization id", "required":true, "type":"string" }, { "name":"anchorPeers", "in":"body", "description":"The host and port of the anchor peers", "required":true, "schema":{ "$ref":"#/definitions/setAnchorPeers" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "example":{ "status":"Success" } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-organizations-{mspId}-anchorPeers-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-organizations-mspid-anchorpeers-post" } }, "/console/admin/api/v1.1/channels/{channelName}/orderers/joinOSN":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Add an OSN to a Channel", "description":"Add an ordering service node (OSN) to a channel.", "operationId":"joinOSNToChannel", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"joinOSNBody", "in":"body", "description":"New orderer (identified by orderer ID) to be joined", "required":true, "schema":{ "$ref":"#/definitions/joinOSNBody" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-orderers-joinOSN-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-orderers-joinosn-post" } }, "/console/admin/api/v1.1/channels/{channelName}/orderers/removeOSN":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Remove an OSN from a Channel", "description":"Remove an ordering service node (OSN) from a channel.", "operationId":"removeOSNChannel", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"removeOSNBody", "in":"body", "description":"The orderer (identified by orderer ID) to be removed", "required":true, "schema":{ "$ref":"#/definitions/removeOSNBody" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-orderers-removeOSN-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-orderers-removeosn-post" } }, "/console/admin/api/v1.1/channels/syschannel/configblock":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get the System Channel's Configuration Block", "description":"Returns the system channel's latest configuration block.", "operationId":"getConfigBlock", "responses":{ "200":{ "description":"Block data", "schema":{ "type":"file" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-syschannel-configblock-get", "x-filename-id":"console-admin-api-v1.1-channels-syschannel-configblock-get" } }, "/console/admin/api/v1.1/channels/syschannel/addOSN":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Add an OSN to the System Channel", "description":"Add an ordering service node (OSN) to the system channel.", "operationId":"addOSNToSysChannel", "parameters":[ { "name":"addOSNBody", "in":"body", "description":"New orderer (identified by orderer ID) to be joined", "required":true, "schema":{ "$ref":"#/definitions/exportOSNInfo" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-syschannel-addOSN-post", "x-filename-id":"console-admin-api-v1.1-channels-syschannel-addosn-post" } }, "/console/admin/api/v1.1/chaincodes":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Get Installed Chaincode List", "description":"Get a list of installed chaincodes, optionally filtering by whether they're instantiated on a given channel or installed on a given peer.", "operationId":"getInstalledChaincodes", "parameters":[ { "name":"channelName", "in":"query", "description":"Channel name where the chaincode is installed", "required":false, "type":"string" }, { "name":"peerId", "in":"query", "description":"ID of the peer where the chaincode is installed", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"List of installed chaincodes", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/chaincodeInfo" } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-get", "x-filename-id":"console-admin-api-v1.1-chaincodes-get" }, "post":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Install a Chaincode", "description":"Installs a chaincode on a specified peer. The chaincode must be BASE64 encoded zip file.", "operationId":"installChaincode", "parameters":[ { "name":"body", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/installChaincode" } } ], "responses":{ "200":{ "description":"Installed chaincode successfully", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-post", "x-filename-id":"console-admin-api-v1.1-chaincodes-post" } }, "/console/admin/api/v1.1/chaincodes/{chaincodeName}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Get Chaincode Information", "description":"Returns the version and path of a specified chaincode name.", "operationId":"getChaincodesById", "produces":[ "application/json" ], "parameters":[ { "name":"chaincodeName", "in":"path", "description":"Chaincode name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Chaincode information", "schema":{ "type":"object", "properties":{ "name":{ "type":"string" }, "version":{ "type":"array", "items":{ "type":"string" } }, "path":{ "type":"string" } } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-{chaincodeName}-get", "x-filename-id":"console-admin-api-v1.1-chaincodes-chaincodename-get" } }, "/console/admin/api/v1.1/chaincodes/{chaincodeName}/instantiate":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Instantiate a Chaincode", "description":"Instantiates a chaincode on a channel.", "operationId":"instantiateChaincode", "parameters":[ { "name":"chaincodeName", "in":"path", "description":"Name of the chaincode to instantiate.", "required":true, "type":"string" }, { "name":"chaincodeInstantiatedOnChannelBody", "in":"body", "description":"Information about where and how to instantiate the chaincode.", "required":true, "schema":{ "$ref":"#/definitions/instantiateChaincode" } } ], "responses":{ "200":{ "description":"Instantiated chaincode successfully", "schema":{ "$ref":"#/definitions/200successModels" } }, "202":{ "description":"In Progress" }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-{chaincodeName}-instantiate-post", "x-filename-id":"console-admin-api-v1.1-chaincodes-chaincodename-instantiate-post" } }, "/console/admin/api/v1.1/organizations":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Get All Organizations", "description":"Use this endpoint to return the names of all organizations in a network. This is only available on the founder.", "operationId":"getAllOrgs", "responses":{ "200":{ "description":"Lists all organizations, including founder and participants", "schema":{ "type":"object", "example":{ "founder":"Query a chaincode.
On Oracle Cloud Infrastructure (Gen 2), for CouchDB array operators, range query and pagination aren't supported.
", "operationId":"queryChaincode", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"query request", "description":"Request to query a chaincode", "schema":{ "type":"object", "required":[ "chaincode", "args" ], "properties":{ "role":{ "description":"Name of Fabric enrollment to be used", "type":"string" }, "chaincode":{ "description":"Name of the chaincode", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "timeout":{ "description":"Timeout in ms for the chaincode to invoke", "type":"integer", "format":"int64", "default":18000 }, "transientMap":{ "description":"TransientMap for the chaincode", "type":"object", "additionalProperties":{ "type":"string" } }, "peer":{ "description":"Endpoint of the target peer", "type":"string" } } } } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "required":[ "payload", "encode" ], "properties":{ "message":{ "type":"string" }, "payload":{ "$ref":"#/definitions/AnyValue" }, "encode":{ "$ref":"#/definitions/encode" } } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-chaincode-queries-post", "x-filename-id":"restproxy-api-v2-channels-channelid-chaincode-queries-post" } }, "/restproxy/api/v2/channels/{channelId}/transactions/{transactionId}":{ "parameters":[ { "name":"channelId", "in":"path", "description":"ID of the channel", "required":true, "type":"string" }, { "name":"transactionId", "in":"path", "description":"ID of the transaction", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Transactions" ], "summary":"Get Transaction Information", "description":"Get the information for a transaction, whether it's submitted or not.
On Oracle Cloud Infrastructure (Gen 2), querying asynchronous invocation proposal failures is not supported.
", "operationId":"getTransactionInfo", "produces":[ "application/json" ], "parameters":[ { "name":"role", "in":"query", "description":"Name of Fabric enrollment to be used", "type":"string" } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string" }, "result":{ "type":"object", "required":[ "txid", "status" ], "properties":{ "txid":{ "description":"Transaction ID", "type":"string" }, "status":{ "description":"Transaction Status", "type":"string", "enum":[ "valid", "invalid", "not found" ] }, "message":{ "type":"string" }, "payload":{ "$ref":"#/definitions/AnyValue" }, "encode":{ "$ref":"#/definitions/encode" } } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-transactions-{transactionId}-get", "x-filename-id":"restproxy-api-v2-channels-channelid-transactions-transactionid-get" } }, "/restproxy/api/v2/channels/{channelId}/event-subscriptions":{ "parameters":[ { "name":"channelId", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Events" ], "summary":"List Event Subscriptions", "description":"List all event subscriptions", "operationId":"listSubscribeEvents", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"query", "name":"role", "type":"string", "description":"Name of Fabric enrollment to be used" }, { "in":"query", "name":"user-id", "type":"string", "description":"User name. It should be the same user defined in basic auth." }, { "in":"query", "name":"subscription-id", "type":"string", "description":"ID of the subscription when operation succeeds" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when operation fails", "default":"" }, "result":{ "type":"array", "items":{ "$ref":"#/definitions/EventSubscription" } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-event-subscriptions-get", "x-filename-id":"restproxy-api-v2-channels-channelid-event-subscriptions-get" }, "post":{ "tags":[ "Application Operations/Events" ], "summary":"Subscribe to an Event", "description":"Subscribe to an event", "operationId":"subscribeEvent", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"subscribe event request", "description":"Request to subscribe to an event", "required":true, "schema":{ "$ref":"#/definitions/EventSubscription" } } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when operation fails", "default":"" }, "result":{ "type":"object", "required":[ "subid" ], "properties":{ "subid":{ "description":"ID of the subscription when operation succeeds", "type":"string" } } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-event-subscriptions-post", "x-filename-id":"restproxy-api-v2-channels-channelid-event-subscriptions-post" }, "delete":{ "tags":[ "Application Operations/Events" ], "summary":"Unsubscribe from an Event", "description":"Unsubscribe from an event", "operationId":"unsubscribeEvent", "produces":[ "application/json" ], "parameters":[ { "in":"query", "name":"role", "type":"string", "description":"Name of Fabric enrollment to be used" }, { "in":"query", "name":"user-id", "type":"string", "description":"User name. It should be the same as the user defined in basic auth." }, { "in":"query", "name":"subscription-id", "type":"string", "description":"ID of the subscription when operation succeeds" } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string" }, "result":{ "type":"array", "items":{ "$ref":"#/definitions/UnEventSubscription" } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-event-subscriptions-delete", "x-filename-id":"restproxy-api-v2-channels-channelid-event-subscriptions-delete" } } }, "definitions":{ "logLevel":{ "type":"string", "enum":[ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ] }, "nodes":{ "type":"object", "properties":{ "peers":{ "type":"array", "items":{ "$ref":"#/definitions/peer" } }, "orderers":{ "type":"array", "items":{ "$ref":"#/definitions/orderer" } }, "fabricCAs":{ "type":"array", "items":{ "$ref":"#/definitions/FabricCA" } }, "RESTProxies":{ "type":"array", "items":{ "$ref":"#/definitions/RESTProxy" } } } }, "peer":{ "type":"object", "required":[ "peerId" ], "properties":{ "peerId":{ "type":"string" }, "mspId":{ "type":"string" }, "role":{ "type":"string", "enum":[ "Member", "Admin" ] }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "eventUrl":{ "type":"string" }, "displayName":{ "type":"string" } } }, "peer2":{ "type":"object", "required":[ "peerId" ], "properties":{ "peerId":{ "type":"string" }, "mspId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "eventUrl":{ "type":"string" }, "displayName":{ "type":"string" } } }, "orderer":{ "type":"object", "properties":{ "ordererId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "adminUrl":{ "type":"string" }, "mspId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "FabricCA":{ "type":"object", "properties":{ "fabricCAId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "mspId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "RESTProxy":{ "type":"object", "properties":{ "RESTProxyId":{ "type":"string" }, "status":{ "type":"string" }, "url":{ "type":"string" }, "mspId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "NodeStatus":{ "type":"object", "properties":{ "status":{ "type":"string", "enum":[ "up", "down" ] } } }, "ActionStatus":{ "type":"string", "enum":[ "Success" ] }, "peerPatchActionResult":{ "type":"object", "properties":{ "status":{ "type":"string", "enum":[ "Success" ] }, "message":{ "type":"string" } } }, "gossip":{ "type":"object", "properties":{ "bootstrapPeers":{ "type":"string" }, "maxBlockCountToStore":{ "type":"integer", "default":100, "example":100 }, "maxPropagationBurstLatency":{ "type":"integer", "default":10, "example":10 }, "maxPropagationBurstSize":{ "type":"integer", "default":10, "example":10 }, "propagateIterations":{ "type":"integer", "default":1, "example":1 }, "propagatePeerNumber":{ "type":"integer", "default":3, "example":3 }, "pullInterval":{ "type":"integer", "default":4, "example":4 }, "pullPeerNumber":{ "type":"integer", "default":3, "example":3 }, "requestStateInfoInterval":{ "type":"integer", "default":4, "example":4 }, "publishStateInfo":{ "type":"integer", "default":4, "example":4 }, "publicCertPeriod":{ "type":"integer", "default":10, "example":10 }, "dialTimeout":{ "type":"integer", "default":3, "example":3 }, "connectTimeout":{ "type":"integer", "default":2, "example":2 }, "receiveBufferSize":{ "type":"integer", "default":20, "example":20 }, "sendBufferSize":{ "type":"integer", "default":200, "example":200 }, "digestWaitTime":{ "type":"integer", "default":1, "example":1 }, "requestWaitTime":{ "type":"integer", "default":1500, "example":1500 }, "responseWaitTime":{ "type":"integer", "default":2, "example":2 }, "aliveTimeInterval":{ "type":"integer", "default":5, "example":5 }, "aliveExpirationTimeout":{ "type":"integer", "default":25, "example":25 }, "reconnectInterval":{ "type":"integer", "default":25, "example":25 }, "skipBlockVerification":{ "type":"boolean", "default":false, "example":false } } }, "peerAttributes":{ "type":"object", "properties":{ "peerId":{ "type":"string" }, "mspId":{ "type":"string" }, "alias":{ "type":"string" }, "role":{ "type":"string", "enum":[ "Member", "Admin" ] }, "url":{ "type":"string" }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "gossip":{ "$ref":"#/definitions/gossip" }, "gossipElection":{ "type":"object", "properties":{ "membershipSampleInterval":{ "type":"integer", "default":1, "example":1 }, "leaderALiveThreshold":{ "type":"integer", "default":10, "example":10 }, "leaderElectionDuration":{ "type":"integer", "default":5, "example":5 }, "leader":{ "type":"string", "enum":[ "UseLeaderElection", "OrgLeader" ] } } }, "eventService":{ "type":"object", "properties":{ "url":{ "type":"string" }, "bufferSize":{ "type":"integer", "default":100, "example":100 }, "timeout":{ "type":"integer", "default":10, "example":10 } } }, "chaincode":{ "type":"object", "properties":{ "startupTimeout":{ "type":"integer", "default":300, "example":300 }, "executeTimeout":{ "type":"integer", "default":30, "example":30 }, "mode":{ "type":"string", "enum":[ "dev", "net" ] }, "keepalive":{ "type":"integer", "default":0, "example":0 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "shimLevel":{ "$ref":"#/definitions/logLevel" } } } } }, "peerAddAttributes":{ "type":"object", "properties":{ "alias":{ "type":"string" }, "role":{ "type":"string", "enum":[ "Member", "Admin" ] }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "partition":{ "type":"string", "enum":[ "Partition 1", "Partition 2" ] }, "gossip":{ "$ref":"#/definitions/gossip" }, "gossipElection":{ "type":"object", "properties":{ "membershipSampleInterval":{ "type":"integer", "default":1, "example":1 }, "leaderALiveThreshold":{ "type":"integer", "default":10, "example":10 }, "leaderElectionDuration":{ "type":"integer", "default":5, "example":5 }, "userLeaderElection":{ "type":"boolean" }, "leader":{ "type":"string", "enum":[ "UseLeaderElection", "OrgLeader" ] } } }, "eventService":{ "type":"object", "properties":{ "bufferSize":{ "type":"integer", "default":100, "example":100 }, "timeout":{ "type":"integer", "default":10, "example":10 } } }, "chaincode":{ "type":"object", "properties":{ "startupTimeout":{ "type":"integer", "default":300, "example":300 }, "executeTimeout":{ "type":"integer", "default":30, "example":30 }, "mode":{ "type":"string", "enum":[ "dev", "net" ] }, "keepalive":{ "type":"integer", "default":0, "example":0 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "shimLevel":{ "$ref":"#/definitions/logLevel" } } } } }, "peerPatchAttributes":{ "type":"object", "properties":{ "alias":{ "type":"string" }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "gossip":{ "$ref":"#/definitions/gossip" }, "gossipElection":{ "type":"object", "properties":{ "membershipSampleInterval":{ "type":"integer", "default":1, "example":1 }, "leaderALiveThreshold":{ "type":"integer", "default":10, "example":10 }, "leaderElectionDuration":{ "type":"integer", "default":5, "example":5 }, "leader":{ "type":"string", "enum":[ "UseLeaderElection", "OrgLeader" ] } } }, "eventService":{ "type":"object", "properties":{ "bufferSize":{ "type":"integer", "default":100, "example":100 }, "timeout":{ "type":"integer", "default":10, "example":10 } } }, "chaincode":{ "type":"object", "properties":{ "startupTimeout":{ "type":"integer", "default":300, "example":300 }, "executeTimeout":{ "type":"integer", "default":30, "example":30 }, "mode":{ "type":"string", "enum":[ "dev", "net" ] }, "keepalive":{ "type":"integer" }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "shimLevel":{ "$ref":"#/definitions/logLevel" } } } } }, "addPeerActionResult":{ "type":"object", "properties":{ "status":{ "type":"string" } } }, "joinChannel":{ "type":"object", "properties":{ "channelName":{ "type":"string" } }, "example":{ "channelName":"mychannel1" } }, "exportedNodes":{ "type":"array", "items":{ "type":"object", "properties":{ "organization":{ "type":"string" }, "nodes":{ "type":"object", "properties":{ "peers":{ "type":"array", "items":{ "type":"object", "properties":{ "peerId":{ "type":"string" }, "displayName":{ "type":"string" }, "url":{ "type":"string" }, "eventUrl":{ "type":"string" }, "mspId":{ "type":"string" }, "joinedChannels":{ "type":"array", "items":{ "type":"string" } }, "installedChaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "version":{ "type":"string" }, "path":{ "type":"string" } } } } } } } } }, "tlsCACert":{ "type":"string" }, "signature":{ "type":"string" } } } }, "orgInfo":{ "type":"array", "items":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" }, "nodeouIdentifierCert":{ "type":"string" }, "rafttlsCACert":{ "type":"string" }, "intermediateCerts":{ "type":"string" } } }, "signature":{ "type":"string" } } }, "example":[ { "mspId":"Org6MSP", "certs":{ "adminCert":"", "CACert":"", "tlsCACert":"", "nodeouIdentifierCert":"", "rafttlsCACert":"", "intermediateCerts":"" }, "signature":"" } ] }, "ordererSettingInfo":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" }, "intermediateCerts":{ "type":"string" } } }, "orderingServiceNodes":{ "type":"array", "items":{ "type":"object", "properties":{ "address":{ "type":"string" }, "adminAddress":{ "type":"string" } } } }, "signature":{ "type":"string" } } }, "getOrdererAttributes":{ "type":"object", "properties":{ "ordererId":{ "type":"string" }, "mspId":{ "type":"string" }, "url":{ "type":"string" }, "adminUrl":{ "type":"string" }, "batchTimeout":{ "type":"string", "default":"2s", "example":"2s" }, "batchSizeMaxMessageCount":{ "type":"integer", "default":10, "example":10 }, "batchSizeAbsMaxBytes":{ "type":"integer", "default":102760448, "example":102760448 }, "batchSizePrefMaxBytes":{ "type":"integer", "default":524288, "example":524288 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "kafka/Retry":{ "$ref":"#/definitions/orderKafkaRetry" } } }, "setOrdererAttributes":{ "type":"object", "properties":{ "batchTimeout":{ "type":"string", "default":"2s", "example":"2s" }, "batchSizeMaxMessageCount":{ "type":"integer", "default":10, "example":10 }, "batchSizeAbsMaxBytes":{ "type":"integer", "default":102760448, "example":102760448 }, "batchSizePrefMaxBytes":{ "type":"integer", "default":524288, "example":524288 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "kafkaRetry":{ "$ref":"#/definitions/orderKafkaRetry" }, "raftRetry":{ "$ref":"#/definitions/orderRaftRetry" } } }, "orderKafkaRetry":{ "type":"object", "description":"Orderer attributes when using Kafka", "properties":{ "shortInterval":{ "type":"integer", "default":5, "example":5 }, "shortTotal":{ "type":"integer", "default":10, "example":10 }, "longInterval":{ "type":"integer", "default":5, "example":5 }, "longTotal":{ "type":"integer", "default":10, "example":10 }, "networkDialTimeout":{ "type":"integer", "default":10, "example":10 }, "networkReadTimeout":{ "type":"integer", "default":10, "example":10 }, "networkWriteTimeout":{ "type":"integer", "default":10, "example":10 }, "metadataRetryBackoff":{ "type":"integer", "default":250, "example":250 }, "metadataRetryMax":{ "type":"integer", "default":3, "example":3 }, "producerRetryBackoff":{ "type":"integer", "default":100, "example":100 }, "producerRetryMax":{ "type":"integer", "default":3, "example":3 }, "consumerRetryBackoff":{ "type":"integer", "default":2, "example":2 } } }, "orderRaftRetry":{ "type":"object", "description":"Orderer attributes when using Raft", "properties":{ "sendBufferSize":{ "type":"integer", "default":10, "example":10 }, "dialTimeout":{ "type":"integer", "default":5, "example":5 }, "RPCTimeout":{ "type":"integer", "default":7, "example":7 }, "replicationBufferSize":{ "type":"integer", "default":20971520, "example":20971520 }, "replicationBackgroundRefreshInterval":{ "type":"integer", "default":5, "example":5 }, "replicationRetryTimeout":{ "type":"integer", "default":5, "example":5 }, "replicationPullTimeout":{ "type":"integer", "default":5, "example":5 }, "evictionSuspicion":{ "type":"integer", "default":10, "example":10 } } }, "exportOSNInfo":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "orderingServiceNodes":{ "type":"array", "items":{ "type":"object", "properties":{ "ordererId":{ "type":"string" }, "displayName":{ "type":"string" }, "address":{ "type":"string" }, "raftAddress":{ "type":"string" }, "adminAddress":{ "type":"string" }, "server_tls_cert":{ "type":"string" }, "client_tls_cert":{ "type":"string" } } } }, "signature":{ "type":"string" } } }, "fabricCAAttributes":{ "type":"object", "properties":{ "fabricCAId":{ "type":"string" }, "url":{ "type":"string" }, "maxEnrollments":{ "type":"integer", "default":-1, "example":-1 }, "logLevel":{ "type":"string", "enum":[ "INFO", "DEBUG" ] } } }, "fabricCAWritableAttributes":{ "type":"object", "properties":{ "maxEnrollments":{ "type":"integer", "default":-1, "example":-1 }, "logLevel":{ "type":"string", "enum":[ "DEBUG", "INFO" ] } } }, "restProxyConfig":{ "type":"object", "required":[ "RESTProxyId", "proposalWaitTime", "transactionWaitTime", "channels" ], "properties":{ "RESTProxyId":{ "type":"string" }, "proposalWaitTime":{ "type":"integer", "format":"int32", "example":60000, "default":60000 }, "transactionWaitTime":{ "type":"integer", "format":"int32", "example":300000, "default":300000 }, "logLevel":{ "type":"string", "enum":[ "INFO", "DEBUG", "WARNING", "ERROR" ] }, "channels":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"mychannel" }, "chaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "endorsers":{ "type":"array", "items":{ "type":"string" } } } }, "example":[ { "name":"mycc", "endorsers":[ "peer0.org1.example.com", "peer1.org1.example.com" ] } ] } } } } } }, "restProxyWritableConfig":{ "type":"object", "required":[ "proposalWaitTime", "transactionWaitTime", "channels" ], "properties":{ "proposalWaitTime":{ "type":"integer", "format":"int32", "example":60000, "default":60000 }, "transactionWaitTime":{ "type":"integer", "format":"int32", "example":300000, "default":300000 }, "logLevel":{ "type":"string", "enum":[ "ERROR", "WARNING", "INFO", "DEBUG" ] }, "channels":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"mychannel" }, "chaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "endorsers":{ "type":"array", "items":{ "type":"string" } } } }, "example":[ { "name":"mycc", "endorsers":[ "peer0.org1.example.com", "peer1.org1.example.com" ] } ] } } } } } }, "channels":{ "type":"array", "items":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "createor":{ "type":"string" }, "mspIds":{ "type":"array", "items":{ "type":"string" } } } } }, "createchannel":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "organizations":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "mspId":{ "type":"string" }, "anchorPeers":{ "type":"array", "items":{ "type":"string" } }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" }, "intermediatecerts":{ "type":"string" }, "nodeouIdentifierCert":{ "type":"string" }, "rafttlsCACert":{ "type":"string" } } }, "signature":{ "type":"string" } } } }, "policies":{ "type":"object", "properties":{ "readers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } }, "writers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } } } } }, "example":{ "channelName":"mychannel", "organizations":[ { "name":"Org1MSP", "mspId":"Org1MSP", "anchorPeers":[ "peer.org1.example.com:7051" ], "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example", "intermediatecerts":"example", "nodeouIdentifierCert":"example", "rafttlsCACert":"example" }, "signature":"example" }, { "name":"Org2MSP", "mspId":"Org2MSP", "anchorPeers":[ "peer.org2.example.com:7051" ], "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example", "intermediatecerts":"example", "nodeouIdentifierCert":"example", "rafttlsCACert":"example" }, "signature":"example" } ], "policies":{ "readers":{ "mspIds":[ "Org1MSP", "org2MSP" ] }, "writers":{ "mspIds":[ "Org1MSP", "org2MSP" ] } } } }, "channelinfo":{ "type":"object", "properties":{ "orgUnits":{ "type":"object", "properties":{ "MSPs":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" } } } }, "anchorpeers":{ "type":"array", "items":{ "type":"string" } } }, "example":{ "MSPs":[ { "id":"org1MSP" } ], "anchorpeers":[ ] } }, "ACL":{ "type":"object" } } }, "blockInfo":{ "type":"object", "properties":{ "activity":{ "type":"array", "items":{ "type":"object", "example":{ "number":{ "low":1, "high":0, "unsigned":true }, "depoly":"genesis", "invoke":0 } } }, "detail":{ "type":"array", "items":{ "type":"object" } }, "overview":{ "type":"object", "example":{ "blocks":2, "block_speed":0.08210181560183083, "transaction_activity":0, "deployment":0, "invokes":0 } } } }, "joinOSNBody":{ "type":"object", "properties":{ "orderer":{ "type":"string" } }, "example":{ "orderer":"example-org-orderer0" } }, "removeOSNBody":{ "type":"object", "properties":{ "orderer":{ "type":"string" } }, "example":{ "orderer":"example-org-orderer0" } }, "installChaincode":{ "type":"object", "properties":{ "source":{ "type":"object", "properties":{ "content":{ "type":"string", "description":"The content should be a base64-encoded string of chaincode, which could be a source file or zip package" }, "fileName":{ "type":"string" } } }, "chaincodeId":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "peers":{ "type":"array", "items":{ "type":"object", "properties":{ "url":{ "type":"string" } } } } }, "example":{ "source":{ "fileName":"example_cc", "content":"example chaincode code (BASE64 encoded)" }, "chaincodeId":"exampleChaincodeId", "chaincodeVersion":"v1", "peers":[ { "url":"grpcs://peer0.org1.example.com:7051" } ] } }, "instantiateChaincode":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "args":{ "type":"array", "items":{ "type":"string" } }, "transientMap":{ "type":"object" }, "endorsementPolicy":{ "type":"object", "properties":{ "identities":{ "type":"array", "items":{ "type":"object", "properties":{ "role":{ "type":"object", "properties":{ "name":{ "type":"string", "enum":[ "member", "admin", "peer" ] }, "mspId":{ "type":"string" } } } } } }, "policy":{ "type":"object" } } }, "dataCollectionConfig":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "policy":{ "type":"string" }, "requiredPeerCount":{ "type":"number" }, "maxPeerCount":{ "type":"number" }, "blockToLive":{ "type":"number" } } } }, "upgrade":{ "type":"boolean" }, "chaincodeType":{ "type":"string", "enum":[ "golang", "node", "java" ] }, "peers":{ "type":"array", "items":{ "type":"object", "properties":{ "url":{ "type":"string" } } } } }, "example":{ "channelName":"mychannel1", "chaincodeVersion":"v1", "transientMap":{ }, "endorsementPolicy":{ "identities":[ ], "policy":{ "0-of":[ ] } }, "args":[ "a", "100", "b", "200" ], "dataCollectionConfig":{ "name":"", "policy":"", "requiredPeerCount":1, "maxPeerCount":2, "blockToLive":10 }, "chaincodeType":"golang", "peers":[ { "url":"grpcs://peer0.org1.example.com:7051" } ] } }, "blockData":{ "type":"object", "properties":{ "header":{ "type":"object" }, "data":{ "type":"object" } } }, "blockStatistic":{ "type":"object", "properties":{ "overview":{ "type":"object", "properties":{ "blocks":{ "type":"number" }, "blockSpeed":{ "type":"number" }, "transactionActivity":{ "type":"number" }, "deployment":{ "type":"number" }, "invokes":{ "type":"number" } } }, "activities":{ "type":"array", "items":{ "type":"object", "properties":{ "number":{ "type":"string" }, "deploy":{ "type":"string" }, "invoke":{ "type":"number" } } } }, "blocks":{ "type":"array", "items":{ "type":"object", "properties":{ "header":{ "type":"object" }, "data":{ "type":"object" } } } } } }, "postChannelNewOrg":{ "type":"object", "properties":{ "organization":{ "type":"object", "properties":{ "version":{ "type":"string" }, "type":{ "type":"string" }, "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" }, "rafttlsCACert":{ "type":"string" }, "nodeouIdentifierCert":{ "type":"string" }, "intermediateCerts":{ "type":"string" } } }, "signature":{ "type":"string" } } }, "access":{ "type":"string" } }, "example":{ "organization":{ "mspId":"Org1MSP", "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example", "rafttlsCACert":"example", "nodeouIdentifierCert":"example", "intermediateCerts":"example" }, "signature":"example" }, "access":"ReaderWriter|ReaderOnly" } }, "patchChannel":{ "type":"object", "properties":{ "organizations":{ "type":"array", "items":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" } } }, "signature":{ "type":"string" } } } }, "policies":{ "type":"object", "properties":{ "readers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } }, "writers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } } } } }, "example":{ "organizations":[ { "name":"Org1MSP", "mspId":"Org1MSP", "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example" }, "signature":"example" } ], "policies":{ "readers":{ "mspids":[ "org1", "org2" ] }, "writers":{ "mspids":[ "org1", "org2" ] } } } }, "chaincodeInfo":{ "type":"object", "properties":{ "name":{ "type":"string" }, "paths":{ "type":"array", "items":{ "type":"string" } }, "versions":{ "type":"array", "items":{ "type":"string" } } } }, "StatsMetrics":{ "type":"string", "example":"broadcast_enqueue_duration_bucket{channel=\\\"fochannel01\\\",status=\\\"SUCCESS\\\",type=\\\"ENDORSER_TRANSACTION\\\",le=\\\"0.005\\\"} 11" }, "setAnchorPeers":{ "type":"object", "properties":{ "anchorPeers":{ "type":"array", "items":{ "type":"string" } } }, "example":{ "anchorPeers":[ "org1peer0", "org1peer1" ] } }, "StatsNodeHealth":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "nodeType":{ "type":"string" }, "health":{ "type":"object", "properties":{ "time":{ "type":"string" }, "status":{ "type":"string" } } } } }, "StatsChannelInfo":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "peerNum":{ "type":"number" }, "peers":{ "type":"array", "items":{ "type":"string" } } } }, "StatsChannelsJoined":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "channelNum":{ "type":"number" }, "channels":{ "type":"array", "items":{ "type":"string" } } } }, "StatsChaincodeInstalled":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "chaincodeNum":{ "type":"number" }, "chaincodes":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChaincodeInfo" } } } }, "StatsChaincodeInfo":{ "type":"object", "properties":{ "ccName":{ "type":"string" }, "ccVersion":{ "type":"string" } } }, "StatsChaincodeInstantiated":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "chaincodeNum":{ "type":"number" }, "chaincodes":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChaincodeInfo" } } } }, "StatsUserTrans":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "orderer":{ "type":"string" }, "userTrans":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsTransInfo":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "trans":{ "type":"number" } } }, "StatsBillableTrans":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "billableTrans":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsEndorsements":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "endorsements":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsCommits":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "commits":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsBlocks":{ "type":"object", "properties":{ "blocks":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsProxySyncInvocation":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "asyncInvocation":{ "type":"number" } } }, "StatsProxyAsyncInvocation":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "asyncInvocation":{ "type":"number" } } }, "StatsAuditLog":{ "type":"object", "properties":{ "total":{ "type":"number" }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "auditLogs":{ "type":"array", "items":{ "type":"object" } } } }, "errorModel":{ "type":"object", "required":[ "code", "message" ], "properties":{ "code":{ "type":"integer", "format":"int32" }, "message":{ "type":"string" } } }, "200successModels":{ "type":"object", "properties":{ "key":{ "type":"string" }, "value":{ "type":"string" } }, "example":{ "status":"success" } }, "400errorModels":{ "type":"object", "properties":{ "key":{ "type":"string" }, "value":{ "type":"string" } }, "example":{ "respMesg":"invalid argument" } }, "404errorModels":{ "type":"object", "properties":{ "respMesg":{ "type":"string" } }, "example":{ "respMesg":"resource not found" } }, "500errorModels":{ "type":"object", "properties":{ "key":{ "type":"string" }, "value":{ "type":"string" } } }, "BlockchainPlatformCreationDetails":{ "type":"object", "required":[ "name", "platformRole", "configuration", "cluster", "additionalConfiguration" ], "properties":{ "name":{ "type":"string", "description":"instance name" }, "desc":{ "type":"string", "description":"description" }, "platformRole":{ "type":"string", "description":"instance role", "enum":[ "founder", "participant" ] }, "configuration":{ "type":"string", "enum":[ "Developer", "Enterprise" ], "description":"compute configuration", "default":"Developer" }, "peer":{ "type":"integer", "description":"peer number", "minimum":1, "maximum":14 }, "onFailure":{ "type":"string", "enum":[ "Rollback", "Retain" ], "description":"On instance creation failure, the instance will be either deleted or retained" }, "cluster":{ "$ref":"#/definitions/ClusterCreationDetails" }, "additionalConfiguration":{ "$ref":"#/definitions/AdditionalCreationDetails" } } }, "ClusterCreationDetails":{ "type":"object", "description":"VM to construct cluster", "properties":{ "platformHosts":{ "type":"array", "description":"Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager", "items":{ "type":"string" } }, "crcHosts":{ "type":"array", "description":"CRC VM list, not in swarm", "items":{ "type":"string" } } } }, "AdditionalCreationDetails":{ "type":"object", "description":"external server/path list", "properties":{ "useExternalLBR":{ "type":"boolean", "description":"Stipulates whether or not the instance uses an external load balancer." }, "instanceFQDN":{ "type":"string", "description":"FQDN value for the instance to be provided only when external load balancer is used. When this value is not provided the instance name is mapped to the internal load balancer that is used." }, "startPort":{ "type":"integer", "description":"External load balancer start port", "default":15000, "minimum":0, "maximum":65535 }, "enableTLS":{ "type":"boolean", "description":"Determines whether to enable or disable TLS with the default load balancer." }, "useHSM":{ "type":"boolean", "description":"Determines whether to store private keys on the HSM or VM.", "default":false }, "hsmConfiguration":{ "$ref":"#/definitions/HSMDetails" } } }, "HSMDetails":{ "type":"object", "description":"Details required to communicate with the HSM.", "required":[ "library", "label", "pin", "chrystokiConf" ], "properties":{ "library":{ "type":"string", "description":"The path for the libCryptoki2.so library." }, "label":{ "type":"string", "description":"The partition label to use in the HSM." }, "pin":{ "type":"string", "description":"The Crypto Officer PIN for the partition in the HSM." }, "chrystokiConf":{ "type":"string", "description":"The path to the Chrystoki.conf file." } } }, "UpdateHSMDetails":{ "type":"object", "description":"Details required to update the HSM.", "properties":{ "label":{ "type":"string", "description":"The partition label to use in the HSM." }, "pin":{ "type":"string", "description":"The Crypto Officer PIN for the partition in the HSM." } } }, "Error":{ "description":"Error Information.", "required":[ "status", "message" ], "properties":{ "status":{ "description":"A short error status that defines the error, meant for programmatic parsing.", "type":"string" }, "message":{ "description":"A human-readable error string.", "type":"string" }, "errors":{ "type":"array", "description":"list of errors", "items":{ "type":"string" } }, "warnings":{ "type":"array", "description":"list of warnings", "items":{ "type":"string" } } } }, "BlockchainPlatformSummaryWrapper":{ "description":"Blockchain Platform Summary List Wrapper", "type":"object", "properties":{ "instances":{ "description":"List of Blockchain Platform instances", "type":"array", "items":{ "$ref":"#/definitions/BlockchainPlatformSummary" } }, "summary":{ "$ref":"#/definitions/InstancesCountSummary" } } }, "InstancesCountSummary":{ "description":"Blockchain Platform Summary", "type":"object", "properties":{ "instancesCount":{ "description":"Total number of instances", "type":"integer" }, "founderCount":{ "description":"Total number of founder instances", "type":"integer" }, "participantCount":{ "description":"Total number of participant instances", "type":"integer" }, "enterpriseCount":{ "description":"Total number of enterprise instances", "type":"integer" }, "developerCount":{ "description":"Total number of developer instances", "type":"integer" } } }, "BlockchainPlatformSummary":{ "description":"Blockchain Platform Summary", "type":"object", "required":[ "id" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Instance display name, can be renamed", "type":"string" }, "timeCreated":{ "description":"The time the the instance was created. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the instance was updated. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The user who created the instance", "type":"string" }, "createOperationId":{ "description":"The operation id of the create operation that created the instance", "type":"string" }, "platformRole":{ "description":"Role of platform: Founder or Participant", "type":"string", "enum":[ "Founder", "Participant" ] }, "configuration":{ "description":"Type of compute configuration: Developer or Enterprise", "type":"string", "enum":[ "Developer", "Enterprise" ] }, "status":{ "type":"string", "description":"Instance status", "enum":[ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ] }, "statusDisplayName":{ "type":"string", "description":"instance status display name", "enum":[ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ] }, "lifecycleState":{ "description":"The current operation state of the instance", "enum":[ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ], "type":"string" }, "version":{ "description":"Instance version", "type":"string" }, "enableTLS":{ "type":"boolean", "description":"Determines whether to enable or disable TLS with the default load balancer." }, "startPort":{ "description":"External load balancer start port", "type":"integer" }, "instanceFQDN":{ "description":"Instance FQDN indicating external load balancer is used", "type":"string" } } }, "Tags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"array", "items":{ "type":"string", "description":"format key:value" } }, "BlockchainPlatformDetails":{ "description":"Blockchain Platform details", "type":"object", "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Instance display name, can be renamed", "type":"string" }, "timeCreated":{ "description":"The time the the instance was created. A timestamp string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Instance was updated. A timestamp string.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The user who created the instance", "type":"string" }, "createOperationId":{ "description":"The operation ID of the create operation that created the instance", "type":"string" }, "platformRole":{ "description":"Role of platform: Founder or Participant", "type":"string", "enum":[ "Founder", "Participant" ] }, "configuration":{ "description":"Type of compute configuration: Developer or Enterprise", "type":"string", "enum":[ "Developer", "Enterprise" ] }, "version":{ "description":"Instance Version", "type":"string" }, "enableTLS":{ "type":"boolean", "description":"Determines whether to enable or disable TLS with the default load balancer." }, "startPort":{ "description":"External load balancer start port", "type":"integer" }, "instanceFQDN":{ "description":"Instance FQDN indicating external load balancer is used", "type":"string" }, "logging":{ "type":"string", "description":"Logging path on VM" }, "lastOpid":{ "type":"string", "description":"Last operation ID on the instance" }, "serviceEndpoint":{ "description":"Service endpoint URL, valid post-provisioning", "type":"string" }, "lifecycleState":{ "description":"The current operation state of the instance", "enum":[ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ], "type":"string" }, "stateMessage":{ "description":"An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.", "type":"string" }, "status":{ "type":"string", "description":"Instance status", "enum":[ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ] }, "statusDisplayName":{ "type":"string", "description":"instance status display name", "enum":[ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ] }, "cluster":{ "$ref":"#/definitions/BlockchainPlatformCluster" }, "components":{ "type":"array", "description":"All nodes(services) info", "items":{ "$ref":"#/definitions/BlockchainPlatformComponent" } }, "ledgerPlacement":{ "type":"array", "description":"List of (host - ledger location) pairs", "items":{ "$ref":"#/definitions/HostLedgerInfo" } } } }, "BlockchainPlatformCluster":{ "type":"object", "description":"VMs in cluster", "properties":{ "manager":{ "type":"array", "description":"Manager VM list", "items":{ "$ref":"#/definitions/ClusterVM" } }, "crc":{ "type":"array", "description":"CRC VM list", "items":{ "$ref":"#/definitions/ClusterVM" } }, "zk":{ "type":"array", "description":"ZooKeeper or Kafka VM list", "items":{ "$ref":"#/definitions/ClusterVM" } } } }, "ClusterVM":{ "type":"object", "properties":{ "vm":{ "type":"string", "description":"VM host name or IP" }, "vmStatus":{ "type":"string", "enum":[ "up", "down" ], "description":"VM status: up or down" }, "role":{ "type":"string", "description":"VM role in swarm cluster", "enum":[ "admin", "worker" ] } } }, "BlockchainPlatformComponent":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Node(service) name" }, "type":{ "type":"string", "enum":[ "ca", "console", "peer", "orderer", "proxy", "zookeeper", "kafka", "ldap", "prometheus", "lbr", "nodemanager", "authserver", "restproxy" ], "description":"Node(service) type" }, "status":{ "type":"string", "description":"Node(service) status: healthy for all replicas up, unhealthy for any replicas down, down for all replicas down", "enum":[ "healthy", "unhealthy", "down" ] }, "replicas":{ "type":"integer", "description":"Node(service) replicas number" }, "host":{ "type":"array", "description":"All node(service) replicas hosts, may be smaller than the replicas number when any replica is down", "items":{ "type":"string", "description":"VM host name or IP" } } } }, "HostLedgerInfo":{ "type":"object", "properties":{ "host":{ "type":"string", "description":"Host name" }, "sharedDirectory":{ "type":"string", "description":"ledger folder path on the host" } }, "additionalProperties":{ "type":"string", "description":"other dynamically generated orderer and peer name keys and ledger folder path" } }, "OperationStatus":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Instance ID" }, "operationId":{ "type":"string", "description":"Operation ID" }, "operation":{ "type":"string", "description":"Operation querying", "enum":[ "create", "delete", "start", "stop", "update", "patch", "scaleout", "scalein" ] }, "status":{ "type":"string", "enum":[ "norecord", "inprogress", "failed", "successful", "successfulwitherrors", "unknown" ], "description":"For delete, 404 will be returned after it succeeds." }, "details":{ "type":"string", "description":"e.g. step info, fail reason" } } }, "ScaleOutReplicaNumberDetails":{ "type":"object", "description":"One node(service) number to be added", "properties":{ "proxy":{ "type":"integer", "description":"REST proxy replicas number to add" }, "CA":{ "type":"integer", "description":"CA replicas number to add" } } }, "ScaleOutPeerDetails":{ "type":"object", "description":"One peer details to be added", "properties":{ "org":{ "type":"string", "description":"Organization name" }, "role":{ "type":"string", "description":"Peer role", "enum":[ "Member", "Admin" ] }, "logLevel":{ "type":"string", "description":"Peer log level", "enum":[ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ] }, "alias":{ "type":"string", "description":"Peer alias" }, "vm":{ "type":"string", "description":"VM hostname to locate peer" }, "completedLBRPortMapping":{ "type":"boolean", "default":false, "description":"If an external load balancer is used, set this to true to confirm the port mapping configuration in the exteral load balancer is complete." } } }, "ScaleOutOrdererDetails":{ "type":"object", "description":"Orderer details to be added", "properties":{ "org":{ "type":"string", "description":"Organization name" }, "logLevel":{ "type":"string", "description":"Peer log level", "enum":[ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ] }, "vm":{ "type":"string", "description":"VM hostname to locate peer" }, "completedLBRPortMapping":{ "type":"boolean", "default":false, "description":"If an external load balancer is used, set this to true to confirm the port mapping configuration in the exteral load balancer is complete." } } }, "ScaleOutPayload":{ "type":"object", "description":"scaleOut payload", "properties":{ "newVMs":{ "$ref":"#/definitions/ClusterCreationDetails" }, "newReplicas":{ "$ref":"#/definitions/ScaleOutReplicaNumberDetails" }, "newPeers":{ "type":"array", "description":"New peers list", "items":{ "$ref":"#/definitions/ScaleOutPeerDetails" } }, "newOrderers":{ "type":"array", "description":"new Orderers list", "items":{ "$ref":"#/definitions/ScaleOutOrdererDetails" } } } }, "ScaleInNodes":{ "type":"object", "description":"ScaleIn node details", "properties":{ "peer":{ "type":"array", "description":"Peer hostnames", "items":{ "type":"string" } } } }, "ScaleInPayload":{ "type":"object", "description":"scaleIn payload", "properties":{ "nodes":{ "$ref":"#/definitions/ScaleInNodes" } } }, "UpdatePayload":{ "type":"object", "description":"Update a Blockchain Platform instance", "properties":{ "updateLDAPConfig":{ "type":"boolean", "description":"Determines whether the instance should be updated with the active LDAP configuration." }, "updateHSMDetails":{ "$ref":"#/definitions/UpdateHSMDetails" } } }, "InstancePatchPayload":{ "type":"object", "properties":{ "patchId":{ "type":"string", "description":"Patch ID to apply" } } }, "PatchInfoSummary":{ "type":"object", "properties":{ "patchId":{ "type":"string", "description":"Patch ID" }, "displayName":{ "type":"string", "description":"Patch display name" }, "description":{ "type":"string", "description":"Patch description or details" }, "serviceVersion":{ "type":"string", "description":"Patch service version" }, "release":{ "type":"string", "description":"Patch release version" }, "fullVersion":{ "type":"string", "description":"Patch full version" }, "prevVersion":{ "type":"string", "description":"Previous version" }, "rollbackable":{ "type":"boolean", "description":"Is patch able to be rolled back" }, "applicable":{ "type":"boolean", "description":"Is patch able to be applied" }, "status":{ "type":"string", "description":"Patch/rollback status" } } }, "InstancePatchInfoSummary":{ "type":"object", "properties":{ "available":{ "type":"array", "items":{ "$ref":"#/definitions/PatchInfoSummary" } }, "applied":{ "type":"array", "items":{ "$ref":"#/definitions/PatchInfoSummary" } } } }, "PatchTargetInfo":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Target instance ID" }, "instanceName":{ "type":"string", "description":"Target instance display name" }, "version":{ "type":"string", "description":"Target instance version" }, "status":{ "type":"string", "description":"Target instance status" }, "timeCreated":{ "type":"string", "description":"Target instance creation date" } } }, "PatchApplyPayload":{ "type":"array", "description":"List of patch target instance IDs", "items":{ "type":"string" } }, "PatchApplyStatus":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Patch applied instance ID" }, "instanceName":{ "type":"string", "description":"Patch applied instance display name" }, "status":{ "type":"string", "description":"Patch application request status", "enum":[ "Success", "Failure" ] }, "statusURL":{ "type":"string", "description":"Patch request status URL" }, "statusMessage":{ "type":"string", "description":"Patch status message" } } }, "PatchApplySummary":{ "type":"object", "properties":{ "patchId":{ "type":"string", "description":"Patch ID that was applied" }, "applyStatus":{ "type":"array", "description":"Patch application request status for all targets", "items":{ "$ref":"#/definitions/PatchApplyStatus" } } } }, "LBRPortMappingWrapper":{ "description":"External load balancer port mapping list wrapper", "type":"object", "properties":{ "portMapping":{ "description":"List of external load balancer Port mapping", "type":"array", "items":{ "$ref":"#/definitions/LBRPortMapping" } } } }, "LBRPortMapping":{ "description":"External load balancer port mapping", "type":"object", "properties":{ "serviceName":{ "description":"Service name", "type":"string" }, "externalPort":{ "description":"External port number", "type":"integer" }, "externalHost":{ "description":"External host", "type":"string" }, "enableSSL":{ "description":"Enable or disable SSL for a port", "type":"boolean" }, "internalPort":{ "description":"Internal port number", "type":"integer" }, "internalHost":{ "description":"Internal host", "type":"string" } } }, "ReleaseBuildInfo":{ "description":"Release Build Information", "type":"object", "properties":{ "version":{ "type":"string" }, "build.date":{ "type":"string" } } }, "LdapConfigPayload":{ "description":"LDAP Configuration details", "type":"object", "properties":{ "ldapId":{ "type":"string" }, "ldapName":{ "type":"string" }, "ldapType":{ "type":"string" }, "ldapHost":{ "type":"string" }, "ldapPort":{ "type":"integer" }, "ldapTLSEnabled":{ "type":"boolean" }, "ldapBaseDN":{ "type":"string" }, "ldapBindDN":{ "type":"string" }, "ldapBindPassword":{ "type":"string" }, "userNameAttribute":{ "type":"string" }, "userClassName":{ "type":"string" }, "groupNameAttribute":{ "type":"string" }, "groupMembershipAttribute":{ "type":"string" }, "groupClassName":{ "type":"string" }, "connectTimeout":{ "type":"integer" }, "bpmUserGroup":{ "type":"string", "description":"Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain Platform instances. Required only for AD." }, "caAdminGroup":{ "type":"string", "description":"Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain Platform instance. Required only for AD." }, "instanceUserGroup":{ "type":"string", "description":"Users with membership to this group can view the instances console using the UI or REST APIs. They will not be able to perform any other operations. Required only for AD." }, "instanceAdminGroup":{ "type":"string", "description":"Users with membership to this group can have full access to the instance console and perform all the operations on it using the UI or REST APIs. Required only for AD." }, "restProxyGroup":{ "type":"string", "description":"Users with membership to this group can interact with the instance using REST APIs. Required only for AD." }, "backupHosts":{ "type":"array", "description":"List of backup domain controllers for AD.", "items":{ "type":"string" } } } }, "LdapConfigDetail":{ "description":"LDAP Configuration details", "type":"object", "properties":{ "ldapId":{ "type":"string" }, "ldapName":{ "type":"string" }, "ldapType":{ "type":"string" }, "ldapHost":{ "type":"string" }, "ldapPort":{ "type":"integer" }, "ldapTLSEnabled":{ "type":"boolean" }, "ldapTLSCACert":{ "type":"string" }, "ldapBaseDN":{ "type":"string" }, "ldapBindDN":{ "type":"string" }, "ldapBindPassword":{ "type":"string" }, "userNameAttribute":{ "type":"string" }, "userClassName":{ "type":"string" }, "groupNameAttribute":{ "type":"string" }, "groupMembershipAttribute":{ "type":"string" }, "groupClassName":{ "type":"string" }, "connectTimeout":{ "type":"integer" }, "tlsRootCACertFileName":{ "type":"string" }, "bpmUserGroup":{ "type":"string", "description":"Users with membership to this group can login and have full access Blockchain Platform Manager (this console) and perform life cycle operations on the Blockchain Platform instances. Required only for AD." }, "caAdminGroup":{ "type":"string", "description":"Users part of this group will have the authority to register other users. CA Administrator privilege is also needed to create a new Blockchain Platform instance. Required only for AD." }, "instanceUserGroup":{ "type":"string", "description":"Users with membership to this group can view the instances console using the UI or REST APIs. They will not be able to perform any other operations. Required only for AD." }, "instanceAdminGroup":{ "type":"string", "description":"Users with membership to this group can have full access to the instance console and perform all the operations on it using the UI or REST APIs. Required only for AD." }, "restProxyGroup":{ "type":"string", "description":"Users with membership to this group can interact with the instance using REST APIs. Required only for AD." }, "backupHosts":{ "type":"array", "description":"List of backup domain controllers for AD.", "items":{ "type":"string" } } } }, "CpConfigDetail":{ "description":"Control plane configuration details", "type":"object", "properties":{ "cpConfigName":{ "type":"string" }, "cpConfigValue":{ "type":"string" } } }, "CpConfigMap":{ "description":"Control plane configuration map", "type":"object", "properties":{ "controlPlaneId":{ "type":"string", "description":"Blockchain Platform Manager ID" }, "activeLdapId":{ "type":"string", "description":"Active LDAP configuration ID" }, "additionalProperties":{ "type":"string", "description":"Other Control Plane Config name and value pairs" } } }, "BlockchainPlatformInstanceStatus":{ "description":"Blockchain Platform instance status", "type":"object", "properties":{ "instanceId":{ "type":"string" }, "status":{ "type":"string" }, "details":{ "type":"string" } } }, "PostLoginAuthConfig":{ "description":"Post-login authorization configuration map", "type":"object", "properties":{ "ldapConfigReminderPopup":{ "type":"boolean" }, "defaultUserDisabled":{ "type":"boolean" } } }, "BasicAuth":{ "description":"Basic authentication", "type":"object", "properties":{ "userName":{ "type":"string" }, "userPassword":{ "type":"string" } } }, "PatchStatusResponse":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string", "enum":[ "idle", "patching", "done" ] }, "message":{ "type":"string" } } }, "InstanceActivityInfoSummary":{ "description":"Activities for a Blockchain Platform Instance", "type":"object", "properties":{ "activities":{ "description":"List activities associated with a blockchain platform instance", "type":"array", "items":{ "$ref":"#/definitions/ActivityInfoSummary" } } } }, "ActivityInfoSummary":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Platform instance ID" }, "instanceName":{ "type":"string", "description":"Name of the platform instance" }, "operation":{ "type":"string", "description":"Operation name" }, "operationId":{ "type":"string", "description":"Operation ID" }, "operationStatus":{ "type":"string", "description":"Operation status" }, "operationStartTime":{ "type":"string", "format":"date-time", "description":"Time when the operation started" }, "lastUpdatedTime":{ "type":"string", "format":"date-time", "description":"Most recent time when the operation status was tracked" }, "initiatedBy":{ "type":"string", "description":"User who initiated the activity" }, "details":{ "type":"string", "description":"Detailed message from the latest status of the operation" } } }, "LogLevelPayload":{ "type":"object", "description":"Updates the Blockchain Platform Manager log level", "required":[ "level" ], "properties":{ "level":{ "type":"string", "enum":[ "INFO", "DEBUG", "TRACE" ] } } }, "TestHsmPayload":{ "type":"object", "description":"Details required to communicate with the HSM", "required":[ "platformHosts", "hsmConfiguration" ], "properties":{ "platformHosts":{ "type":"array", "description":"A list of host names or IP addresses of the VMs to test from. The list must be IP addresses if a VM has multiple IP addresses. The list must include the component manager VM.", "items":{ "type":"string" } }, "hsmConfiguration":{ "$ref":"#/definitions/HSMDetails" } } }, "AnyValue":{ }, "encode":{ "type":"string", "enum":[ "UTF-8", "JSON", "base64" ] }, "returnCode":{ "type":"string", "enum":[ "Success", "Failure" ] }, "EventSubscription":{ "type":"object", "required":[ "type", "callbackURL", "callbackTLSCerts" ], "properties":{ "role":{ "description":"Name of Fabric enrollment to be used", "type":"string" }, "type":{ "description":"Event type to subscribe to", "type":"string", "enum":[ "block", "filteredblock", "transaction", "chaincode" ] }, "callbackURL":{ "description":"Callback URL", "type":"string" }, "callbackTLSCerts":{ "type":"object", "properties":{ "caCert":{ "type":"string" }, "clientCert":{ "type":"string" }, "keyPassword":{ "type":"string" } } }, "expires":{ "description":"Expiration of the subscription", "type":"string" }, "txid":{ "description":"ID of the transaction", "type":"string" }, "chaincode":{ "description":"Name of the chaincode", "type":"string" }, "event":{ "description":"Name of the event", "type":"string" }, "seek":{ "description":"Start position of the event. Only used for type \"block\" and \"filteredblock\"", "type":"string", "enum":[ "oldest", "newest", "from" ] }, "block":{ "description":"Number of the block", "type":"integer", "format":"int64" }, "encode":{ "description":"When the event type is chaincode, the response payload can be returned either as base64 or raw. The default is base64.", "type":"string", "enum":[ "base64", "raw" ] } } }, "UnEventSubscription":{ "type":"object", "required":[ "subid" ], "properties":{ "subid":{ "description":"ID of the subscription when operation succeeds", "type":"string" }, "status":{ "type":"string" }, "errorMessage":{ "type":"string" } } } }, "parameters":{ "BlockchainPlatformIdentifierPathParam":{ "name":"id", "type":"string", "in":"path", "required":true, "description":"Unique platform instance identifier" }, "IncludeSummaryQueryParam":{ "name":"includeSummary", "in":"query", "type":"string", "enum":[ true, false ], "description":"Include instances summary: true or false" }, "IfMatchHeader":{ "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "in":"header", "name":"if-match", "required":false, "type":"string" }, "PatchIdentifierPathParam":{ "name":"patchId", "type":"string", "in":"path", "required":true, "description":"Unique patch identifier" }, "InstancePatchTypeParam":{ "name":"type", "in":"query", "type":"string", "enum":[ "Applied", "Available", "All" ], "description":"The type of patch for an instance: Applied, Available, or All. All includes Applied and Available." }, "DataRetentionPolicyParam":{ "name":"retainData", "in":"query", "type":"string", "enum":[ true, false ], "description":"Retain user data: either true or false. Default is true." }, "ForceDeleteParam":{ "name":"force", "in":"query", "type":"string", "enum":[ true, false ], "description":"Force Delete an instance: either true or false. Default is false." }, "LdapConfigIdentifierPathParam":{ "name":"id", "type":"string", "in":"path", "required":true, "description":"Unique LDAP configuration identifier" }, "CPConfigIdentifierPathParam":{ "name":"configName", "type":"string", "in":"path", "required":true, "description":"Unique control plane configuration identifier" }, "InstanceNameTextQueryParam":{ "name":"instanceNameText", "in":"query", "type":"string", "description":"Instance name text to be used as search criteria" }, "OperationsQueryParam":{ "name":"operations", "in":"query", "type":"string", "description":"A comma-separated list of operation types for which activities are to be retrieved" }, "FromDateQueryParam":{ "name":"fromDate", "in":"query", "type":"string", "description":"Lower bound of date range search criteria in format yyyy-MM-dd" }, "ToDateQueryParam":{ "name":"toDate", "in":"query", "type":"string", "description":"Higher bound of date range search criteria in format yyyy-MM-dd" }, "PlatformHostsQueryParam":{ "name":"platformHosts", "in":"query", "required":true, "type":"string", "description":"List of comma separated platform hosts" }, "PlatformHostQueryParam":{ "name":"platformHosts", "in":"query", "required":true, "type":"string", "description":"Platform host" }, "LoadBalancerFqdnQueryParam":{ "name":"lbrFqdn", "in":"query", "required":true, "type":"string", "description":"External load balancer host" }, "StartPortQueryParam":{ "name":"startPort", "in":"query", "required":false, "type":"integer", "description":"Starting port for external load balancer port mapping" }, "PeerCountQueryParam":{ "name":"peerCount", "in":"query", "required":false, "type":"integer", "description":"Number of peers to be created." }, "ComponentTypeQueryParam":{ "name":"componentType", "in":"query", "required":true, "type":"string", "description":"Component type for scaleout", "enum":[ "peer", "orderer" ] } }, "responses":{ "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" } }, "409":{ "description":"Operation conflict", "schema":{ "$ref":"#/definitions/Error" } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" } }, "403":{ "description":"Forbidden" } } }