{ "swagger":"2.0", "x-oracle-package":"com.oracle.blockchain", "x-obmcs-endpoint-template":"https://blockchain.{region}.oci.{secondLevelDomain}", "x-obmcs-splat":{ "version":"1.0", "services":{ "Blockchain-Dev":{ "audit":{ "defaultMode":"automated", "eventSource":"oracle-blockchain-platform-api" } } } }, "info":{ "title":"REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure", "description":"Use the Oracle Blockchain Platform REST API to programmatically query and invoke chaincode transactions, and to manage your blockchain network.", "version":"2025.12.19", "x-summary":"Use the Oracle Blockchain Platform REST API to programmatically query and invoke chaincode transactions, and to manage your blockchain network." }, "schemes":[ "http", "https" ], "produces":[ "application/json" ], "x-anchors":{ "x-headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "retry-after":{ "type":"number", "format":"float", "description":"A decimal number representing the number of seconds the client should wait before polling this endpoint again." } }, "x-properties":{ "definedTags":{ "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only string, integer and boolean types are supported.\n" } } }, "freeformTags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"object", "additionalProperties":{ "type":"string" } } } }, "paths":{ "/20191010/blockchainPlatforms":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "operationType":"CREATE", "resources":{ "blockchainplatform":{ "serviceResourceName":"BlockchainPlatform", "targetCompartmentId":"request.body.compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":60 } }, "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"CreateBlockchainPlatform", "summary":"Create a New Blockchain Platform", "description":"Creates a new Blockchain Platform. platformVersion is the parameter which defines the Hyperledger Fabric version as v2.2.4 or v1.4.7, that will be used for creating an instance. Values are:\n\nIf no platformVersion is passed, the default is v2.2.4.", "parameters":[ { "name":"CreateBlockchainPlatformDetails", "description":"Details for the new service.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateBlockchainPlatformDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/BlockchainPlatform", "responses":{ "202":{ "description":"The platform will be created.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-post", "x-filename-id":"20191010-blockchainplatforms-post" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "listingEnhancements":false, "maximumAttemptCount":3 }, "operationId":"ListBlockchainPlatforms", "summary":"List Blockchain Platforms", "description":"Returns a list Blockchain Platform instances in a compartment.", "parameters":[ { "$ref":"#/parameters/CompartmentIdQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/BlockchainPlatformLifecycleStateQueryParam" } ], "x-related-resource":"#/definitions/BlockchainPlatform", "responses":{ "200":{ "description":"Gets list of Blockchain Platform instances", "schema":{ "$ref":"#/definitions/BlockchainPlatformCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-get", "x-filename-id":"20191010-blockchainplatforms-get" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"GetBlockchainPlatform", "summary":"Get Blockchain Platform Information", "description":"Gets information about a Blockchain Platform identified by the specific ID.\n Note that in version 25.4.1 a bug exists which causes the storageUsedInTBs field to always return 0.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Retrieves the service with the given ID", "schema":{ "$ref":"#/definitions/BlockchainPlatform" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-get", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-get" }, "put":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"UpdateBlockchainPlatform", "summary":"Update Blockchain Platform", "description":"Updates a particular Blockchain Platform.\n Note that changing the storage size or OCPU parameters will generate an error in intances created with version 25.4.1. Existing instances from prior versions will still support this scaling.", "parameters":[ { "name":"UpdateBlockchainPlatformDetails", "description":"The Blockchain Platform fields to update. Fields that are not provided will not be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateBlockchainPlatformDetails" } }, { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/BlockchainPlatform", "responses":{ "202":{ "description":"The update request was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-put", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-put" }, "delete":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "resources":{ "blockchainplatform":{ "serviceResourceName":"BlockchainPlatform", "targetCompartmentId":"downstream.getOr404('Blockchain-Dev','GetBlockchainPlatform',request.resourceId).compartmentId", "resourceOcid":"request.resourceId", "actionKind":"delete", "reconciliationCanStartAfterSecs":60 } }, "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"DeleteBlockchainPlatform", "summary":"Delete a Blockchain Platform", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Delete a particular instance of Blockchain Platform.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "responses":{ "202":{ "description":"Accepted the request. The platform will be deleted.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-delete", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-delete" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/changeCompartment":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "resources":{ "blockchainplatform":{ "serviceResourceName":"BlockchainPlatform", "targetCompartmentId":"request.body.compartmentId", "resourceOcid":"request.resourceId", "actionKind":"move", "reconciliationCanStartAfterSecs":60 } }, "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"ChangeBlockchainPlatformCompartment", "summary":"Change Blockchain Platform Compartment", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Changes the Blockchain Platform compartment.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"ChangeBlockchainPlatformCompartmentDetails", "required":true, "description":"Input payload to move the resource to a different compartment.\n", "schema":{ "$ref":"#/definitions/ChangeBlockchainPlatformCompartmentDetails" }, "in":"body" } ], "responses":{ "202":{ "description":"The request to move compartments was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-actions-changeCompartment-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-actions-changecompartment-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/start":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"StartBlockchainPlatform", "summary":"Start a Blockchain Platform", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Starts a Blockchain Platform.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "responses":{ "202":{ "description":"Accepted the request. The Blockchain Platform will be started.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-actions-start-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-actions-start-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/stop":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"StopBlockchainPlatform", "summary":"Stop Blockchain Platform", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Stops a Blockchain Platform.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "responses":{ "202":{ "description":"Accepted the request. The Blockchain Platform will be stopped.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-actions-stop-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-actions-stop-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/upgrade":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"UpgradeBlockchainPlatform", "summary":"Upgrade the Blockchain Platform version", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Initiate the upgrade of the version of your Blockchain Platform", "parameters":[ { "name":"UpgradeBlockchainPlatformDetails", "description":"Details for the new version to which it will be upgraded.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpgradeBlockchainPlatformDetails" } }, { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "responses":{ "202":{ "description":"Accepted the request. The Blockchain Platform version will be upgraded.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-actions-upgrade-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-actions-upgrade-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/peers":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true, "listingEnhancements":false }, "operationId":"ListPeers", "summary":"List Blockchain Platform Peers", "x-related-resource":"#/definitions/Peer", "description":"Lists all Blockchain Platform peers.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" } ], "responses":{ "200":{ "description":"Gets list of Blockchain Platform peers", "schema":{ "$ref":"#/definitions/PeerCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-peers-get", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-peers-get" }, "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"CreatePeer", "summary":"Create Blockchain Platform Peer", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Creates a Blockchain Platform peer.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"CreatePeerDetails", "required":true, "description":"Input payload to create a Blockchain Platform peer. The payload cannot be empty.\n", "schema":{ "$ref":"#/definitions/CreatePeerDetails" }, "in":"body" } ], "responses":{ "202":{ "description":"The request to create a peer was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-peers-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-peers-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/peers/{peerId}":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"GetPeer", "summary":"Get Blockchain Platform Peer", "description":"Gets information about a peer identified by the specific ID.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/PeerIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Retrieves the peer with the given ID", "schema":{ "$ref":"#/definitions/Peer" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-peers-{peerId}-get", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-peers-peerid-get" }, "put":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"UpdatePeer", "summary":"Update Blockchain Platform Peer", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Update a Blockchain Platform peer.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/PeerIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"UpdatePeerDetails", "required":true, "description":"Input payload to update a Blockchain Platform peer. The payload cannot be empty.\n", "schema":{ "$ref":"#/definitions/UpdatePeerDetails" }, "in":"body" } ], "responses":{ "202":{ "description":"The request to update a peer was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-peers-{peerId}-put", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-peers-peerid-put" }, "delete":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"DeletePeer", "summary":"Delete Blockchain Platform Peer", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Delete a particular peer of a Blockchain Platform.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/PeerIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "responses":{ "202":{ "description":"Accepted the request. The peer will be deleted.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-peers-{peerId}-delete", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-peers-peerid-delete" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/osns":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true, "listingEnhancements":false }, "operationId":"ListOsns", "summary":"List Blockchain Platform OSNs", "x-related-resource":"#/definitions/Osn", "description":"Lists all Blockchain Platform ordering service nodes (OSNs).", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" } ], "responses":{ "200":{ "description":"Gets list of Blockchain Platform OSNs", "schema":{ "$ref":"#/definitions/OsnCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-osns-get", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-osns-get" }, "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"CreateOsn", "summary":"Create Blockchain Platform OSN", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Create a Blockchain Platform ordering service node (OSN).", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"CreateOsnDetails", "required":true, "description":"Input payload to create Blockchain Platform OSN. The payload cannot be empty.\n", "schema":{ "$ref":"#/definitions/CreateOsnDetails" }, "in":"body" } ], "responses":{ "202":{ "description":"The request to create an OSN was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-osns-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-osns-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/osns/{osnId}":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"GetOsn", "summary":"Get Blockchain Platform OSN", "description":"Gets information about an ordering service node (OSN) identified by the specific ID.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/OsnIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Retrieves the OSN with the given ID", "schema":{ "$ref":"#/definitions/Osn" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-osns-{osnId}-get", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-osns-osnid-get" }, "put":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"UpdateOsn", "summary":"Update Blockchain Platform OSN", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Update the Blockchain Platform ordering service node (OSN).", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/OsnIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"UpdateOsnDetails", "required":true, "description":"Input payload to update a Blockchain Platform OSN. The payload cannot be empty.\n", "schema":{ "$ref":"#/definitions/UpdateOsnDetails" }, "in":"body" } ], "responses":{ "202":{ "description":"The request to update an OSN was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-osns-{osnId}-put", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-osns-osnid-put" }, "delete":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"DeleteOsn", "summary":"Delete Blockchain Platform OSN", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Delete a particular ordering service node (OSN) of a Blockchain Platform", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/OsnIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "responses":{ "202":{ "description":"Accepted the request. The OSN will be deleted.", "headers":{ "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-osns-{osnId}-delete", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-osns-osnid-delete" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/scale":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "supportsOpcRetryToken":true }, "operationId":"ScaleBlockchainPlatform", "summary":"Scale Blockchain Platform", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Internal use only. Scale the Blockchain Platform.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"ScaleBlockchainPlatformDetails", "required":true, "description":"Input payload to scaleout Blockchain Platform. The payload cannot be empty.\n", "schema":{ "$ref":"#/definitions/ScaleBlockchainPlatformDetails" }, "in":"body" } ], "responses":{ "202":{ "description":"The request to scaleout was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-actions-scale-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-actions-scale-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/scale/preview":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"PreviewScaleBlockchainPlatform", "summary":"Preview Scale Blockchain Platform", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"Internal use only. Preview the scaleout of the Blockchain Platform.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "name":"ScaleBlockchainPlatformDetails", "required":true, "description":"Input payload to scaleout Blockchain Platform. The payload cannot be empty.\n", "schema":{ "$ref":"#/definitions/ScaleBlockchainPlatformDetails" }, "in":"body" } ], "responses":{ "200":{ "description":"Provides a preview of a scale operation", "schema":{ "$ref":"#/definitions/ScaledBlockchainPlatformPreview" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-actions-scale-preview-post", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-actions-scale-preview-post" } }, "/20191010/blockchainPlatforms/{blockchainPlatformId}/patches":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3, "listingEnhancements":false }, "operationId":"ListBlockchainPlatformPatches", "summary":"List BlockchainPlatform Patches", "x-related-resource":"#/definitions/BlockchainPlatform", "description":"List Blockchain Platform patches", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdPathParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Gets list of available patches for a Blockchain Platform", "schema":{ "$ref":"#/definitions/BlockchainPlatformPatchCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the page parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-blockchainPlatforms-{blockchainPlatformId}-patches-get", "x-filename-id":"20191010-blockchainplatforms-blockchainplatformid-patches-get" } }, "/20191010/workRequests/{workRequestId}":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"GetWorkRequest", "summary":"Get Work Request Status", "x-related-resource":"#/definitions/WorkRequest", "description":"Gets the status of the work request with the given ID.", "parameters":[ { "$ref":"#/parameters/WorkRequestIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "schema":{ "$ref":"#/definitions/WorkRequest" }, "description":"The detail of the work request.", "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "retry-after":{ "type":"number", "format":"float", "description":"A decimal number representing the number of seconds the client should wait before polling this endpoint again." } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-workRequests-{workRequestId}-get", "x-filename-id":"20191010-workrequests-workrequestid-get" }, "delete":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "maximumAttemptCount":3 }, "operationId":"DeleteWorkRequest", "summary":"Delete Work Request", "x-related-resource":"#/definitions/WorkRequest", "description":"Attempts to cancel the work request with the given ID.", "parameters":[ { "$ref":"#/parameters/WorkRequestIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "responses":{ "202":{ "description":"The request to delete was accepted.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-workRequests-{workRequestId}-delete", "x-filename-id":"20191010-workrequests-workrequestid-delete" } }, "/20191010/workRequests":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "listingEnhancements":false, "maximumAttemptCount":3 }, "operationId":"ListWorkRequests", "summary":"List Work Requests", "x-related-resource":"#/definitions/WorkRequest", "description":"Lists the work requests in a compartment.\n", "parameters":[ { "$ref":"#/parameters/CompartmentIdQueryParam" }, { "$ref":"#/parameters/BlockchainPlatformIdQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParamWorkRequests" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" } ], "responses":{ "200":{ "description":"The list of work requests.", "schema":{ "$ref":"#/definitions/WorkRequestCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-workRequests-get", "x-filename-id":"20191010-workrequests-get" } }, "/20191010/workRequests/{workRequestId}/errors":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "listingEnhancements":false, "maximumAttemptCount":3 }, "operationId":"ListWorkRequestErrors", "summary":"Lists Work Request Errors", "x-related-resource":"#/definitions/WorkRequestError", "description":"Returns a paginated list of errors for a given work request.\n", "parameters":[ { "$ref":"#/parameters/WorkRequestIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" } ], "responses":{ "200":{ "description":"List of work request errors.", "headers":{ "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the page parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/WorkRequestErrorCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-workRequests-{workRequestId}-errors-get", "x-filename-id":"20191010-workrequests-workrequestid-errors-get" } }, "/20191010/workRequests/{workRequestId}/logs":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "Blockchain-Dev" ], "listingEnhancements":false, "maximumAttemptCount":3 }, "operationId":"ListWorkRequestLogs", "summary":"List Work Request Logs", "x-related-resource":"#/definitions/WorkRequestLogEntry", "description":"Returns a paginated list of logs for a given work request.\n", "parameters":[ { "$ref":"#/parameters/WorkRequestIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" } ], "responses":{ "200":{ "description":"List of work request logs.", "headers":{ "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/WorkRequestLogEntryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"20191010-workRequests-{workRequestId}-logs-get", "x-filename-id":"20191010-workrequests-workrequestid-logs-get" } }, "/restproxy/api/version":{ "get":{ "tags":[ "Application Operations" ], "summary":"Get Version of REST Proxy API", "description":"Get the version of the REST proxy API.", "produces":[ "application/json" ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode", "result" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string" }, "result":{ "type":"string" } } } } }, "x-internal-id":"restproxy-api-version-get", "x-filename-id":"restproxy-api-version-get" } }, "/restproxy/api/v2/channels/{channelName}/transaction-id":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Transactions" ], "summary":"Get a New Transaction ID and Nonce", "description":"Request an asynchronous-mode transaction ID and nonce by channel name and enrollment. The transaction will be invoked later in asynchronous mode.", "operationId":"getTransactionId", "produces":[ "application/json" ], "parameters":[ { "name":"role", "in":"query", "description":"Name of the Hyperledger 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" ], "properties":{ "txid":{ "description":"Transaction ID", "type":"string" }, "nonce":{ "description":"Nonce value", "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-{channelName}-transaction-id-get", "x-filename-id":"restproxy-api-v2-channels-channelname-transaction-id-get" } }, "/restproxy/api/v2/channels/{channelName}/transactions":{ "parameters":[ { "name":"channelName", "in":"path", "description":"Name of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Application Operations/Transactions" ], "summary":"Send a Transaction", "description":"This endpoint is used to send a transaction. Note that for asynchronous transactions, we suggest using the new Send an Asynchronous Transaction endpoint.", "operationId":"sendTransaction", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"transaction request", "description":"Request to invoke a transaction", "required":true, "schema":{ "type":"object", "required":[ "chaincode", "args" ], "properties":{ "role":{ "description":"Name of the Hyperledger Fabric enrollment to be used", "type":"string" }, "txid":{ "description":"ID of the transaction", "type":"string" }, "nonce":{ "description":"Nonce for the transaction", "type":"string" }, "chaincode":{ "description":"ID of the chaincode to invoke", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "endorsers":{ "description":"Endorsers 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" } }, "sync":{ "description":"Whether to invoke the chaincode synchronously.", "type":"boolean", "default":false }, "isInit":{ "description":"Specifies if it is an initialization request", "type":"boolean", "default":false }, "sameOrgEndorser":{ "description":"Specifies if it should select endorsers of this organization only. When set to true, the endorsers field cannot be specified.", "type":"boolean", "default":false } } } } ], "responses":{ "201":{ "description":"Operation successful for synchronous transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "required":[ "txid", "payload", "encode" ], "properties":{ "txid":{ "type":"string" }, "message":{ "type":"string" }, "payload":{ "$ref":"#/definitions/AnyValue" }, "encode":{ "$ref":"#/definitions/encode" }, "sourceURL":{ "description":"Returns the URL of the peer that reported the transaction status to the REST proxy", "type":"string" } } } } } }, "202":{ "description":"Operation successful for asynchronous transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "required":[ "txid" ], "properties":{ "txid":{ "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-{channelName}-transactions-post", "x-filename-id":"restproxy-api-v2-channels-channelname-transactions-post" } }, "/restproxy/api/v2/channels/{channelName}/chaincode-queries":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Application Operations/Transactions" ], "summary":"Query a Chaincode", "description":"Query a chaincode. This endpoint is used to invoke any query function supported by the chaincode application that is already installed and instantiated on a channel.", "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 Hyperledger 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" }, "sameOrgEndorser":{ "description":"Specify if it should select a peer of this organization only. When set to true, the peer field cannot be specified.", "type":"boolean", "default":false } } } } ], "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-{channelName}-chaincode-queries-post", "x-filename-id":"restproxy-api-v2-channels-channelname-chaincode-queries-post" } }, "/restproxy/api/v2/channels/{channelName}/transactions/{transactionId}":{ "parameters":[ { "name":"channelName", "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":"This endpoint is used to get the status and other details of a transaction based on its transaction ID.", "operationId":"getTransactionInfo", "produces":[ "application/json" ], "parameters":[ { "name":"role", "in":"query", "description":"Name of the Hyperledger 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-{channelName}-transactions-{transactionId}-get", "x-filename-id":"restproxy-api-v2-channels-channelname-transactions-transactionid-get" } }, "/restproxy/api/v2/atomicTransactions":{ "post":{ "tags":[ "Application Operations/Atomic Transactions" ], "summary":"Invoke Atomic Transaction", "description":"Invoke an atomic transaction. This allows you to have multiple transactions spanning multiple channels which are committed atomically - either all of them are committed successfully, or none of them are commited.", "operationId":"invokeAtomicTransaction", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"atomic transaction invoke request", "description":"Request to invoke a transaction", "required":true, "schema":{ "type":"object", "required":[ "transactions", "isolationLevel" ], "properties":{ "transactions":{ "description":"Array of individual transactions to process", "type":"array", "items":{ "$ref":"#/definitions/atomicTransactionInvokeReq" } }, "lrc":{ "$ref":"#/definitions/atomicTransactionLRCReq" }, "isolationLevel":{ "description":"Isolation Level for the atomic transaction", "type":"string", "enum":[ "serializable", "readCommitted" ] }, "prepareTimeout":{ "description":"Timeout in ms for the prepare phase of atomic transactions", "type":"integer", "format":"int64", "default":30000 }, "sync":{ "description":"Determines whether the requests waits for a response or return immediately with a global transaction ID.", "type":"boolean", "default":true }, "parallelPrepare":{ "description":"Determines whether to perform the prepare phase for transactions in parallel.", "type":"boolean", "default":false }, "role":{ "description":"Which Hyperledger Fabric enrollment should be used", "type":"string" } } } } ], "responses":{ "201":{ "description":"Successful operation for synchronous transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "$ref":"#/definitions/atomicTransactionResults" } } } }, "202":{ "description":"Successful operation for asynchronous transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "properties":{ "globalTxid":{ "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-atomicTransactions-post", "x-filename-id":"restproxy-api-v2-atomictransactions-post" } }, "/restproxy/api/v2/atomicTransactions/{globalTransactionId}":{ "parameters":[ { "name":"globalTransactionId", "in":"path", "description":"Global transaction ID", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Atomic Transactions" ], "summary":"Query Atomic Transaction", "description":"Query an atomic transaction. This endpoint is used to query the status of an atomic transaction by providing the global (atomic) transaction ID.", "operationId":"queryAtomicTransaction", "produces":[ "application/json" ], "parameters":[ { "name":"role", "in":"query", "description":"Which Hyperledger Fabric enrollment should be used", "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string" }, "result":{ "$ref":"#/definitions/atomicTransactionResults" } } } }, "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-atomicTransactions-{globalTransactionId}-get", "x-filename-id":"restproxy-api-v2-atomictransactions-globaltransactionid-get" }, "put":{ "tags":[ "Application Operations/Atomic Transactions" ], "summary":"Unlock Atomic Transaction", "description":"Unlock an atomic transaction. Sends a request to unlock chaincode keys locked by a previous atomic transaction.", "operationId":"unlockAtomicTransaction", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"atomic transaction unlock request", "description":"Request to unlock chaincode keys locked by a previous atomic transaction", "required":true, "schema":{ "type":"object", "required":[ "chaincode", "channel", "prepareTxid" ], "properties":{ "channel":{ "description":"ID of the channel to invoke the transaction", "type":"string" }, "chaincode":{ "description":"ID of the chaincode to invoke", "type":"string" }, "endorsers":{ "description":"Endorsers for the chaincode", "type":"array", "items":{ "type":"string" } }, "timeout":{ "description":"Timeout in ms for the chaincode to invoke", "type":"integer", "format":"int64" }, "prepareTxid":{ "description":"Transaction ID of the prepared transaction", "type":"string" }, "isCommit":{ "description":"Specify whether to commit or rollback the transaction. Optional.", "type":"boolean", "default":false } } } } ], "responses":{ "201":{ "description":"Successful operation for synchronous transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "required":[ "txid", "payload", "encode" ], "properties":{ "txid":{ "type":"string" }, "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-atomicTransactions-{globalTransactionId}-put", "x-filename-id":"restproxy-api-v2-atomictransactions-globaltransactionid-put" } }, "/restproxy/api/v2/channels/{channelName}/transactions/async":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Application Operations/Transactions" ], "summary":"Send an Asynchronous Transaction", "description":"Sends an asynchronous transaction. This improved version of the Send a Transaction endpoint relies on a rest proxy generated tracking ID instead of the Hyperledger Fabric transaction ID to track the transaction to completion, allowing for retries in additional commit failure scenarios.", "operationId":"sendAsyncTransaction", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"transaction request", "description":"Request to invoke an asynchronous transaction", "required":true, "schema":{ "type":"object", "required":[ "chaincode", "args" ], "properties":{ "role":{ "description":"Which Hyperledger Fabric enrollment should be used", "type":"string" }, "chaincode":{ "description":"ID of the chaincode to invoke", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "endorsers":{ "description":"Endorsers 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" } }, "isInit":{ "description":"Whether it is an initialization request", "type":"boolean", "default":false }, "sameOrgEndorser":{ "description":"Whether it should select endorsers of this organization only. When set to true, the endorsers field cannot be specified.", "type":"boolean", "default":false }, "retries":{ "description":"Number of retries for endorsement and certain commit failures", "type":"integer", "format":"int64", "default":3 } } } } ], "responses":{ "202":{ "description":"Successful operation for asynchronous transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "required":[ "trackingID" ], "properties":{ "trackingID":{ "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-{channelName}-transactions-async-post", "x-filename-id":"restproxy-api-v2-channels-channelname-transactions-async-post" } }, "/restproxy/api/v2/channels/{channelName}/transactions/async/{trackingID}":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" }, { "name":"trackingID", "in":"path", "description":"Tracking ID of the asynchronous transaction returned by the rest proxy", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Transactions" ], "summary":"Get Response of Asynchronous Transaction", "description":"Gets the response of an asynchronous transaction.", "operationId":"getAsyncTransactionInfo", "produces":[ "application/json" ], "parameters":[ { "name":"role", "in":"query", "description":"Which Hyperledger Fabric enrollment should be used", "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "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" }, "blockNumber":{ "type":"integer" }, "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-{channelName}-transactions-async-{trackingID}-get", "x-filename-id":"restproxy-api-v2-channels-channelname-transactions-async-trackingid-get" } }, "/restproxy/api/v2/channels/{channelName}/scheduleTransactions":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Application Operations/Transactions" ], "summary":"Schedule Transaction to Run", "description":"Schedule a transaction to run periodically.", "operationId":"scheduleTransactions", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"transaction scheduler request", "description":"Request to schedule a transaction", "required":true, "schema":{ "type":"object", "required":[ "chaincode", "args", "expiry", "intervalType" ], "properties":{ "role":{ "description":"Specify which Hyperledger Fabric enrollment should be used", "type":"string" }, "chaincode":{ "description":"ID of the chaincode to invoke", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "endorsers":{ "description":"Endorsers 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" } }, "sameOrgEndorser":{ "description":"Specify whether it should select endorsers of this org only. When set to true, endorsers field cannot be specified.", "type":"boolean", "default":false }, "expiry":{ "description":"Expiration of the scheduler. Expected format: 1M, 1w, 1d, 1h and 1m signifying month, week, day, hour and minute respectively.", "type":"string" }, "intervalType":{ "description":"Interval at which the scheduler will run the transaction", "type":"object", "properties":{ "blocks":{ "description":"Run the transaction every 'n' number of blocks", "type":"integer" }, "time":{ "description":"Run the transaction every 'n' minutes", "type":"integer" } } } } } } ], "responses":{ "200":{ "description":"Successful response for schedule transaction", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "properties":{ "schedulerID":{ "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-{channelName}-scheduleTransactions-post", "x-filename-id":"restproxy-api-v2-channels-channelname-scheduletransactions-post" }, "get":{ "tags":[ "Application Operations/Transactions" ], "summary":"Get Transaction Scheduler Details", "description":"Get the transaction scheduler details.", "operationId":"getScheduleTransactionsInfo", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"query", "name":"role", "type":"string", "description":"Which Hyperledger Fabric enrollment should be used" }, { "in":"query", "name":"userID", "type":"string", "description":"User's name. It should be the same as user defined in basic auth." }, { "in":"query", "name":"schedulerID", "type":"string", "description":"ID of the scheduler that needs to be retrieved" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when it fails", "default":"" }, "result":{ "type":"object", "properties":{ "schedulerID":{ "description":"The ID associated with the scheduler", "type":"string" }, "chaincode":{ "description":"ID of the chaincode to invoke", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "endorsers":{ "description":"Endorsers 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" } }, "sameOrgEndorser":{ "description":"Whether it should select endorsers of this org only. When set to true, endorsers field cannot be specified.", "type":"boolean", "default":false }, "expires":{ "description":"Expiration of the scheduler", "type":"string" }, "intervalType":{ "description":"Interval at which the scheduler will run the transaction. It can be either based on number of blocks or number of minutes.", "type":"object", "properties":{ "blocks":{ "description":"Run the transaction every 'n' number of blocks", "type":"integer" }, "time":{ "description":"Run the transaction every 'n' minutes", "type":"integer" } } }, "lastProcessedAt":{ "description":"Latest point at which the scheduler ran the transaction", "type":"object", "properties":{ "blockNum":{ "description":"Latest block number at which the scheduler ran the transaction", "type":"integer" }, "time":{ "description":"Latest time at which the scheduler ran the transaction", "type":"integer" } } }, "lastTransactionResult":{ "description":"Results of the last transaction run", "type":"object", "properties":{ "result":{ "type":"object", "properties":{ "txid":{ "description":"Transaction ID", "type":"string" }, "message":{ "type":"string" }, "blockNumber":{ "type":"integer" }, "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-{channelName}-scheduleTransactions-get", "x-filename-id":"restproxy-api-v2-channels-channelname-scheduletransactions-get" } }, "/restproxy/api/v2/channels/{channelName}/scheduleTransactions/{schedulerID}":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" }, { "name":"schedulerID", "in":"path", "description":"ID of the scheduler", "required":true, "type":"string" } ], "delete":{ "tags":[ "Application Operations/Transactions" ], "summary":"Delete Transaction Scheduler", "description":"Delete transaction scheduler by scheduler ID.", "operationId":"deleteScheduleTransactionsInfo", "produces":[ "application/json" ], "consumes":[ "application/json" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when fail", "default":"" }, "result":{ "type":"object" } } } }, "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-{channelName}-scheduleTransactions-{schedulerID}-delete", "x-filename-id":"restproxy-api-v2-channels-channelname-scheduletransactions-schedulerid-delete" } }, "/restproxy/api/v2/channels/{channelName}/event-subscriptions":{ "parameters":[ { "name":"channelName", "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. This endpoint is used to generate a list of all the events subscribed to by a blockchain user in the specified channel.", "operationId":"listSubscribeEvents", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"query", "name":"role", "type":"string", "description":"Name of Hyperledger 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/EventSubscriptionQuery" } } } } }, "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-{channelName}-event-subscriptions-get", "x-filename-id":"restproxy-api-v2-channels-channelname-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-{channelName}-event-subscriptions-post", "x-filename-id":"restproxy-api-v2-channels-channelname-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 Hyperledger 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-{channelName}-event-subscriptions-delete", "x-filename-id":"restproxy-api-v2-channels-channelname-event-subscriptions-delete" } }, "/restproxy/api/v2/auditlog/event-subscriptions":{ "get":{ "tags":[ "Application Operations/Audit Log Events" ], "summary":"List Audit Log Event Subscriptions", "description":"Lists all audit log event subscriptions.", "operationId":"listSubscribeAuditLogEvents", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"query", "name":"user-id", "type":"string", "description":"User's name. It should be the same user defined in basic auth." }, { "in":"query", "name":"subscription-id", "type":"string", "description":"ID of the subscription when successful." } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when the request fails", "default":"" }, "result":{ "type":"array", "items":{ "$ref":"#/definitions/AuditLogEventSubscription" } } } } }, "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-auditlog-event-subscriptions-get", "x-filename-id":"restproxy-api-v2-auditlog-event-subscriptions-get" }, "post":{ "tags":[ "Application Operations/Audit Log Events" ], "summary":"Subscribe to an Audit Log Event", "description":"Subscribe to an audit log event.", "operationId":"subscribeAuditLogEvent", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"subscribe auditlog event request", "description":"Request to subscribe to an audit log event", "required":true, "schema":{ "$ref":"#/definitions/AuditLogEventSubscription" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when the subscription fails", "default":"" }, "result":{ "type":"object", "required":[ "subid" ], "properties":{ "subid":{ "description":"ID of the subscription when successful", "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-auditlog-event-subscriptions-post", "x-filename-id":"restproxy-api-v2-auditlog-event-subscriptions-post" }, "delete":{ "tags":[ "Application Operations/Audit Log Events" ], "summary":"Unsubscribe from an Audit Log Event", "description":"Unsubscribe from an audit log event.", "operationId":"unsubscribeAudigLogEvent", "produces":[ "application/json" ], "parameters":[ { "in":"query", "name":"user-id", "type":"string", "description":"User's name. It should be the same user defined in basic auth." }, { "in":"query", "name":"subscription-id", "type":"string", "description":"ID of the subscription when successful" } ], "responses":{ "200":{ "description":"Successful operation", "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-auditlog-event-subscriptions-delete", "x-filename-id":"restproxy-api-v2-auditlog-event-subscriptions-delete" } }, "/console/admin/api/v2/nodes":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Node List", "description":"Returns a node list by given node type.", "operationId":"listNodes", "produces":[ "application/json" ], "parameters":[ { "name":"nodeType", "in":"query", "description":"node type", "required":false, "type":"string", "enum":[ "CA", "PEER", "ORDERER", "RESTPROXY" ] } ], "responses":{ "200":{ "description":"Nodes response", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/nodes" } } }, "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-v2-nodes-get", "x-filename-id":"console-admin-api-v2-nodes-get" } }, "/console/admin/api/v2/nodes/peers":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Peer List", "description":"Get a list of peers on a channel. If no parameter is specified, all peers will be returned. If specified by channelName, the peers which have joined the channel will be returned. If specified by chaincode, the peers which have installed the chaincode will be returned.", "operationId":"getPeerChannels", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"query", "description":"Channel name", "required":false, "type":"string" }, { "name":"chaincode", "in":"query", "description":"Chaincode name", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with peers listed", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/peer2" } } }, "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-v2-nodes-peers-get", "x-filename-id":"console-admin-api-v2-nodes-peers-get" } }, "/console/admin/api/v2/nodes/peers/{peerId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start Peer Node", "description":"Starts a peer node.", "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-v2-nodes-peers-{peerId}-start-post", "x-filename-id":"console-admin-api-v2-nodes-peers-peerid-start-post" } }, "/console/admin/api/v2/nodes/peers/{peerId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop Peer Node", "description":"Stops designated peer nodes.", "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-v2-nodes-peers-{peerId}-stop-post", "x-filename-id":"console-admin-api-v2-nodes-peers-peerid-stop-post" } }, "/console/admin/api/v2/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-v2-nodes-peers-{peerId}-blockaudit-{channelName}-get", "x-filename-id":"console-admin-api-v2-nodes-peers-peerid-blockaudit-channelname-get" } }, "/console/admin/api/v2/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-v2-nodes-peers-{peerId}-get", "x-filename-id":"console-admin-api-v2-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-v2-nodes-peers-{peerId}-patch", "x-filename-id":"console-admin-api-v2-nodes-peers-peerid-patch" } }, "/console/admin/api/v2/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-v2-nodes-peers-{peerId}-joinChannel-post", "x-filename-id":"console-admin-api-v2-nodes-peers-peerid-joinchannel-post" } }, "/console/admin/api/v2/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.", "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-v2-nodes-orderers-{ordererId}-start-post", "x-filename-id":"console-admin-api-v2-nodes-orderers-ordererid-start-post" } }, "/console/admin/api/v2/nodes/orderers/{ordererId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop an Orderer Node", "description":"Stop an orderer node.", "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-v2-nodes-orderers-{ordererId}-stop-post", "x-filename-id":"console-admin-api-v2-nodes-orderers-ordererid-stop-post" } }, "/console/admin/api/v2/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-v2-nodes-orderers-{ordererId}-get", "x-filename-id":"console-admin-api-v2-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" } } }, "x-internal-id":"console-admin-api-v2-nodes-orderers-{ordererId}-patch", "x-filename-id":"console-admin-api-v2-nodes-orderers-ordererid-patch" } }, "/console/admin/api/v2/nodes/orderers/{ordererId}/exportOSN":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Orderer Information", "description":"Retrieves 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-v2-nodes-orderers-{ordererId}-exportOSN-get", "x-filename-id":"console-admin-api-v2-nodes-orderers-ordererid-exportosn-get" } }, "/console/admin/api/v2/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-v2-nodes-orderers-{ordererId}-importNCB-post", "x-filename-id":"console-admin-api-v2-nodes-orderers-ordererid-importncb-post" } }, "/console/admin/api/v2/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.", "operationId":"startFabricCAs", "parameters":[ { "name":"caId", "in":"path", "description":"ID of Hyperledger Fabric CA node", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Hyperledger 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-v2-nodes-fabricCAs-{caId}-start-post", "x-filename-id":"console-admin-api-v2-nodes-fabriccas-caid-start-post" } }, "/console/admin/api/v2/nodes/fabricCAs/{caId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a CA Node", "description":"Stop a Hyperledger Fabric certificate authority (CA) node.", "operationId":"stopFabricCAs", "parameters":[ { "name":"caId", "in":"path", "description":"fabricCA 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-v2-nodes-fabricCAs-{caId}-stop-post", "x-filename-id":"console-admin-api-v2-nodes-fabriccas-caid-stop-post" } }, "/console/admin/api/v2/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 Hyperledger Fabric CA to fetch", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Hyperledger 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-v2-nodes-fabricCAs-{caId}--get", "x-filename-id":"console-admin-api-v2-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 Hyperledger Fabric CA", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"Updated Hyperledger 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-v2-nodes-fabricCAs-{caId}--patch", "x-filename-id":"console-admin-api-v2-nodes-fabriccas-caid-patch" } }, "/console/admin/api/v2/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 proxy 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-v2-nodes-restproxies-{restProxyId}-get", "x-filename-id":"console-admin-api-v2-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.", "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-v2-nodes-restproxies-{restProxyId}-patch", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-patch" } }, "/console/admin/api/v2/nodes/restproxies/{restProxyId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start a REST Proxy Node", "description":"Start a REST proxy node.", "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-v2-nodes-restproxies-{restProxyId}-start-post", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-start-post" } }, "/console/admin/api/v2/nodes/restproxies/{restProxyId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a REST Proxy Node", "description":"Stop a REST proxy node.", "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-v2-nodes-restproxies-{restProxyId}-stop-post", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-stop-post" } }, "/console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"List Custom Enrollments for REST Proxy", "description":"Get the list of all custom enrollments for a REST proxy.", "operationId":"listCustomEnrollments", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST Proxy ID", "required":true, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"Custom enrollment list", "schema":{ "$ref":"#/definitions/customEnrollments" } }, "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-v2-nodes-restproxies-{restProxyId}-enrollments-get", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-enrollments-get" }, "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Create Custom Enrollment for REST Proxy", "description":"Create a custom enrollment for a REST proxy. Enrollments allow users to call the REST proxy without an enrollment certificate. Enrollements require a new user group to be defined on your authentication server.", "operationId":"createCustomEnrollment", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST Proxy ID", "required":true, "type":"string" }, { "name":"createCustomEnrollmentBody", "in":"body", "description":"Create custom enrollment", "required":true, "schema":{ "$ref":"#/definitions/createCustomEnrollmentBody" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object" } }, "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-v2-nodes-restproxies-{restProxyId}-enrollments-post", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-enrollments-post" } }, "/console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}":{ "delete":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Delete Custom Enrollment for REST Proxy", "description":"Delete a custom enrollment for a REST proxy.", "operationId":"deleteCustomEnrollment", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST Proxy ID", "required":true, "type":"string" }, { "name":"enrollmentId", "in":"path", "description":"Custom enrollment ID to be deleted", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object" } }, "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-v2-nodes-restproxies-{restProxyId}-enrollments-{enrollmentId}-delete", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-enrollments-enrollmentid-delete" } }, "/console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}/users":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get List of REST Client Users Associated with the Custom Enrollment", "description":"Get the list of all REST client users associated with the designated custom enrollment.", "operationId":"listCustomEnrollmentUsers", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST Proxy ID", "required":true, "type":"string" }, { "name":"enrollmentId", "in":"path", "description":"custom enrollment ID", "required":true, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"REST client user list", "schema":{ "$ref":"#/definitions/customEnrollmentUsers" } }, "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-v2-nodes-restproxies-{restProxyId}-enrollments-{enrollmentId}-users-get", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-enrollments-enrollmentid-users-get" }, "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Associate REST Client User With a Custom Enrollment", "description":"Associate a REST client user with a custom enrollment.", "operationId":"associateRestUser", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST Proxy Id", "required":true, "type":"string" }, { "name":"enrollmentId", "in":"path", "description":"custom enrollment Id", "required":true, "type":"string" }, { "name":"associateRestUserBody", "in":"body", "description":"REST client user name to be associated with the custom enrollment", "required":true, "schema":{ "$ref":"#/definitions/associateRestUserBody" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object" } }, "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-v2-nodes-restproxies-{restProxyId}-enrollments-{enrollmentId}-users-post", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-enrollments-enrollmentid-users-post" } }, "/console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}/users/{userName}":{ "delete":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Remove Association Between REST Client User and a Custom Enrollment", "description":"Remove the association between a REST client user and a custom enrollment.", "operationId":"dissociateRestUser", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST Proxy ID", "required":true, "type":"string" }, { "name":"enrollmentId", "in":"path", "description":"Custom enrollment ID", "required":true, "type":"string" }, { "name":"userName", "in":"path", "description":"REST client user name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object" } }, "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-v2-nodes-restproxies-{restProxyId}-enrollments-{enrollmentId}-users-{userName}-delete", "x-filename-id":"console-admin-api-v2-nodes-restproxies-restproxyid-enrollments-enrollmentid-users-username-delete" } }, "/console/admin/api/v2/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 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-v2-channels-get", "x-filename-id":"console-admin-api-v2-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 v2 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-v2-channels-post", "x-filename-id":"console-admin-api-v2-channels-post" } }, "/console/admin/api/v2/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-v2-channels-{channelName}-get", "x-filename-id":"console-admin-api-v2-channels-channelname-get" } }, "/console/admin/api/v2/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 retrieve 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 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-v2-channels-{channelName}-blocks-{blockId}-get", "x-filename-id":"console-admin-api-v2-channels-channelname-blocks-blockid-get" } }, "/console/admin/api/v2/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.

", "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-v2-channels-{channelName}-blocks-get", "x-filename-id":"console-admin-api-v2-channels-channelname-blocks-get" } }, "/console/admin/api/v2/channels/{channelName}/policies":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Policies of a Channel", "description":"Update the policies of a specified 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 Arguments" }, "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-v2-channels-{channelName}-policies-post", "x-filename-id":"console-admin-api-v2-channels-channelname-policies-post" } }, "/console/admin/api/v2/channels/{channelName}/orderingSettings":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Orderer Attributes for Channel", "description":"Get the 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 Arguments" }, "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-v2-channels-{channelName}-orderingSettings-get", "x-filename-id":"console-admin-api-v2-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 Arguments" }, "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-v2-channels-{channelName}-orderingSettings-patch", "x-filename-id":"console-admin-api-v2-channels-channelname-orderingsettings-patch" } }, "/console/admin/api/v2/channels/{channelName}/organizations":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Add Organization to Channel", "description":"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 v2 API can be used.", "required":true, "schema":{ "$ref":"#/definitions/postChannelNewOrg" } } ], "responses":{ "200":{ "description":"Success", "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-v2-channels-{channelName}-organizations-post", "x-filename-id":"console-admin-api-v2-channels-channelname-organizations-post" } }, "/console/admin/api/v2/channels/{channelName}/organizations/{mspId}":{ "delete":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Remove Organization from Channel", "description":"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 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-v2-channels-{channelName}-organizations-{mspId}-delete", "x-filename-id":"console-admin-api-v2-channels-channelname-organizations-mspid-delete" } }, "/console/admin/api/v2/channels/{channelName}/organizations/{mspId}/anchorPeers":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Set Anchor Peers for 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-v2-channels-{channelName}-organizations-{mspId}-anchorPeers-post", "x-filename-id":"console-admin-api-v2-channels-channelname-organizations-mspid-anchorpeers-post" } }, "/console/admin/api/v2/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 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-v2-channels-{channelName}-orderers-joinOSN-post", "x-filename-id":"console-admin-api-v2-channels-channelname-orderers-joinosn-post" } }, "/console/admin/api/v2/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 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-v2-channels-{channelName}-orderers-removeOSN-post", "x-filename-id":"console-admin-api-v2-channels-channelname-orderers-removeosn-post" } }, "/console/admin/api/v2/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-v2-channels-syschannel-configblock-get", "x-filename-id":"console-admin-api-v2-channels-syschannel-configblock-get" } }, "/console/admin/api/v2/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 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-v2-channels-syschannel-addOSN-post", "x-filename-id":"console-admin-api-v2-channels-syschannel-addosn-post" } }, "/console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/approve":{ "parameters":[ { "name":"channelName", "in":"path", "description":"Id of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Approve Chaincode Definition in Channel", "description":"Approve a chaincode definition in a channel. The new chaincode lifecycle in Hyperledger Fabric 2.x involves approving and committing the chaincode during the deployment. The chaincode definition needs to be approved by a sufficient number of organizations to satisfy the channel's LifecycleEndorsement policy before the chaincode can be committed on the channel.", "operationId":"approveChaincodeDefinition", "parameters":[ { "name":"approveCCBody", "in":"body", "description":"Details of the chaincode definition to be approved", "required":true, "schema":{ "$ref":"#/definitions/ApproveCCReq" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal server error", "schema":{ "type":"object", "properties":{ "respMesg":{ "type":"string" } } } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-channels-{channelName}-chaincodeDefinitions-approve-post", "x-filename-id":"console-admin-api-v2-channels-channelname-chaincodedefinitions-approve-post" } }, "/console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/commit":{ "parameters":[ { "name":"channelName", "in":"path", "description":"Id of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Commit Chaincode Definition in a Channel", "description":"Commit a chaincode definition in a channel. The new chaincode lifecycle in Hyperledger Fabric 2.x involves approving and committing the chaincode during the deployment. The chaincode definition needs to be approved by a sufficient number of organizations to satisfy the channel's LifecycleEndorsement policy before the chaincode can be committed on the channel.", "operationId":"commitChaincodeDefinition", "parameters":[ { "name":"commitCCBody", "in":"body", "description":"Details about the chaincode definition to be committed", "required":true, "schema":{ "$ref":"#/definitions/CommitCCReq" } } ], "responses":{ "200":{ "description":"Success", "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-v2-channels-{channelName}-chaincodeDefinitions-commit-post", "x-filename-id":"console-admin-api-v2-channels-channelname-chaincodedefinitions-commit-post" } }, "/console/admin/api/v2/channels/{channelName}/chaincodeDefinitions":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Query Chaincode Definition in a Channel", "description":"Query approved or committed chaincode definitions in a channel. The new chaincode lifecycle in Hyperledger Fabric 2.x involves approving and committing the chaincode during the deployment. The chaincode definition needs to be approved by a sufficient number of organizations to satisfy the channel's LifecycleEndorsement policy before the chaincode can be committed on the channel.", "operationId":"queryChaincodeDefinition", "parameters":[ { "name":"status", "in":"query", "required":true, "description":"Select if the query will return a list of approved or committed chaincode definitions in a channel", "type":"string", "enum":[ "Approved", "Committed" ] }, { "name":"chaincodeName", "in":"query", "description":"Optionally query a specific chaincode name for approved or committed status in a channel", "required":false, "type":"string" }, { "name":"sequence", "in":"query", "description":"Optionally query a specific chaincode sequence number for approved or committed status in a channel", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/queryChaincodeInfo" } } }, "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-v2-channels-{channelName}-chaincodeDefinitions-get", "x-filename-id":"console-admin-api-v2-channels-channelname-chaincodedefinitions-get" } }, "/console/admin/api/v2/channels/{channelName}/chaincodeDefinitions/checkCommitReadiness":{ "parameters":[ { "name":"channelName", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Check Commit Readiness", "description":"Checks the commit readiness of a given chaincode definition in a channel.", "operationId":"checkCommitReadinessChaincodeDefinition", "parameters":[ { "name":"checkCommitReadinessCCBody", "in":"body", "description":"Details about the chaincode definition to check commit readiness", "required":true, "schema":{ "$ref":"#/definitions/CheckCommitReadinessCCReq" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/checkCommitReadinessInfo" } }, "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-v2-channels-{channelName}-chaincodeDefinitions-checkCommitReadiness-post", "x-filename-id":"console-admin-api-v2-channels-channelname-chaincodedefinitions-checkcommitreadiness-post" } }, "/console/admin/api/v2/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":"peerId", "in":"query", "description":"ID of the peer where the chaincodes are 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-v2-chaincodes-get", "x-filename-id":"console-admin-api-v2-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/installCCResp" } }, "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-v2-chaincodes-post", "x-filename-id":"console-admin-api-v2-chaincodes-post" } }, "/console/admin/api/v2/chaincodes/{packageID}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Get Chaincode Package from Peer", "description":"Download the chaincode package from a peer in tar.gz format.", "operationId":"getChaincodesById", "produces":[ "application/json" ], "parameters":[ { "name":"packageID", "in":"path", "description":"Package ID of the chaincode", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"The chaincode files packaged in tar.gz format", "schema":{ "type":"file" } }, "400":{ "description":"Invalid arguments", "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-v2-chaincodes-{packageID}-get", "x-filename-id":"console-admin-api-v2-chaincodes-packageid-get" }, "delete":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Delete Installed Chaincode Package", "description":"Deletes an installed chaincode package using the chaincode package ID. Use this to remove obsolete chaincode packages to free up space in your instance.

This process stops and removes any container associated with the package ID, deletes the chaincode image, removes the package from the peer's file systems, and updates the peer's cache.", "operationId":"deleteChaincodesById", "produces":[ "application/json" ], "parameters":[ { "name":"packageID", "in":"path", "description":"Package ID of the chaincode", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Chaincode package deleted successfully", "schema":{ "type":"object", "properties":{ "respMesg":{ "type":"string" } }, "example":{ "respMesg":"SUCCESS" } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal server error", "schema":{ "type":"object", "properties":{ "respMesg":{ "type":"string" } }, "example":{ "respMesg":"This chaincode is not installed on any peer" } } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-chaincodes-{packageID}-delete", "x-filename-id":"console-admin-api-v2-chaincodes-packageid-delete" } }, "/console/admin/api/v2/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":"", "participants":[ "" ] } } }, "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-v2-organizations-get", "x-filename-id":"console-admin-api-v2-organizations-get" } }, "/console/admin/api/v2/organizations/{orgName}/certificates":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Get Organization Certificates", "description":"Use this endpoint to return the admin, CA, and TLS certificates for an organization.", "operationId":"getCerts", "parameters":[ { "name":"orgName", "in":"path", "description":"Organization name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Organization certificates", "schema":{ "type":"object", "example":{ "mspId":"", "certs":{ "adminCert":"", "CACert":"", "tlsCACert":"", "rafttlsCACert":"", "nodeouIdentifierCert":"", "intermediateCerts":"" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Query certificates for an unknown organization", "schema":{ "type":"object", "example":{ "respMesg":"No admin access to organization; cannot get admin credentials." } } }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-organizations-{orgName}-certificates-get", "x-filename-id":"console-admin-api-v2-organizations-orgname-certificates-get" } }, "/console/admin/api/v2/organizations/{orgName}/adminCredentials":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Get Organization Admin Credentials", "description":"This endpoint returns the admin certificate and key for an organization.", "operationId":"getAdminCredentials", "parameters":[ { "name":"orgName", "in":"path", "description":"Organization name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Organization admin credentials", "schema":{ "type":"object", "example":{ "adminCert":"", "adminKey":"" } } }, "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-v2-organizations-{orgName}-adminCredentials-get", "x-filename-id":"console-admin-api-v2-organizations-orgname-admincredentials-get" } }, "/console/admin/api/v2/organizations/{orgName}/connectionProfile/{zip}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Download Connection Profile", "description":"

Download the Fabric connection profile of the specified organization.

If the 'zip' argument is equal to 'zip', a Zip file including the connection profile in YAML format and all certificates needed will be downloaded. If not, the YAML configuration file content will be returned. Currently you can only export the profile from your own organization.

Note that there is a known issue where currently only the YAML can be downloaded - if you select to download a ZIP file you will get an error message stating that and invalid argument was used.

", "operationId":"downloadConnectionProfile", "parameters":[ { "name":"orgName", "in":"path", "description":"The name of organization whose connection profile is being exported. Currently you can only export the profile of your own organization.", "required":true, "type":"string" }, { "name":"zip", "in":"path", "required":true, "description":"Specify the file format to be downloaded. If this argument equals 'zip', a Zip file will be returned. Otherwise a YAML file will be returned.", "type":"string" } ], "responses":{ "200":{ "description":"Connection profile of the specified org in YAML or Zip format", "schema":{ "type":"file" } }, "404":{ "description":"Specified organization does not exist" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-organizations-{orgName}-connectionProfile-{zip}-get", "x-filename-id":"console-admin-api-v2-organizations-orgname-connectionprofile-zip-get" } }, "/console/admin/api/v2/organizations/{orgName}/joinNewOrgs":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Add Organization to Network", "description":"You can add an organization to the network by providing the MSP ID and certificates. This API is only available on the founder.", "operationId":"addOrgs", "parameters":[ { "name":"orgName", "in":"path", "description":"Name of organization to be joined to the network", "required":true, "type":"string" }, { "name":"orgInfo", "in":"body", "description":"Attributes of the organization", "required":true, "schema":{ "$ref":"#/definitions/orgInfo" } } ], "responses":{ "200":{ "description":"Added organization to network", "schema":{ "type":"object", "example":{ "status":"Success" } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "409":{ "description":"Duplicated", "schema":{ "type":"object", "example":{ "respMesg":"Organization Org2MSP has already joined into the network." } } }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-organizations-{orgName}-joinNewOrgs-post", "x-filename-id":"console-admin-api-v2-organizations-orgname-joinneworgs-post" } }, "/console/admin/api/v2/organizations/{orgName}/orderingService":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Get Orderer Service Settings", "description":"This endpoint returns the orderer service settings for a founder organization, including the MSP ID, certificates, and ordering service node addresses. This API is only available on the founder.", "operationId":"getOrdererSettings", "parameters":[ { "name":"orgName", "in":"path", "description":"Organization name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer settings information", "schema":{ "$ref":"#/definitions/ordererSettingInfo" } }, "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-v2-organizations-{orgName}-orderingService-get", "x-filename-id":"console-admin-api-v2-organizations-orgname-orderingservice-get" } }, "/console/admin/api/v2/organizations/{orgName}/setOrderingService":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Set Orderer Service for an Organization", "description":"This endpoint sets the orderer service settings for a participant organization, including the MSP ID, certificates, and ordering service node addresses. This API is only available on the participant.", "operationId":"setOrdererSettings", "parameters":[ { "name":"orgName", "in":"path", "description":"Organization name", "required":true, "type":"string" }, { "name":"ordererSetting", "in":"body", "description":"Orderer setting information", "required":true, "schema":{ "$ref":"#/definitions/ordererSettingInfo" } } ], "responses":{ "200":{ "description":"Set the orderer settings", "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-v2-organizations-{orgName}-setOrderingService-post", "x-filename-id":"console-admin-api-v2-organizations-orgname-setorderingservice-post" } }, "/console/admin/api/v2/dashboard/statistics/nodeHealth":{ "get":{ "tags":[ "Statistics" ], "summary":"Get Node Health Status", "description":"Get the node health status (up or down) of a specific peer, orderer, proxy, or the console itself.", "operationId":"getStatsNodeHealth", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific peer, orderer, proxy, or the console itself", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a series of up/down status by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsNodeHealth" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-nodeHealth-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-nodehealth-get" } }, "/console/admin/api/v2/dashboard/statistics/channelInfo":{ "get":{ "tags":[ "Statistics" ], "summary":"Get Current Channels and Peers Joined on Each Channel", "description":"Gets a list of the currently existing channels and the peers joined on each channel.", "operationId":"getStatsChannelInfo", "produces":[ "application/json" ], "parameters":[ { "name":"channel", "in":"query", "description":"Channel Name", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with channel information by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChannelInfo" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-channelInfo-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-channelinfo-get" } }, "/console/admin/api/v2/dashboard/statistics/channelsJoined":{ "get":{ "tags":[ "Statistics" ], "summary":"Get Current Number and List of Channels Joined by the Specified Peer", "description":"This endpoint is used to get the current number and list of channels joined by the specified peer (if the peer is specified using nodeID), or on all peers if not specified.", "operationId":"getStatsChannelsJoined", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific peer", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a total number and a list of channel names for each peer by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChannelsJoined" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-channelsJoined-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-channelsjoined-get" } }, "/console/admin/api/v2/dashboard/statistics/userTrans":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of User Transactions for Peer, Channel, or Network", "description":"Get the number of user transactions for a peer or channel or the entire network. Note that you cannot query a node and the network in the same request.", "operationId":"getStatsUserTrans", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific peer. You cannot request this at the same time as the orderer.", "required":false, "type":"string" }, { "name":"channel", "in":"query", "description":"Channel Name", "required":false, "type":"string" }, { "name":"orderer", "in":"query", "description":"The value is Y or N to indicate whether the metrics collected by orderer for whole network or the metrics for founder only needs to be returned. You cannot request this at the same time as a node.", "required":false, "type":"string" }, { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a series of user transactions by restriction", "schema":{ "type":"object", "properties":{ "data":{ "$ref":"#/definitions/StatsUserTrans" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-userTrans-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-usertrans-get" } }, "/console/admin/api/v2/dashboard/statistics/endorsements":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Endorsements", "description":"This endpoint is used to get the number of endorsements for a peer or channel in a specified time range. Parameters nodeID and channel are used to set the scope of the query.", "operationId":"getStatsEndorsements", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific peer", "required":false, "type":"string" }, { "name":"channel", "in":"query", "description":"Channel Name", "required":false, "type":"string" }, { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"response with a series of endorsements by restriction", "schema":{ "type":"object", "properties":{ "data":{ "$ref":"#/definitions/StatsEndorsements" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-endorsements-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-endorsements-get" } }, "/console/admin/api/v2/dashboard/statistics/commits":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Commits", "description":"This endpoint is used to get the number of commits for a peer or channel in a specified time range. Parameters nodeID and channel are used to set the scope of the query.", "operationId":"getStatsCommits", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific peer", "required":false, "type":"string" }, { "name":"channel", "in":"query", "description":"Channel name", "required":false, "type":"string" }, { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a series of commits by restriction", "schema":{ "type":"object", "properties":{ "data":{ "$ref":"#/definitions/StatsCommits" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-commits-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-commits-get" } }, "/console/admin/api/v2/dashboard/statistics/blocks":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Blocks", "description":"This endpoint is used to get the number of blocks on a specified channel or on all channels in a specified time range.", "operationId":"getStatsBlocks", "produces":[ "application/json" ], "parameters":[ { "name":"channel", "in":"query", "description":"Channel name", "required":false, "type":"string" }, { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a series of blocks by restriction", "schema":{ "type":"object", "properties":{ "data":{ "$ref":"#/definitions/StatsBlocks" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-blocks-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-blocks-get" } }, "/console/admin/api/v2/dashboard/statistics/proxySyncInvocation":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Synchronous Invocations", "description":"This endpoint is used to get the number of synchronous invocations on the specified proxy if you specify nodeID or on all proxies if not specified.", "operationId":"getStatsProxySyncInvocation", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific proxy", "required":false, "type":"string" }, { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a series of synchronous invocations by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsProxySyncInvocation" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-proxySyncInvocation-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-proxysyncinvocation-get" } }, "/console/admin/api/v2/dashboard/statistics/proxyAsyncInvocation":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Asynchronous Invocations", "description":"This endpoint is used to get the number of asynchronous invocations on the specified proxy if you specify nodeID, or on all proxies if not specified.", "operationId":"getStatsProxyAsyncInvocation", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific proxy", "required":false, "type":"string" }, { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with a series of asynchronous invocations by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsProxyAsyncInvocation" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-proxyAsyncInvocation-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-proxyasyncinvocation-get" } }, "/console/admin/api/v2/dashboard/statistics/metrics":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Native Fabric Metrics for Peer or Orderer", "description":"You can query the Hyperledger Fabric metrics and publish the output to a Prometheus database.", "operationId":"getStatsMetrics", "produces":[ "application/json" ], "parameters":[ { "name":"nodeId", "in":"query", "description":"Node ID of a specific node", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Operational metrics exported for consumption by Prometheus", "schema":{ "$ref":"#/definitions/StatsMetrics" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-metrics-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-metrics-get" } }, "/console/admin/api/v2/dashboard/statistics/auditlog":{ "get":{ "tags":[ "Statistics" ], "summary":"Get Audit Log Information", "description":"The audit log records administrative console activity for the instance, including actions related to channels, organizations, nodes, and chaincode.", "operationId":"getStatsAuditLog", "produces":[ "application/json" ], "parameters":[ { "name":"startTime", "in":"query", "description":"The start time of a time range in the format 'yyyyMMddhhmmss'", "required":true, "type":"string" }, { "name":"endTime", "in":"query", "description":"The end time of a time range in the format 'yyyyMMddhhmmss'", "required":true, "type":"string" }, { "name":"action", "in":"query", "description":"The name of the audit log action to return", "required":false, "type":"string" }, { "name":"userIdentity", "in":"query", "description":"The user identity", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"The maximum number of log entries to return. If not specified, defaults to 100, which is also the maximum allowed value of the parameter.", "required":false, "type":"number" }, { "name":"offset", "in":"query", "description":"The number of log entries to skip", "required":false, "type":"number" } ], "responses":{ "200":{ "description":"Response with a series of audit logs by restriction.", "schema":{ "type":"object", "properties":{ "data":{ "$ref":"#/definitions/StatsAuditLog" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v2-dashboard-statistics-auditlog-get", "x-filename-id":"console-admin-api-v2-dashboard-statistics-auditlog-get" } }, "/console/admin/api/instanceVersion":{ "get":{ "tags":[ "Application Operations" ], "summary":"Get Version of Blockchain Platform, Hyperledger Fabric and Admin API", "description":"Gets the Oracle Blockchain Platform, Hyperledger Fabric and admin API versions. ", "operationId":"getInstanceVersion", "produces":[ "application/json" ], "responses":{ "200":{ "description":"Response with Blockchain Platform, Hyperledger Fabric and admin API version", "schema":{ "type":"object", "properties":{ "respMesg":{ "$ref":"#/definitions/InstanceVersionResp" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-instanceVersion-get", "x-filename-id":"console-admin-api-instanceversion-get" } } }, "definitions":{ "BlockchainPlatform":{ "description":"Blockchain Platform Instance Description.", "type":"object", "x-obmcs-splat":{ "resourceKind":"blockchainplatform", "ocidEntityType":"blockchainplatform", "adLocality":"regional", "activeLifecycleStates":[ "ACTIVE", "UPDATING", "INACTIVE", "SCALING", "FAILED" ], "deletedLifecycleStates":[ "DELETED" ], "getOperationId":"GetBlockchainPlatform", "listResourcesOperationId":"ListBlockchainPlatforms" }, "required":[ "id", "compartmentId", "displayName", "platformRole", "computeShape" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Platform Instance Display name, can be renamed", "type":"string" }, "compartmentId":{ "description":"Compartment identifier", "type":"string" }, "description":{ "description":"Platform instance description", "type":"string" }, "isByol":{ "description":"Bring your own license", "type":"boolean" }, "timeCreated":{ "description":"The time the the Blockchain Platform was created. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Blockchain Platform was updated. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "platformVersion":{ "description":"Platform Version", "type":"string" }, "serviceVersion":{ "description":"The version of the Blockchain Platform.", "type":"string" }, "platformRole":{ "description":"Role of platform: FOUNDER or PARTICIPANT", "enum":[ "FOUNDER", "PARTICIPANT" ], "type":"string" }, "computeShape":{ "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.", "enum":[ "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM", "DIGITAL_ASSETS_MEDIUM", "DIGITAL_ASSETS_LARGE", "DIGITAL_ASSETS_EXTRA_LARGE" ], "type":"string" }, "platformShapeType":{ "description":"Type of platform shape: DEFAULT or CUSTOM", "enum":[ "DEFAULT", "CUSTOM" ], "type":"string" }, "loadBalancerShape":{ "description":"Type of load balancer shape: LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.", "enum":[ "LB_100_MBPS", "LB_400_MBPS" ], "type":"string" }, "serviceEndpoint":{ "description":"Service endpoint URL, valid post-provisioning", "type":"string" }, "lifecycleState":{ "description":"The current state of the Blockchain Platform.", "enum":[ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "SCALING", "INACTIVE", "FAILED" ], "type":"string" }, "lifecycleDetails":{ "description":"A 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" }, "storageSizeInTBs":{ "type":"number", "format":"double", "description":"Storage size in TBs" }, "storageUsedInTBs":{ "type":"number", "format":"double", "description":"Storage used in TBs" }, "isMultiAD":{ "type":"boolean", "description":"True for multi-AD Blockchain Platforms, false for single-AD" }, "totalOcpuCapacity":{ "type":"integer", "description":"Number of total OCPUs allocated to the platform cluster" }, "componentDetails":{ "$ref":"#/definitions/BlockchainPlatformComponentDetails" }, "replicas":{ "$ref":"#/definitions/ReplicaDetails" }, "hostOcpuUtilizationInfo":{ "type":"array", "description":"List of OcpuUtilization for all hosts", "items":{ "$ref":"#/definitions/OcpuUtilizationInfo" } }, "freeformTags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"object", "additionalProperties":{ "type":"string" } }, "definedTags":{ "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only string, integer and boolean types are supported.\n" } } } } }, "BlockchainPlatformByHostname":{ "description":"Blockchain Platform instance details for hostname.", "type":"object", "required":[ "id", "compartmentId", "displayName", "computeShape" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "serviceEndpoint":{ "description":"Service endpoint URL. Valid post-provisioning.", "type":"string" }, "displayName":{ "description":"Blockchain Platform instance display name. Can be renamed.", "type":"string" }, "compartmentId":{ "description":"Compartment identifier", "type":"string" }, "description":{ "description":"Blockchain Platform instance description", "type":"string" }, "timeCreated":{ "description":"The time the the Blockchain Platform was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Blockchain Platform was updated. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "platformRole":{ "description":"Role of platform: founder or participant", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/platformRole", "type":"string" }, "computeShape":{ "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/computeShape", "type":"string" }, "lifecycleState":{ "description":"The current state of the Blockchain Platform", "type":"string", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/lifecycleState" }, "lifecycleDetails":{ "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" }, "freeformTags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"object", "additionalProperties":{ "type":"string" } }, "definedTags":{ "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only string, integer and boolean types are supported.\n" } } } } }, "BlockchainPlatformSummary":{ "description":"Blockchain Platform instance summary.", "type":"object", "required":[ "id", "compartmentId", "displayName", "computeShape" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Blockchain Platform instance display name. Can be renamed.", "type":"string" }, "compartmentId":{ "description":"Compartment identifier", "type":"string" }, "description":{ "description":"Blockchain Platform instance description", "type":"string" }, "timeCreated":{ "description":"The time the the Blockchain Platform instance was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Blockchain Platform instance was updated. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "platformRole":{ "description":"Role of platform: founder or participant", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/platformRole", "type":"string" }, "computeShape":{ "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/computeShape", "type":"string" }, "serviceEndpoint":{ "description":"Service endpoint URL, valid post-provisioning", "type":"string" }, "lifecycleState":{ "description":"The current state of the Blockchain Platform instance.", "type":"string", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/lifecycleState" }, "lifecycleDetails":{ "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" }, "freeformTags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"object", "additionalProperties":{ "type":"string" } }, "definedTags":{ "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only string, integer and boolean types are supported.\n" } } } } }, "BlockchainPlatformCollection":{ "type":"object", "description":"Result of a platform list or search. Contains BlockchainPlatformSummary", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of BlockchainPlatformSummary", "items":{ "$ref":"#/definitions/BlockchainPlatformSummary" } } } }, "CreateBlockchainPlatformDetails":{ "description":"Blockchain Platform details for creating a new service.", "type":"object", "required":[ "compartmentId", "displayName", "platformRole", "computeShape", "idcsAccessToken" ], "properties":{ "displayName":{ "description":"Blockchain Platform instance display name. Can be renamed.", "type":"string", "minLength":1, "maxLength":255 }, "compartmentId":{ "description":"Compartment identifier", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"Blockchain Platform instance description", "type":"string", "minLength":1, "maxLength":255 }, "platformRole":{ "description":"Role of platform: founder or participant", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/platformRole", "type":"string" }, "computeShape":{ "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/computeShape", "type":"string" }, "isByol":{ "description":"Bring your own license", "type":"boolean", "default":false }, "platformVersion":{ "description":"Platform version. Values are: Hyperledger Fabric v1.4.7 and Hyperledger Fabric v2.2.4", "type":"string", "minLength":1, "maxLength":255 }, "idcsAccessToken":{ "description":"IDCS access token with Identity Domain Administrator role", "type":"string", "minLength":1, "maxLength":5000 }, "federatedUserId":{ "description":"Identifier for a federated user", "type":"string", "minLength":1, "maxLength":255 }, "caCertArchiveText":{ "description":"Base64 encoded text in ASCII character set of a third-party CA Certificates archive file.\nThe Archive file is a zip file containing third part CA certificates,\nthe ca key and certificate files used when issuing enrollment certificates\n(ECerts) and transaction certificates (TCerts). The chainfile (if it exists)\ncontains the certificate chain which should be trusted for this CA, where\nthe 1st in the chain is always the root CA certificate.\nFile list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)].\n", "type":"string", "minLength":1, "maxLength":10485760 }, "freeformTags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"object", "additionalProperties":{ "type":"string" } }, "definedTags":{ "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only string, integer and boolean types are supported.\n" } } } } }, "UpgradeBlockchainPlatformDetails":{ "description":"Input payload to upgrade the blockchain platform.\n", "properties":{ "patchId":{ "type":"string", "minLength":1, "maxLength":255, "description":"The patch ID corresponding to the version to which the platform will be upgraded.\n" } }, "required":[ "patchId" ] }, "UpdateBlockchainPlatformDetails":{ "description":"Blockchain Platform details for updating a service.", "type":"object", "properties":{ "description":{ "description":"Platform Description", "type":"string" }, "storageSizeInTBs":{ "type":"number", "format":"double", "description":"Storage size in TBs" }, "replicas":{ "$ref":"#/definitions/ReplicaDetails" }, "totalOcpuCapacity":{ "type":"integer", "description":"Number of total OCPUs to allocate" }, "loadBalancerShape":{ "description":"Type of Load Balancer shape: LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.", "type":"string", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/loadBalancerShape" }, "freeformTags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"object", "additionalProperties":{ "type":"string" } }, "definedTags":{ "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only string, integer and boolean types are supported.\n" } } } } }, "ChangeBlockchainPlatformCompartmentDetails":{ "description":"Input payload to change a resource's compartment.\n", "properties":{ "compartmentId":{ "type":"string", "minLength":1, "maxLength":255, "description":"The OCID of the new compartment.\n" } }, "required":[ "compartmentId" ] }, "BlockchainPlatformComponentDetails":{ "description":"Blockchain Platform component details.", "type":"object", "properties":{ "osns":{ "type":"array", "description":"List of OSNs", "items":{ "$ref":"#/definitions/Osn" } }, "peers":{ "type":"array", "description":"List of Peers", "items":{ "$ref":"#/definitions/Peer" } } } }, "Osn":{ "type":"object", "description":"Ordering Service Node details", "required":[ "osnKey", "ad" ], "properties":{ "osnKey":{ "type":"string", "minLength":1, "maxLength":255, "description":"OSN identifier" }, "ad":{ "description":"

Availability domain for the OSN. Options are AD1/AD2/AD3.

For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number is mapped to one of the three fault domains available in each availability domain.

", "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads", "type":"string" }, "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" }, "lifecycleState":{ "description":"The current state of the OSN.", "enum":[ "ACTIVE", "INACTIVE", "FAILED" ], "type":"string" } } }, "OsnCollection":{ "type":"object", "description":"Result of a OSN list or search. Contains OsnSummary", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of OsnSummary", "items":{ "$ref":"#/definitions/OsnSummary" } } } }, "OsnSummary":{ "type":"object", "description":"OSN summary information for returning in a list.", "properties":{ "osnKey":{ "type":"string", "minLength":1, "maxLength":255, "description":"OSN identifier" }, "lifecycleState":{ "description":"The current state of the OSN.", "x-obmcs-enumref":"#/definitions/Osn/lifecycleState", "type":"string" } } }, "PeerCollection":{ "type":"object", "description":"Result of a peer list or search. Contains PeerSummary", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of PeerSummary", "items":{ "$ref":"#/definitions/PeerSummary" } } } }, "PeerSummary":{ "type":"object", "description":"Peer summary information for returning in a list.", "properties":{ "peerKey":{ "type":"string", "minLength":1, "maxLength":255, "description":"Peer identifier" }, "lifecycleState":{ "description":"The current state of the peer.", "x-obmcs-enumref":"#/definitions/Peer/lifecycleState", "type":"string" } } }, "Peer":{ "type":"object", "description":"Peer details", "required":[ "peerKey", "role", "host", "ad" ], "properties":{ "peerKey":{ "type":"string", "minLength":1, "maxLength":255, "description":"peer identifier" }, "role":{ "description":"Peer role", "x-obmcs-enumref":"#/definitions/PeerRole/role", "type":"string" }, "alias":{ "type":"string", "description":"peer alias" }, "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" }, "host":{ "type":"string", "description":"Host on which the peer exists" }, "ad":{ "description":"

Availability domain of the peer. Options are AD1/AD2/AD3.

For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number of the peer is mapped to one of the three fault domains available in each availability domain.

", "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads", "type":"string" }, "lifecycleState":{ "description":"The current state of the peer.", "enum":[ "ACTIVE", "INACTIVE", "FAILED" ], "type":"string" } } }, "OcpuUtilizationInfo":{ "type":"object", "description":"OCPU utilization for a VM host", "properties":{ "host":{ "type":"string", "description":"Host name of VM" }, "ocpuUtilizationNumber":{ "type":"number", "format":"float", "description":"Number of OCPUs utilized" }, "ocpuCapacityNumber":{ "type":"number", "format":"float", "description":"Number of total OCPU capacity on the host" } } }, "ReplicaDetails":{ "type":"object", "description":"Number of replicas of service components like REST Proxy, CA and Console", "properties":{ "proxyCount":{ "type":"integer", "minimum":1, "maximum":10, "description":"Number of REST proxy replicas" }, "caCount":{ "type":"integer", "minimum":1, "maximum":10, "description":"Number of CA replicas" }, "consoleCount":{ "type":"integer", "minimum":1, "maximum":10, "description":"Number of console replicas" } } }, "AvailabilityDomain":{ "type":"object", "description":"Availability domains", "properties":{ "ads":{ "type":"string", "description":"

Availability domain identifiers.

For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number is mapped to one of the three fault domains available in each availability domain.

", "enum":[ "AD1", "AD2", "AD3" ] } } }, "PeerRole":{ "type":"object", "description":"Peer role", "properties":{ "role":{ "type":"string", "description":"Peer role names", "enum":[ "MEMBER", "ADMIN" ] } } }, "OcpuAllocationNumberParam":{ "type":"object", "description":"OCPU allocation parameter", "required":[ "ocpuAllocationNumber" ], "properties":{ "ocpuAllocationNumber":{ "type":"number", "format":"float", "minimum":0, "maximum":64, "description":"Number of OCPU allocation" } } }, "CreateOsnDetails":{ "type":"object", "description":"The ordering service node details to be added", "required":[ "ad" ], "properties":{ "ad":{ "description":"

Availability domain for the new OSN. Options are AD1/AD2/AD3.

For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.

", "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads", "type":"string" }, "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" } } }, "UpdateOsnDetails":{ "type":"object", "description":"OSN attributes that can be updated.", "required":[ "ocpuAllocationParam" ], "properties":{ "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" } } }, "CreatePeerDetails":{ "type":"object", "description":"The peer details to be added", "required":[ "role", "ocpuAllocationParam", "ad" ], "properties":{ "role":{ "description":"Peer role", "x-obmcs-enumref":"#/definitions/PeerRole/role", "type":"string" }, "alias":{ "type":"string", "minLength":1, "maxLength":16, "description":"peer alias" }, "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" }, "ad":{ "description":"

Availability domain to place new peer. Options are AD1/AD2/AD3.

For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.

", "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads", "type":"string" } } }, "UpdatePeerDetails":{ "type":"object", "description":"Peer to modify OCPU allocation", "required":[ "ocpuAllocationParam" ], "properties":{ "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" } } }, "ScaleStorageDetails":{ "type":"object", "description":"Storage size to increase", "required":[ "storageSizeInTBs" ], "properties":{ "storageSizeInTBs":{ "type":"integer", "minimum":1, "maximum":96, "description":"Storage size in TBs" } } }, "ModifyPeerDetails":{ "type":"object", "description":"Peer to modify OCPU allocation", "required":[ "peerName", "ocpuAllocationParam" ], "properties":{ "peerName":{ "type":"string", "minLength":1, "maxLength":64, "description":"Peer identifier" }, "ocpuAllocationParam":{ "$ref":"#/definitions/OcpuAllocationNumberParam" } } }, "ScaleBlockchainPlatformDetails":{ "description":"Scale operation details for a Blockchain Platform. The scale operation payload has multiple options:\n \nThe scale operation payload must have at least one of the above options.\n", "type":"object", "properties":{ "addOsns":{ "type":"array", "description":"New OSNs to add", "items":{ "$ref":"#/definitions/CreateOsnDetails" } }, "addReplicas":{ "$ref":"#/definitions/ReplicaDetails" }, "addPeers":{ "type":"array", "description":"New peers to add", "items":{ "$ref":"#/definitions/CreatePeerDetails" } }, "addStorage":{ "$ref":"#/definitions/ScaleStorageDetails" }, "modifyPeers":{ "type":"array", "description":"Modify OCPU allocation to existing peers", "items":{ "$ref":"#/definitions/ModifyPeerDetails" } }, "removeReplicas":{ "$ref":"#/definitions/ReplicaDetails" }, "removeOsns":{ "type":"array", "description":"OSN ID list to remove", "items":{ "type":"string" } }, "removePeers":{ "type":"array", "description":"Peer ID list to remove", "items":{ "type":"string" } } } }, "ScaledBlockchainPlatformPreview":{ "description":"Blockchain Platform Instance description preview after scaling.", "type":"object", "required":[ "id", "compartmentId", "displayName", "computeShape" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Blockchain Platform instance display name. Can be renamed.", "type":"string" }, "compartmentId":{ "description":"Compartment identifier", "type":"string" }, "description":{ "description":"Blockchain Platform instance description", "type":"string" }, "computeShape":{ "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.", "type":"string" }, "storageSizeInTBs":{ "type":"number", "format":"double", "description":"Storage size in TBs" }, "storageSizeInTBsPostScaling":{ "type":"number", "format":"double", "description":"Storage size in TBs post-scaling" }, "componentDetails":{ "$ref":"#/definitions/BlockchainPlatformComponentDetails" }, "replicas":{ "$ref":"#/definitions/ReplicaDetails" }, "componentDetailsPostScaling":{ "$ref":"#/definitions/BlockchainPlatformComponentDetails" }, "replicasPostScaling":{ "$ref":"#/definitions/ReplicaDetails" }, "hostOcpuUtilizationInfo":{ "type":"array", "description":"List of OCPU utilization for all hosts", "items":{ "$ref":"#/definitions/OcpuUtilizationInfo" } }, "hostOcpuUtilizationInfoPostScaling":{ "type":"array", "description":"List of OCPU utilization for all hosts post-scaling", "items":{ "$ref":"#/definitions/OcpuUtilizationInfo" } }, "newVmCount":{ "type":"integer", "description":"Number of new VMs that would be created" }, "meteringPreview":{ "$ref":"#/definitions/ScaledPlatformMeteringPreview" }, "scalePayload":{ "$ref":"#/definitions/ScaleBlockchainPlatformDetails" } } }, "ScaledPlatformMeteringPreview":{ "description":"Blockchain Platform metering preview after scaling", "type":"object", "properties":{ "totalOcpuAllocation":{ "type":"number", "format":"float", "description":"Number of total OCPU allocation for the Blockchain Platform" }, "totalOcpuAllocationPostScaling":{ "type":"number", "format":"float", "description":"Number of total OCPU allocation for the Blockchain Platform after scaling" }, "storageMeteredUnits":{ "type":"number", "format":"double", "description":"Current Storage metered units in TBs" }, "extraStorageMeteredUnits":{ "type":"number", "format":"double", "description":"Extra Storage units required in TBs" }, "storageMeteredUnitsPostScaling":{ "type":"number", "format":"double", "description":"Total Post Scaling Storage metered units in TBs" } } }, "BlockchainPlatformPatchSummary":{ "type":"object", "description":"Patch details", "properties":{ "id":{ "type":"string", "description":"Patch ID" }, "serviceVersion":{ "type":"string", "description":"Patch service version" }, "patchInfoUrl":{ "type":"string", "description":"A URL for the patch-specific documentation" }, "timePatchDue":{ "type":"string", "format":"date-time", "description":"Patch due date for customer-initiated patching" } } }, "BlockchainPlatformPatchCollection":{ "type":"object", "description":"Result of a patch list. Contains PatchSummary", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of PatchSummary", "items":{ "$ref":"#/definitions/BlockchainPlatformPatchSummary" } } } }, "MetadataDetails":{ "type":"object", "description":"Metadata parameter details", "required":[ "paramName", "paramValue", "isJsonValue" ], "properties":{ "paramName":{ "type":"string", "description":"Metadata param name" }, "paramValue":{ "type":"string", "description":"Metadata param value. Complex value will be a JSON string." }, "isJsonValue":{ "type":"boolean", "description":"Indicates if the value is a JSON string" } } }, "Error":{ "description":"Error Information.", "required":[ "code", "message" ], "properties":{ "code":{ "description":"A short error code that defines the error, meant for programmatic parsing.", "type":"string" }, "message":{ "description":"A human-readable error string.", "type":"string" } } }, "WorkRequest":{ "description":"A description of workrequest status", "properties":{ "operationType":{ "type":"string", "enum":[ "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", "WORKREQUEST_CLEANUP" ], "description":"Type of the work request" }, "status":{ "type":"string", "enum":[ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ], "description":"Status of current work request." }, "id":{ "type":"string", "description":"The ID of the work request." }, "compartmentId":{ "type":"string", "description":"The OCID of the compartment that contains the work request. Work requests should be scoped to\nthe same compartment as the resource the work request affects. If the work request affects multiple resources,\nand those resources are not in the same compartment, it is up to the service team to pick the primary\nresource whose compartment should be used\n" }, "resources":{ "type":"array", "items":{ "$ref":"#/definitions/WorkRequestResource" }, "description":"The resources affected by this work request." }, "percentComplete":{ "type":"number", "format":"float", "description":"Percentage of the request completed." }, "timeAccepted":{ "type":"string", "format":"date-time", "description":"The date and time the request was created, as described in\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.\n" }, "timeStarted":{ "type":"string", "format":"date-time", "description":"The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),\nsection 14.29.\n" }, "timeFinished":{ "type":"string", "format":"date-time", "description":"The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" } }, "required":[ "operationType", "status", "id", "compartmentId", "resources", "percentComplete", "timeAccepted" ] }, "WorkRequestSummary":{ "description":"A description of workrequest status", "properties":{ "operationType":{ "type":"string", "enum":[ "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", "WORKREQUEST_CLEANUP" ], "description":"Type of the work request" }, "status":{ "x-obmcs-enumref":"#/definitions/WorkRequest/status", "description":"Status of current work request.", "type":"string" }, "id":{ "type":"string", "description":"The ID of the work request." }, "compartmentId":{ "type":"string", "description":"The OCID of the compartment that contains the work request. Work requests should be scoped to\nthe same compartment as the resource the work request affects. If the work request affects multiple resources,\nand those resources are not in the same compartment, it is up to the service team to pick the primary\nresource whose compartment should be used\n" }, "resources":{ "type":"array", "items":{ "$ref":"#/definitions/WorkRequestResource" }, "description":"The resources affected by this work request." }, "percentComplete":{ "type":"number", "format":"float", "description":"Percentage of the request completed." }, "timeAccepted":{ "type":"string", "format":"date-time", "description":"The date and time the request was created, as described in\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.\n" }, "timeStarted":{ "type":"string", "format":"date-time", "description":"The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),\nsection 14.29.\n" }, "timeFinished":{ "type":"string", "format":"date-time", "description":"The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" } }, "required":[ "operationType", "id", "compartmentId", "resources", "percentComplete", "timeAccepted" ] }, "WorkRequestCollection":{ "type":"object", "description":"Result of a platform list or search. Contains WorkRequestSummary", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of WorkRequestSummary", "items":{ "$ref":"#/definitions/WorkRequestSummary" } } } }, "WorkRequestResource":{ "description":"A resource created or operated on by a work request.", "properties":{ "entityType":{ "type":"string", "description":"The resource type the work request affects." }, "actionType":{ "description":"The way in which this resource is affected by the work tracked in the work request.\nA resource being created, updated, or deleted will remain in the IN_PROGRESS state until\nwork is complete for that resource at which point it will transition to CREATED, UPDATED,\nor DELETED, respectively.\n", "enum":[ "CREATED", "UPDATED", "DELETED", "IN_PROGRESS", "RELATED" ], "type":"string" }, "identifier":{ "type":"string", "description":"The identifier of the resource the work request affects." }, "entityUri":{ "type":"string", "description":"The URI path that the user can do a GET on to access the resource metadata" }, "subTypeDetails":{ "type":"array", "description":"Collection of SubType information for a work request resource.", "items":{ "$ref":"#/definitions/WorkRequestResourceSubTypeDetail" } } }, "required":[ "actionType", "entityType", "identifier" ] }, "WorkRequestResourceSubTypeDetail":{ "description":"Subtype information for a work request resource.", "properties":{ "subType":{ "type":"string", "description":"Subtype of the work request resource like OSN or peer.\n" }, "subTypeKey":{ "type":"string", "description":"The identifier of the resource subtype." }, "subTypeStatus":{ "description":"Status of the resource subtype, as a result of the work tracked in this work request.\nThe resource subtype would be CREATED, UPDATED or DELETED after the work request is completed.\n", "enum":[ "CREATED", "UPDATED", "DELETED" ], "type":"string" } }, "required":[ "subType", "subTypeKey", "subTypeStatus" ] }, "WorkRequestError":{ "description":"An error encountered while executing a work request.", "properties":{ "code":{ "type":"string", "description":"A machine-usable code for the error that occured. Error codes are listed on\n(https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)\n" }, "message":{ "type":"string", "description":"A human readable description of the issue encountered." }, "timestamp":{ "type":"string", "format":"date-time", "description":"The time the error occured. An RFC3339 formatted datetime string." } }, "required":[ "code", "message", "timestamp" ] }, "WorkRequestErrorCollection":{ "type":"object", "description":"Result of a platform list or search. Contains WorkRequestError", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of WorkRequestError", "items":{ "$ref":"#/definitions/WorkRequestError" } } } }, "WorkRequestLogEntry":{ "description":"A log message from the execution of a work request.", "properties":{ "message":{ "type":"string", "description":"Human-readable log message." }, "timestamp":{ "type":"string", "format":"date-time", "description":"The time the log message was written. An RFC3339 formatted datetime string" } }, "required":[ "message", "timestamp" ] }, "WorkRequestLogEntryCollection":{ "type":"object", "description":"Result of a platform lpnist or search. Contains WorkRequestLogEntry", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of WorkRequestLogEntry", "items":{ "$ref":"#/definitions/WorkRequestLogEntry" } } } }, "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 }, "maxConnectionAttempts":{ "type":"integer", "default":120, "example":120 }, "msgExpirationFactor":{ "type":"integer", "default":20, "example":20 }, "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 }, "installTimeout":{ "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 }, "installTimeout":{ "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 }, "installTimeout":{ "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" }, "kafkaRetry":{ "$ref":"#/definitions/orderKafkaRetry" }, "raftRetry":{ "$ref":"#/definitions/orderRaftRetry" } } }, "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 in Kafka mode", "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 in Raft mode", "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" } } }, "ApproveCCReq":{ "type":"object", "required":[ "chaincodeName", "chaincodeVersion", "chaincodePackageID", "chaincodeInitRequired" ], "properties":{ "chaincodeName":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "chaincodePackageID":{ "type":"string" }, "upgrade":{ "type":"boolean" }, "chaincodeSequence":{ "type":"string" }, "chaincodeInitRequired":{ "type":"boolean" }, "endorsementPolicy":{ "type":"object", "required":[ "type", "policy" ], "properties":{ "type":{ "type":"string", "enum":[ "signature-policy", "channel-config-policy" ] }, "policy":{ "type":"string" } } }, "dataCollectionConfig":{ "type":"array", "items":{ "type":"object", "required":[ "name", "policy", "requiredPeerCount", "maxPeerCount", "blockToLive" ], "properties":{ "name":{ "type":"string" }, "policy":{ "type":"string" }, "requiredPeerCount":{ "type":"number" }, "maxPeerCount":{ "type":"number" }, "blockToLive":{ "type":"number" }, "memberOnlyRead":{ "type":"boolean" }, "memberOnlyWrite":{ "type":"boolean" }, "endorsementPolicy":{ "type":"object", "properties":{ "signaturePolicy":{ "type":"string" }, "channelConfigPolicy":{ "type":"string" } } } } } } }, "example":{ "chaincodeName":"myCC1", "chaincodeVersion":"v1", "chaincodePackageID":"mycc:dd46d5a2e5cad160d625dba27c85b7aaa534dd3a78c4fce9c514e0ac6b6cc755", "chaincodeInitRequired":false, "upgrade":false, "endorsementPolicy":{ "type":"signature-policy", "policy":"OR('org1.member')" }, "dataCollectionConfig":[ { "name":"test", "policy":"OR('org1.member')", "requiredPeerCount":1, "maxPeerCount":2, "blockToLive":10, "memberOnlyRead":true, "memberOnlyWrite":true, "endorsementPolicy":{ "signaturePolicy":"OutOf(1,'org1.member')" } } ] } }, "CommitCCReq":{ "type":"object", "required":[ "chaincodeName", "chaincodeVersion", "chaincodeInitRequired" ], "properties":{ "chaincodeName":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "chaincodeInitRequired":{ "type":"boolean" }, "endorsementPolicy":{ "type":"object", "required":[ "type", "policy" ], "properties":{ "type":{ "type":"string", "enum":[ "signature-policy", "channel-config-policy" ] }, "policy":{ "type":"string" } } }, "dataCollectionConfig":{ "type":"array", "items":{ "type":"object", "required":[ "name", "policy", "requiredPeerCount", "maxPeerCount", "blockToLive" ], "properties":{ "name":{ "type":"string" }, "policy":{ "type":"string" }, "requiredPeerCount":{ "type":"number" }, "maxPeerCount":{ "type":"number" }, "blockToLive":{ "type":"number" }, "memberOnlyRead":{ "type":"boolean" }, "memberOnlyWrite":{ "type":"boolean" }, "endorsementPolicy":{ "type":"object", "properties":{ "signaturePolicy":{ "type":"string" }, "channelConfigPolicy":{ "type":"string" } } } } } } }, "example":{ "chaincodeName":"myCC1", "chaincodeVersion":"v1", "chaincodeInitRequired":false, "endorsementPolicy":{ "type":"signature-policy", "policy":"OR('org1.member')" }, "dataCollectionConfig":[ { "name":"test", "policy":"OR('org1.member')", "requiredPeerCount":1, "maxPeerCount":2, "blockToLive":10, "memberOnlyRead":true, "memberOnlyWrite":true, "endorsementPolicy":{ "signaturePolicy":"OutOf(1,'org1.member')" } } ] } }, "CheckCommitReadinessCCReq":{ "type":"object", "required":[ "chaincodeName", "chaincodeVersion", "chaincodeInitRequired" ], "properties":{ "chaincodeName":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "chaincodeSequence":{ "type":"string" }, "chaincodeInitRequired":{ "type":"boolean" }, "endorsementPolicy":{ "type":"object", "required":[ "type", "policy" ], "properties":{ "type":{ "type":"string", "enum":[ "signature-policy", "channel-config-policy" ] }, "policy":{ "type":"string" } } }, "dataCollectionConfig":{ "type":"array", "items":{ "type":"object", "required":[ "name", "policy", "requiredPeerCount", "maxPeerCount", "blockToLive" ], "properties":{ "name":{ "type":"string" }, "policy":{ "type":"string" }, "requiredPeerCount":{ "type":"number" }, "maxPeerCount":{ "type":"number" }, "blockToLive":{ "type":"number" }, "memberOnlyRead":{ "type":"boolean" }, "memberOnlyWrite":{ "type":"boolean" }, "endorsementPolicy":{ "type":"object", "properties":{ "signaturePolicy":{ "type":"string" }, "channelConfigPolicy":{ "type":"string" } } } } } } }, "example":{ "chaincodeName":"myCC1", "chaincodeVersion":"v1", "chaincodeInitRequired":false, "endorsementPolicy":{ "type":"signature-policy", "policy":"OR('org1.member')" }, "dataCollectionConfig":[ { "name":"test", "policy":"OR('org1.member')", "requiredPeerCount":1, "maxPeerCount":2, "blockToLive":10, "memberOnlyRead":true, "memberOnlyWrite":true, "endorsementPolicy":{ "signaturePolicy":"OutOf(1,'org1.member')" } } ] } }, "QueryCCReq":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string", "enum":[ "Approved", "Committed" ] }, "chaincodeName":{ "type":"string" }, "sequence":{ "type":"string" } }, "example":{ "status":"Approved", "chaincodeName":"myCC1", "sequence":"1" } }, "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":[ "INFO", "DEBUG" ] } } }, "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" ] }, "logTransactionEvents":{ "type":"boolean", "default":false }, "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", "properties":{ "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" ] }, "logTransactionEvents":{ "type":"boolean", "default":false }, "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" }, "creator":{ "type":"string" }, "mspIds":{ "type":"array", "items":{ "type":"string" } } } } }, "createchannel":{ "type":"object", "properties":{ "channeName":{ "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", "required":[ "source", "peers" ], "properties":{ "source":{ "type":"object", "required":[ "content", "fileName" ], "properties":{ "content":{ "type":"string", "description":"The content should be base64 encoded string of chaincode source (.zip) or chaincode package (tar.gz)." }, "fileName":{ "type":"string" }, "isPackaged":{ "type":"boolean", "description":"True, if the value of 'source.content' represents chaincode package (tar.gz), or false, if it represents chaincode source (.zip)." } } }, "label":{ "type":"string", "description":"Required when the value of 'source.content' represents the chaincode source (.zip). Not allowed when 'source.isPackaged' is true." }, "type":{ "type":"string", "enum":[ "golang", "node", "java" ], "description":"Required when the value of 'source.content' represents the chaincode source (.zip). Not allowed when 'source.isPackaged' is true." }, "peers":{ "type":"array", "items":{ "type":"object", "required":[ "url" ], "properties":{ "url":{ "type":"string" } } } } }, "example":{ "source":{ "fileName":"example_cc", "content":"example chaincode code" }, "label":"example", "type":"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" } }, "chaincodeInfo":{ "type":"object", "properties":{ "peerId":{ "type":"string" }, "chaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "label":{ "type":"string" }, "package_id":{ "type":"string" } } } } } }, "installCCResp":{ "type":"object", "properties":{ "respMesg":{ "type":"string" }, "package_id":{ "type":"string" } } }, "queryChaincodeInfo":{ "type":"object", "properties":{ "sequence":{ "type":"string" }, "version":{ "type":"string" }, "endorsement_plugin":{ "type":"string" }, "validation_plugin":{ "type":"string" }, "collections":{ "type":"object" }, "source":{ "type":"object" }, "approvals":{ "type":"object" } } }, "checkCommitReadinessInfo":{ "type":"object", "properties":{ "chaincodeSequence":{ "type":"string" }, "approvals":{ "type":"object" } } }, "StatsMetrics":{ "type":"string", "example":"broadcast_enqueue_duration_bucket{channel=\\\"fochannel01\\\",status=\\\"SUCCESS\\\",type=\\\"ENDORSER_TRANSACTION\\\",le=\\\"0.005\\\"} 11" }, "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" } } }, "setAnchorPeers":{ "type":"object", "properties":{ "anchorPeers":{ "type":"array", "items":{ "type":"object", "properties":{ "host":{ "type":"string" }, "port":{ "type":"number" } } } } }, "example":{ "anchorPeers":[ { "host":"org1.example.com", "port":20007 } ] } }, "StatsNodeRes":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "nodeType":{ "type":"string" }, "resUsage":{ "type":"object", "properties":{ "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "cpu":{ "type":"number" }, "memory":{ "type":"number" }, "disk":{ "type":"number" } } } } }, "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" } } } }, "StatsChaincodeInfo":{ "type":"object", "properties":{ "ccName":{ "type":"string" }, "ccVersion":{ "type":"string" } } }, "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" } } }, "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" } } }, "StatsProxyConfiguredCC":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "configuredCCNum":{ "type":"number" }, "configuredCC":{ "type":"array", "items":{ "$ref":"#/definitions/StatsConfiguredCC" } } } }, "StatsConfiguredCC":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "chaincode":{ "type":"string" }, "endorsers":{ "type":"array", "items":{ "type":"string" } } } }, "StatsAuditLog":{ "type":"object", "properties":{ "total":{ "type":"number" }, "limit":{ "type":"number" }, "offset":{ "type":"number" }, "auditLogs":{ "type":"array", "items":{ "type":"object" } } } }, "InstanceVersionResp":{ "type":"object", "properties":{ "version":{ "type":"string" }, "platformVersion":{ "type":"string" }, "adminApiVersion":{ "type":"string" } } }, "AnyValue":{ }, "returnCode":{ "type":"string", "enum":[ "Success", "Failure" ] }, "encode":{ "type":"string", "enum":[ "UTF-8", "JSON", "base64" ] }, "EventSubscriptionQuery":{ "type":"object", "properties":{ "role":{ "description":"Which Hyperledger Fabric enrollment should be used", "type":"string" }, "type":{ "description":"Event type to subscribe to", "type":"string", "enum":[ "block", "filteredblock", "transaction", "chaincode" ] }, "callbackURL":{ "description":"URL to callback", "type":"string" }, "callbackTLSCerts":{ "type":"object", "properties":{ "caCert":{ "type":"string" }, "clientCert":{ "type":"string" }, "keyPassword":{ "type":"string" } } }, "expires":{ "description":"Expiration of the subscription", "type":"string" }, "maxCallbackRetry":{ "description":"Maximum number of retries. Retry interval grows based on exponential backoff to a maximum of 2 minutes.", "type":"integer" }, "txid":{ "description":"ID of the transaction", "type":"string" }, "chaincode":{ "description":"Chaincode name", "type":"string" }, "event":{ "description":"Event name", "type":"string" }, "seek":{ "description":"Start postion of the event, only be used for type \"block\" and \"filteredblock\"", "type":"string", "enum":[ "oldest", "newest", "from" ] }, "block":{ "description":"Number of the block", "type":"integer", "format":"int64" }, "oauth":{ "description":"Optionally provide details of the OAuth application, if the callback server is OAuth2 protected. Only client credential and refresh token flows are supported.", "type":"object", "properties":{ "clientID":{ "description":"The client ID for the OAuth application. It is required for a client credential flow and is optional for a refresh token flow.", "type":"string" }, "tokenUrl":{ "description":"The URL against which the call for generating an access token would be made.", "type":"string" }, "scopes":{ "description":"List of scopes to be associated with the token", "type":"array", "items":{ "type":"string" } }, "authInHeader":{ "description":"Set to true if the authorization parameters must be passed in the header.", "type":"boolean" } } } } }, "EventSubscription":{ "type":"object", "required":[ "type", "callbackURL" ], "properties":{ "role":{ "description":"Specifies which Hyperledger Fabric enrollment should be used", "type":"string" }, "type":{ "description":"Event type to subscribe to", "type":"string", "enum":[ "block", "filteredblock", "transaction", "chaincode" ] }, "callbackURL":{ "description":"URL to callback", "type":"string" }, "callbackTLSCerts":{ "type":"object", "properties":{ "caCert":{ "type":"string" }, "clientCert":{ "type":"string" }, "keyPassword":{ "type":"string" } } }, "expires":{ "description":"Expiration of the subscription", "type":"string" }, "maxCallbackRetry":{ "description":"Maximum number of retries. The retry interval grows based on exponential backoff to a maximum of 2 minutes.", "type":"integer" }, "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 postion of the event, only be used for type \"block\" and \"filteredblock\"", "type":"string", "enum":[ "oldest", "newest", "from" ] }, "block":{ "description":"Number of the block", "type":"integer", "format":"int64" }, "oauth":{ "description":"Optionally provide details of the OAuth application, if the callback server is OAuth2 protected. Only client credential and refresh token flows are supported.", "type":"object", "properties":{ "clientID":{ "description":"The client ID for the Oauth application. It is required in case of client credential flow and can be provided optionally in refresh token flow as well", "type":"string" }, "clientSecret":{ "description":"The client secret for the OAuth application. It is required for a client credential flow, and is optional in a refresh token flow.", "type":"string" }, "refreshToken":{ "description":"Generate and pass the refresh token if using a refresh token flow.", "type":"string" }, "tokenUrl":{ "description":"The URL against which the call for generating access token will be made.", "type":"string" }, "scopes":{ "description":"List of scopes to be associated with the token.", "type":"array", "items":{ "type":"string" } }, "authInHeader":{ "description":"Set to true if the authorization parameters have to be passed in the header.", "type":"boolean" } } } } }, "AuditLogEventSubscription":{ "type":"object", "required":[ "type", "callbackURL", "callbackTLSCerts" ], "properties":{ "type":{ "description":"Audit log event type to subscribe to", "type":"string", "enum":[ "auditlog" ] }, "callbackURL":{ "description":"URL to callback", "type":"string" }, "callbackTLSCerts":{ "type":"object", "properties":{ "caCert":{ "type":"string" }, "clientCert":{ "type":"string" }, "keyPassword":{ "type":"string" } } }, "expires":{ "description":"Expiration of the subscription", "type":"string" }, "action":{ "description":"Name of auditlog action", "type":"string" }, "userIdentity":{ "description":"Name of auditlog userIdentity", "type":"string" } } }, "UnEventSubscription":{ "type":"object", "required":[ "subid" ], "properties":{ "subid":{ "description":"ID of the subscription when successful", "type":"string" }, "status":{ "type":"string" }, "errorMessage":{ "type":"string" } } }, "customEnrollments":{ "type":"array", "items":{ "type":"string" } }, "createCustomEnrollmentBody":{ "type":"object", "required":[ "enrollmentId" ], "properties":{ "enrollmentId":{ "description":"enrollment ID", "type":"string" }, "attributes":{ "description":"Custom keys with string value attributes to be added to the enrollment certificate", "type":"object", "properties":{ "username":{ "description":"Special attribute to associate the default user for the enrollment", "type":"string" } }, "additionalProperties":{ "type":"string" } } }, "example":{ "enrollmentId":"my-custom-enrollment", "attributes":{ "username":"my_username@oracle.com", "department":"operations", "role":"ADMIN" } } }, "customEnrollmentUsers":{ "type":"array", "items":{ "type":"string" } }, "associateRestUserBody":{ "type":"object", "required":[ "userName" ], "properties":{ "userName":{ "description":"REST client user name", "type":"string" } } }, "atomicTransactionLRCReq":{ "description":"Request body for transaction to be executed as the Last Resource Commit (lrc) transaction", "type":"object", "properties":{ "ethReq":{ "$ref":"#/definitions/atomicTransactionEthRequest" } } }, "atomicTransactionEthRequest":{ "description":"Request body for ethereum transaction to be executed", "type":"object", "required":[ "url", "pendingTimeout" ], "properties":{ "url":{ "description":"The full URL, along with the protocol and port, representing the network endpoint", "type":"string" }, "unsignedReq":{ "type":"object", "required":[ "privateKey", "toAddress", "ethValue", "gasLimit" ], "properties":{ "privateKey":{ "description":"The hex string representing the private key of the source account", "type":"string" }, "type":{ "description":"Select 0 to represent legacy transactions, select 2 (default) to represent EIP-1559 transactions", "type":"integer" }, "nonce":{ "description":"Transaction counter representing the sequence of transactions executed by the account", "type":"integer" }, "ethValue":{ "description":"Amount of ETH to transfer from sender to recipient in WEI", "type":"string" }, "gasTipCap":{ "description":"The maximum fees to be included as a tip to the validator", "type":"string" }, "gasFeeCap":{ "description":"Maximum fees users are willing to pay for the transaction", "type":"string" }, "gasPrice":{ "description":"Price in wei for each unit of gas used in the transaction", "type":"string" }, "gasLimit":{ "description":"The maximum amount of gas units that can be consumed by the transaction", "type":"integer" }, "toAddress":{ "description":"The receiving address when completing ETH transfers, or the contract address when executing smart contracts", "type":"string" }, "data":{ "description":"Hex input data to be used along with the transactions; used for smart contract executions", "type":"string" }, "isContractCall":{ "description":"Specifies if the given request is a smart contract call", "type":"boolean", "default":false }, "methodName":{ "description":"Method name to be called in the smart contract. Required if isContractCall is set to true", "type":"string" }, "abi":{ "description":"Smart contract Application Binary Interface (ABI) or method ABI that is called in the smart contract. Required if isContractCall is set to true", "type":"string" }, "paramKeys":{ "description":"List of keys that are to be extracted from the results of the final OBP chaincode transaction and sent to the smart contract via parameters", "type":"array", "items":{ "type":"string" } }, "params":{ "description":"Parameters that are required by the method to be called in the smart contract. Required if isContractCall is set to true", "type":"object", "additionalProperties":true } } }, "signedReq":{ "type":"object", "required":[ "signedTxHex" ], "properties":{ "signedTxHex":{ "description":"Signed request string in hex representation", "type":"string" } } }, "finalityParams":{ "type":"object", "properties":{ "checkFinality":{ "description":"Specifies whether transaction finality check is required for the transaction. When true, transaction is rechecked after one of blocksToWait or secondsToWait is satisfied", "type":"boolean" }, "blocksToWait":{ "description":"Number of blocks to wait for before a transaction is considered final", "type":"integer" }, "secondsToWait":{ "description":"Number of seconds to wait before a transaction is considered final", "type":"integer" } } }, "chainId":{ "description":"The network ID of the Ethereum network", "type":"integer" }, "pendingTimeout":{ "description":"The maximum time, in seconds, to wait if the transaction remains in pending state", "type":"integer" } } }, "atomicTransactionLRCResults":{ "type":"object", "properties":{ "txStatus":{ "description":"Current status of the LRC transaction", "type":"string" }, "ethResp":{ "$ref":"#/definitions/atomicTransactionEthResponse" } } }, "atomicTransactionEthResponse":{ "type":"object", "properties":{ "block":{ "description":"Block number of the committed transaction", "type":"integer" }, "txHex":{ "description":"Hex string representing the transaction executed", "type":"string" }, "error":{ "description":"Error message in case of failures", "type":"string" } } }, "atomicTransactionInvokeReq":{ "type":"object", "required":[ "channel", "chaincode", "args" ], "properties":{ "channel":{ "description":"ID of the channel to invoke the transaction", "type":"string" }, "chaincode":{ "description":"ID of the chaincode to invoke", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "endorsers":{ "description":"Endorsers for the chaincode", "type":"array", "items":{ "type":"string" } }, "timeout":{ "description":"Timeout in ms for the chaincode to invoke", "type":"integer", "format":"int64" }, "transientMap":{ "description":"TransientMap for the chaincode", "type":"object", "additionalProperties":{ "type":"string" } }, "sameOrgEndorser":{ "description":"Specifies if it should select endorsers of this organization only. When set to true, the endorsers field cannot be specified.", "type":"boolean", "default":false } } }, "atomicTransactionResults":{ "type":"object", "properties":{ "transactions":{ "description":"Details of individual transactions processed", "type":"array", "items":{ "$ref":"#/definitions/atomicTransactionIndividualResults" } }, "lrc":{ "$ref":"#/definitions/atomicTransactionLRCResults" }, "globalStatus":{ "description":"Current Status of the atomic transaction", "type":"string" }, "globalTxid":{ "description":"Global Transaction ID", "type":"string" }, "txStartTime":{ "description":"Transaction execution start time", "type":"string" } } }, "atomicTransactionIndividualResults":{ "type":"object", "properties":{ "channel":{ "description":"ID of the channel on which the transaction was invoked", "type":"string" }, "chaincode":{ "description":"ID of the chaincode invoked", "type":"string" }, "txstatus":{ "description":"Current status of the individual transaction", "type":"string" }, "prepare":{ "description":"Details on the prepare phase of the transaction", "type":"object", "properties":{ "txid":{ "description":"Transaction ID for the prepare phase", "type":"string" }, "error":{ "description":"Error message in case the transaction fails", "type":"string" } } }, "commit":{ "description":"Details on the commit phase of the transaction", "type":"object", "properties":{ "txid":{ "description":"Transaction ID for the commit phase", "type":"string" }, "error":{ "description":"Error message in case the transaction fails", "type":"string" } } }, "rollback":{ "description":"Details on the rollback phase of the transaction", "type":"object", "properties":{ "txid":{ "description":"Transaction ID for the rollback phase", "type":"string" }, "error":{ "description":"Error message in case the transaction fails", "type":"string" } } } } } }, "parameters":{ "BlockchainPlatformIdPathParam":{ "name":"blockchainPlatformId", "type":"string", "in":"path", "required":true, "description":"Unique service identifier." }, "PeerIdPathParam":{ "name":"peerId", "type":"string", "in":"path", "required":true, "description":"Peer identifier." }, "OsnIdPathParam":{ "name":"osnId", "type":"string", "in":"path", "required":true, "description":"OSN identifier." }, "BlockchainPlatformIdQueryParam":{ "name":"blockchainPlatformId", "in":"query", "required":true, "type":"string", "description":"Unique service identifier." }, "HostnamePathParam":{ "name":"hostname", "type":"string", "in":"path", "required":true, "description":"Unique service endpoint." }, "PaginationLimitQueryParam":{ "name":"limit", "in":"query", "type":"integer", "minimum":1, "maximum":1000, "default":10, "description":"The maximum number of items to return." }, "PaginationTokenQueryParam":{ "name":"page", "in":"query", "type":"string", "minLength":1, "maxLength":2048, "description":"The page at which to start retrieving results.", "x-default-description":"Values for the parameter should come from an opc-next-page or opc-prev-page header in a previous response." }, "SortOrderQueryParam":{ "name":"sortOrder", "in":"query", "type":"string", "enum":[ "ASC", "DESC" ], "default":"ASC", "description":"The sort order to use, either 'ASC' for ascending or 'DESC' for decending." }, "SortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, "SortByQueryParamWorkRequests":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeStarted", "workRequestId" ], "default":"timeStarted", "description":"The field to sort by. Only one sort order may be provided. Default order for TIMESTARTED is descending. Default order for WORKREQUESTID is ascending. If no value is specified TIMESTARTED is default.\n" }, "WorkRequestIdPathParam":{ "name":"workRequestId", "in":"path", "required":true, "type":"string", "description":"The ID of the asynchronous request." }, "CompartmentIdQueryParam":{ "name":"compartmentId", "in":"query", "required":true, "type":"string", "description":"The ID of the compartment in which to list resources." }, "DisplayNameQueryParam":{ "in":"query", "maxLength":255, "minLength":1, "name":"displayName", "x-default-description":"A default name is constructed by default", "type":"string", "description":"A user-friendly name. Does not have to be unique, and it's changeable.\nExample: `My new resource`\n" }, "RequestIdHeader":{ "name":"opc-request-id", "in":"header", "type":"string", "description":"The client request ID for tracing." }, "RetryTokenHeader":{ "description":"A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n", "in":"header", "maxLength":64, "minLength":1, "name":"opc-retry-token", "required":false, "type":"string" }, "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" }, "BlockchainPlatformLifecycleStateQueryParam":{ "name":"lifecycleState", "type":"string", "in":"query", "required":false, "x-default-description":"By default instances in all states are returned", "x-obmcs-enumref":"#/definitions/BlockchainPlatform/lifecycleState", "description":"A filter to only return resources that match the given lifecycle state.\nThe state value is case-insensitive.\n" }, "MetadataParamNamePathParam":{ "name":"paramName", "type":"string", "in":"path", "required":true, "description":"Metadata param name." } }, "responses":{ "400":{ "description":"Bad Request", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "401":{ "description":"Unauthorized", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "404":{ "description":"Not Found", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "409":{ "description":"Conflict", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "412":{ "description":"Precondition failed", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "429":{ "description":"Too Many Requests", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "500":{ "description":"Internal Server Error", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "default":{ "description":"Unknown Error", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "403":{ "description":"Forbidden" } }, "tags":[ { "name":"Application Operations", "description":"REST API for administrative operations" }, { "name":"Application Operations/Atomic Transactions", "description":"Use these operations to query and invoke chaincode transactions spanning multiple channels which are committed atomically." }, { "name":"Application Operations/Audit Log Events", "description":"The operations from the Application Operations/Audit Log Events category." }, { "name":"Application Operations/Events", "description":"Use these operations to subscribe or unsubscribe to chaincode events." }, { "name":"Application Operations/Transactions", "description":"Use these operations to query and invoke chaincode transactions." }, { "name":"Blockchain Network Administrative Operations/Chaincode", "description":"REST API for chaincode operations" }, { "name":"Blockchain Network Administrative Operations/Channel", "description":"REST API for channel operations" }, { "name":"Blockchain Network Administrative Operations/Nodes", "description":"REST API for nodes operations" }, { "name":"Blockchain Network Administrative Operations/Organizations", "description":"REST API for organizations operations" }, { "name":"Blockchain Platform Administrative Operations", "description":"The operations from the Blockchain Platform Administrative Operations category." }, { "name":"Statistics", "description":"REST API for statistics operations" } ], "consumes":[ "application/json" ], "securityDefinitions":{ "basicAuth":{ "type":"basic", "description":"HTTP Basic Authentication." } }, "security":[ { "basicAuth":[ ] } ] }