{ "swagger":"2.0", "info":{ "description":"Use the Oracle Blockchain Platform Enterprise Edition REST API to programmatically query and invoke chaincode transactions, and to manage your blockchain network.", "version":"2020.12.02", "title":"REST API for Oracle Blockchain Platform Enterprise Edition", "x-summary":"Use the Oracle Blockchain Platform Enterprise Edition REST API to programmatically query and invoke chaincode transactions, and to manage your blockchain network." }, "tags":[ { "name":"Application Operations", "description":"REST API for administrative operations" }, { "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/Configuration", "description":"Use these operations to work with platform configurations." }, { "name":"Blockchain Platform Administrative Operations/Platform", "description":"Use these operations to administer Oracle Blockchain Platform." }, { "name":"Statistics", "description":"REST API for statistics operations" } ], "schemes":[ "http", "https" ], "paths":{ "/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/{channelId}/transaction-id":{ "parameters":[ { "name":"channelId", "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 ID 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 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-{channelId}-transaction-id-get", "x-filename-id":"restproxy-api-v2-channels-channelid-transaction-id-get" } }, "/restproxy/api/v2/channels/{channelId}/transactions":{ "parameters":[ { "name":"channelId", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Application Operations/Transactions" ], "summary":"Send a Transaction", "description":"Send a transaction", "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 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 } } } } ], "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" } } } } } }, "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-{channelId}-transactions-post", "x-filename-id":"restproxy-api-v2-channels-channelid-transactions-post" } }, "/restproxy/api/v2/channels/{channelId}/chaincode-queries":{ "parameters":[ { "name":"channelId", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "post":{ "tags":[ "Application Operations/Transactions" ], "summary":"Query a Chaincode", "description":"Query a chaincode", "operationId":"queryChaincode", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"query request", "description":"Request to query a chaincode", "schema":{ "type":"object", "required":[ "chaincode", "args" ], "properties":{ "role":{ "description":"Name of Fabric enrollment to be used", "type":"string" }, "chaincode":{ "description":"Name of the chaincode", "type":"string" }, "args":{ "description":"Arguments for the chaincode", "type":"array", "items":{ "type":"string" } }, "timeout":{ "description":"Timeout in ms for the chaincode to invoke", "type":"integer", "format":"int64", "default":18000 }, "transientMap":{ "description":"TransientMap for the chaincode", "type":"object", "additionalProperties":{ "type":"string" } }, "peer":{ "description":"Endpoint of the target peer", "type":"string" } } } } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "default":"" }, "result":{ "type":"object", "required":[ "payload", "encode" ], "properties":{ "message":{ "type":"string" }, "payload":{ "$ref":"#/definitions/AnyValue" }, "encode":{ "$ref":"#/definitions/encode" } } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-chaincode-queries-post", "x-filename-id":"restproxy-api-v2-channels-channelid-chaincode-queries-post" } }, "/restproxy/api/v2/channels/{channelId}/transactions/{transactionId}":{ "parameters":[ { "name":"channelId", "in":"path", "description":"ID of the channel", "required":true, "type":"string" }, { "name":"transactionId", "in":"path", "description":"ID of the transaction", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Transactions" ], "summary":"Get Transaction Information", "description":"Get the information for a transaction, whether it's submitted or not", "operationId":"getTransactionInfo", "produces":[ "application/json" ], "parameters":[ { "name":"role", "in":"query", "description":"Name of Fabric enrollment to be used", "type":"string" } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string" }, "result":{ "type":"object", "required":[ "txid", "status" ], "properties":{ "txid":{ "description":"Transaction ID", "type":"string" }, "status":{ "description":"Transaction Status", "type":"string", "enum":[ "valid", "invalid", "not found" ] }, "message":{ "type":"string" }, "payload":{ "$ref":"#/definitions/AnyValue" }, "encode":{ "$ref":"#/definitions/encode" } } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-transactions-{transactionId}-get", "x-filename-id":"restproxy-api-v2-channels-channelid-transactions-transactionid-get" } }, "/restproxy/api/v2/channels/{channelId}/event-subscriptions":{ "parameters":[ { "name":"channelId", "in":"path", "description":"ID of the channel", "required":true, "type":"string" } ], "get":{ "tags":[ "Application Operations/Events" ], "summary":"List Event Subscriptions", "description":"List all event subscriptions", "operationId":"listSubscribeEvents", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"query", "name":"role", "type":"string", "description":"Name of Fabric enrollment to be used" }, { "in":"query", "name":"user-id", "type":"string", "description":"User name. It should be the same user defined in basic auth." }, { "in":"query", "name":"subscription-id", "type":"string", "description":"ID of the subscription when operation succeeds" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when operation fails", "default":"" }, "result":{ "type":"array", "items":{ "$ref":"#/definitions/EventSubscription" } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-event-subscriptions-get", "x-filename-id":"restproxy-api-v2-channels-channelid-event-subscriptions-get" }, "post":{ "tags":[ "Application Operations/Events" ], "summary":"Subscribe to an Event", "description":"Subscribe to an event", "operationId":"subscribeEvent", "produces":[ "application/json" ], "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"subscribe event request", "description":"Request to subscribe to an event", "required":true, "schema":{ "$ref":"#/definitions/EventSubscription" } } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string", "description":"Error message when operation fails", "default":"" }, "result":{ "type":"object", "required":[ "subid" ], "properties":{ "subid":{ "description":"ID of the subscription when operation succeeds", "type":"string" } } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-event-subscriptions-post", "x-filename-id":"restproxy-api-v2-channels-channelid-event-subscriptions-post" }, "delete":{ "tags":[ "Application Operations/Events" ], "summary":"Unsubscribe from an Event", "description":"Unsubscribe from an event", "operationId":"unsubscribeEvent", "produces":[ "application/json" ], "parameters":[ { "in":"query", "name":"role", "type":"string", "description":"Name of Fabric enrollment to be used" }, { "in":"query", "name":"user-id", "type":"string", "description":"User name. It should be the same as the user defined in basic auth." }, { "in":"query", "name":"subscription-id", "type":"string", "description":"ID of the subscription when operation succeeds" } ], "responses":{ "200":{ "description":"Operation successful", "schema":{ "type":"object", "required":[ "returnCode" ], "properties":{ "returnCode":{ "$ref":"#/definitions/returnCode" }, "error":{ "type":"string" }, "result":{ "type":"array", "items":{ "$ref":"#/definitions/UnEventSubscription" } } } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "403":{ "$ref":"#/responses/403" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"restproxy-api-v2-channels-{channelId}-event-subscriptions-delete", "x-filename-id":"restproxy-api-v2-channels-channelid-event-subscriptions-delete" } }, "/api/v1/blockchainPlatforms/instances":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"CreateBlockchainPlatform", "summary":"Create New Blockchain Platform Instance", "description":"Create a new Blockchain Platform instance.\n", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"thirdPartyCACert", "description":"A zip file containing third party CA certificates. The CA key and certificate files used when issuing enrollment certificates (ECerts) and transaction certificates (TCerts). The chainfile (if it exists) contains the certificate chain which should be trusted for this CA, where the first in the chain is always the root CA certificate. File list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)].", "required":false, "in":"formData", "type":"string" }, { "name":"lbrTLSRootCert", "description":"A zip file containing TLS CA certificate file[tls-ca.pem], and optional TLS cert and key file[tls-cert.pem, tls-key.pem] for LBR client.", "required":false, "type":"string", "in":"formData" }, { "name":"payload", "description":"Details for the new service.", "required":true, "in":"formData", "schema":{ "$ref":"#/definitions/BlockchainPlatformCreationDetails" } } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location Header with a URL to query the status of the request.\n", "type":"string" }, "Retry-After":{ "description":"Retry after N number of seconds.\n", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-post", "x-filename-id":"api-v1-blockchainplatforms-instances-post" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"ListBlockchainPlatforms", "summary":"List Blockchain Platform Instances", "description":"Get summary and list of Blockchain Platform instances.", "parameters":[ { "$ref":"#/parameters/IncludeSummaryQueryParam" } ], "responses":{ "200":{ "description":"Get summary and list of blockchain platform instances", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/BlockchainPlatformSummaryWrapper" } } }, "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":"api-v1-blockchainPlatforms-instances-get", "x-filename-id":"api-v1-blockchainplatforms-instances-get" } }, "/api/v1/blockchainPlatforms/instances/{id}":{ "put":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"UpdateBlockchainPlatform", "summary":"Update a Blockchain Platform Instance", "description":"Update a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "in":"body", "name":"UpdatePayload", "required":true, "description":"Request payload in JSON", "schema":{ "$ref":"#/definitions/UpdatePayload" } } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-put", "x-filename-id":"api-v1-blockchainplatforms-instances-id-put" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetBlockchainPlatform", "summary":"Get Blockchain Platform Instance Details", "description":"Get a particular Blockchain Platform instance details.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/BlockchainPlatformDetails" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-get", "x-filename-id":"api-v1-blockchainplatforms-instances-id-get" }, "delete":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"DeleteBlockchainPlatform", "summary":"Delete a Blockchain Platform Instance", "description":"Delete a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "$ref":"#/parameters/DataRetentionPolicyParam" }, { "$ref":"#/parameters/ForceDeleteParam" } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location Header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-delete", "x-filename-id":"api-v1-blockchainplatforms-instances-id-delete" } }, "/api/v1/blockchainPlatforms/instances/{id}/action/start":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"StartBlockchainPlatform", "summary":"Start a Blockchain Platform Instance", "description":"Start a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location Header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-action-start-post", "x-filename-id":"api-v1-blockchainplatforms-instances-id-action-start-post" } }, "/api/v1/blockchainPlatforms/instances/{id}/action/stop":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"StopBlockchainPlatform", "summary":"Stop a Blockchain Platform Instance", "description":"Stop a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location Header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-action-stop-post", "x-filename-id":"api-v1-blockchainplatforms-instances-id-action-stop-post" } }, "/api/v1/blockchainPlatforms/instances/{id}/operation/{opid}/status":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetOperationStatus", "summary":"Get Operation Status of an Instance", "description":"Get the operation status of an Blockchain Platform instance.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "in":"path", "name":"opid", "type":"string", "required":true, "description":"the operation id to query" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/OperationStatus" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-operation-{opid}-status-get", "x-filename-id":"api-v1-blockchainplatforms-instances-id-operation-opid-status-get" } }, "/api/v1/blockchainPlatforms/instances/{id}/patch":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"PatchInstance", "summary":"Patch a Blockchain Platform Instance", "description":"Patch a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "in":"body", "name":"InstancePatchPayload", "description":"request payload in JSON", "schema":{ "$ref":"#/definitions/InstancePatchPayload" } } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location Header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-patch-post", "x-filename-id":"api-v1-blockchainplatforms-instances-id-patch-post" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetInstancePatch", "summary":"Get Instance Patch Details", "description":"Get instance patch details.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "$ref":"#/parameters/InstancePatchTypeParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/InstancePatchInfoSummary" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-patch-get", "x-filename-id":"api-v1-blockchainplatforms-instances-id-patch-get" } }, "/api/v1/blockchainPlatforms/instances/{id}/rollback":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"RollbackInstance", "summary":"Rollback Patch on a Blockchain Platform Instance", "description":"Rollback patch on a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-rollback-post", "x-filename-id":"api-v1-blockchainplatforms-instances-id-rollback-post" } }, "/api/v1/blockchainPlatforms/instances/{id}/scaleout":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"ScaleOutInstance", "summary":"Scale Out a Blockchain Platform Instance", "description":"Scale out a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "in":"body", "name":"ScaleOutPayload", "required":true, "description":"request payload in JSON", "schema":{ "$ref":"#/definitions/ScaleOutPayload" } } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-scaleout-post", "x-filename-id":"api-v1-blockchainplatforms-instances-id-scaleout-post" } }, "/api/v1/blockchainPlatforms/instances/{id}/scalein":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"ScaleInInstance", "summary":"Scale In a Blockchain Platform Instance", "description":"Scale in a Blockchain Platform instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" }, { "in":"body", "name":"ScaleInPayload", "required":true, "description":"request payload in JSON", "schema":{ "$ref":"#/definitions/ScaleInPayload" } } ], "responses":{ "202":{ "description":"Accepted", "headers":{ "Location":{ "description":"Location header with a URL to query the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-scalein-post", "x-filename-id":"api-v1-blockchainplatforms-instances-id-scalein-post" } }, "/api/v1/blockchainPlatforms/instances/{id}/lbrportmapping":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetLBRPortMapping", "summary":"Get External Load Balancer Port Mapping", "description":"Get the external load balancer port mapping for an instance.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/LBRPortMappingWrapper" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-lbrportmapping-get", "x-filename-id":"api-v1-blockchainplatforms-instances-id-lbrportmapping-get" } }, "/api/v1/blockchainPlatforms/patches":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"RegisterPatch", "summary":"Register a New Blockchain Platform Patch", "description":"Register a new Blockchain Platform patch.", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"patchArchive", "description":"A tar archive file containing patch details - metadata.json scripts/prePatch.sh scripts/postPatch.sh .tgz for each component.", "required":true, "in":"formData", "type":"string" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/PatchInfoSummary" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"api-v1-blockchainPlatforms-patches-post", "x-filename-id":"api-v1-blockchainplatforms-patches-post" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"ListBlockchainPlatformPatches", "summary":"List Blockchain Platform Patches", "description":"Gets a list of registered Blockchain Platform patches.", "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/PatchInfoSummary" } } }, "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":"api-v1-blockchainPlatforms-patches-get", "x-filename-id":"api-v1-blockchainplatforms-patches-get" } }, "/api/v1/blockchainPlatforms/patches/{patchId}/targets":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"ListPatchTargets", "summary":"List Blockchain Platform Patch Targets", "description":"List Blockchain Platform patch targets.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/PatchIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/PatchTargetInfo" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"api-v1-blockchainPlatforms-patches-{patchId}-targets-get", "x-filename-id":"api-v1-blockchainplatforms-patches-patchid-targets-get" } }, "/api/v1/blockchainPlatforms/patches/{patchId}/apply":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"ApplyPatchToTargets", "summary":"Apply Patch to Target Instances", "description":"Apply patch to one or more target instances.", "parameters":[ { "$ref":"#/parameters/PatchIdentifierPathParam" }, { "in":"body", "name":"payload", "required":true, "description":"List of target instance IDs to apply the patch", "schema":{ "$ref":"#/definitions/PatchApplyPayload" } } ], "responses":{ "202":{ "description":"Accepted", "schema":{ "$ref":"#/definitions/PatchApplySummary" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-patches-{patchId}-apply-post", "x-filename-id":"api-v1-blockchainplatforms-patches-patchid-apply-post" } }, "/api/v1/blockchainPlatforms/instances/{id}/status":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetBlockchainPlatformStatus", "summary":"Get Blockchain Platform Status", "description":"Get the Blockchain Platform status.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/BlockchainPlatformInstanceStatus" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-status-get", "x-filename-id":"api-v1-blockchainplatforms-instances-id-status-get" } }, "/api/v1/blockchainPlatforms/instances/{id}/activity":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetInstanceActivity", "summary":"Get Instance Activity Details", "description":"Get activity details for an instance.", "parameters":[ { "$ref":"#/parameters/BlockchainPlatformIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/InstanceActivityInfoSummary" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-instances-{id}-activity-get", "x-filename-id":"api-v1-blockchainplatforms-instances-id-activity-get" } }, "/api/v1/blockchainPlatforms/activities":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Platform" ], "operationId":"GetActivities", "summary":"Get All Activity Details", "description":"Get activity details for all instances.", "parameters":[ { "$ref":"#/parameters/InstanceNameTextQueryParam" }, { "$ref":"#/parameters/OperationsQueryParam" }, { "$ref":"#/parameters/FromDateQueryParam" }, { "$ref":"#/parameters/ToDateQueryParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/InstanceActivityInfoSummary" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-blockchainPlatforms-activities-get", "x-filename-id":"api-v1-blockchainplatforms-activities-get" } }, "/api/v1/configuration/cpConfig":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"GetAllControlPlaneConfiguration", "summary":"Get All Configurations for Control Plane", "description":"Get all available configurations for the control plane.", "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/CpConfigMap" } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-cpConfig-get", "x-filename-id":"api-v1-configuration-cpconfig-get" }, "post":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"saveControlPlaneConfiguration", "summary":"Save or Update a Control Plane Configuration", "description":"Save or update a control plane configuration.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"Payload", "required":true, "description":"request payload in JSON", "schema":{ "$ref":"#/definitions/CpConfigDetail" } } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-cpConfig-post", "x-filename-id":"api-v1-configuration-cpconfig-post" } }, "/api/v1/configuration/cpConfig/list":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"saveCPConfigList", "summary":"Create or Update Control Plane Configuration", "description":"Creates or updates all specified control plane configurations.", "parameters":[ { "in":"body", "name":"Payload", "required":true, "description":"Request payload in JSON", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/CpConfigDetail" } } } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-cpConfig-list-post", "x-filename-id":"api-v1-configuration-cpconfig-list-post" } }, "/api/v1/configuration/cpConfig/{configName}":{ "delete":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"DeleteCPConfig", "summary":"Delete Control Plane Configuration", "description":"Deletes the specified control plane configuration.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/CPConfigIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-cpConfig-{configName}-delete", "x-filename-id":"api-v1-configuration-cpconfig-configname-delete" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"GetCPConfig", "summary":"Get Control Plane Configuration", "description":"Gets the specified control plane configuration.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/CPConfigIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/CpConfigDetail" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-cpConfig-{configName}-get", "x-filename-id":"api-v1-configuration-cpconfig-configname-get" } }, "/api/v1/configuration/ldapConfig":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"CreateLdapConfig", "summary":"Create LDAP Configuration", "description":"Creates a new LDAP configuration.", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "name":"ldapTLSRootCACerte", "in":"formData", "type":"string" }, { "name":"setActiveLdapConfig", "type":"boolean", "in":"formData", "default":false, "required":false }, { "name":"payload", "in":"formData", "schema":{ "$ref":"#/definitions/LdapConfigPayload" } } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-ldapConfig-post", "x-filename-id":"api-v1-configuration-ldapconfig-post" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"ListAllLdapConfig", "summary":"List LDAP Configurations", "description":"Lists all the LDAP configurations.", "produces":[ "application/json" ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/LdapConfigDetail" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-ldapConfig-get", "x-filename-id":"api-v1-configuration-ldapconfig-get" } }, "/api/v1/configuration/ldapConfig/test":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"TestLdapConfig", "summary":"Test LDAP Configuration", "description":"Tests the specified LDAP configuration.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"payload", "in":"body", "schema":{ "$ref":"#/definitions/LdapConfigDetail" } } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" } }, "x-internal-id":"api-v1-configuration-ldapConfig-test-post", "x-filename-id":"api-v1-configuration-ldapconfig-test-post" } }, "/api/v1/configuration/ldapConfig/{id}":{ "post":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"UpdateLdapConfig", "summary":"Update LDAP Configuration", "description":"Updates the LDAP configuration.", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/LdapConfigIdentifierPathParam" }, { "name":"ldapTLSRootCACert", "description":"The root certificate authority (CA) certificate for the LDAP server in a .crt file", "in":"formData", "type":"string" }, { "name":"payload", "in":"formData", "schema":{ "$ref":"#/definitions/LdapConfigDetail" } }, { "name":"removeTLSRootCACert", "type":"boolean", "in":"query", "default":false, "required":false }, { "name":"setActiveLdapConfig", "type":"boolean", "in":"query", "default":false, "required":false } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "409":{ "$ref":"#/responses/409" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-ldapConfig-{id}-post", "x-filename-id":"api-v1-configuration-ldapconfig-id-post" }, "delete":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"DeleteLdapConfig", "summary":"Delete LDAP Configuration", "description":"Deletes the LDAP configuration.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/LdapConfigIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK" }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" } }, "x-internal-id":"api-v1-configuration-ldapConfig-{id}-delete", "x-filename-id":"api-v1-configuration-ldapconfig-id-delete" }, "get":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"GetLdapConfig", "summary":"Get LDAP Configuration", "description":"Gets the LDAP configuration.", "produces":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/LdapConfigIdentifierPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/LdapConfigDetail" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" } }, "x-internal-id":"api-v1-configuration-ldapConfig-{id}-get", "x-filename-id":"api-v1-configuration-ldapconfig-id-get" } }, "/api/v1/configuration/release/buildInfo":{ "get":{ "tags":[ "Blockchain Platform Administrative Operations/Configuration" ], "operationId":"GetReleaseBuildInfo", "summary":"Get Release Build Information", "description":"Get the release build information.", "produces":[ "application/json" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/ReleaseBuildInfo" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "500":{ "$ref":"#/responses/500" } }, "x-internal-id":"api-v1-configuration-release-buildInfo-get", "x-filename-id":"api-v1-configuration-release-buildinfo-get" } }, "/console/admin/api/v1.1/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-v1.1-nodes-get", "x-filename-id":"console-admin-api-v1.1-nodes-get" } }, "/console/admin/api/v1.1/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-v1.1-nodes-peers-get", "x-filename-id":"console-admin-api-v1.1-nodes-peers-get" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start a Peer Node", "description":"Start 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-v1.1-nodes-peers-{peerId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-start-post" } }, "/console/admin/api/v1.1/console/admin/api/v1.1/nodes/peers/{peerId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a Peer", "description":"Stop designated peers", "operationId":"stopPeers", "parameters":[ { "name":"peerId", "in":"path", "description":"Peer ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Node status message", "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"down", "enum":[ "down" ] } } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-console-admin-api-v1.1-nodes-peers-{peerId}-stop-post", "x-filename-id":"console-admin-api-v1.1-console-admin-api-v1.1-nodes-peers-peerid-stop-post" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}/blockaudit/{channelName}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Verify Blocks", "description":"Verifies blocks against a channel owned by the given peer.", "operationId":"getPeerBlockAudit", "produces":[ "application/json" ], "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer", "required":true, "type":"string" }, { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Response with block audit result" }, "400":{ "description":"Invalid Arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-blockaudit-{channelName}-get", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-blockaudit-channelname-get" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Peer Attributes", "description":"Get all configuration attributes of a peer.", "operationId":"getPeerAttributes", "produces":[ "application/json" ], "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer being queried", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Peer attributes", "schema":{ "$ref":"#/definitions/peerAttributes" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-get", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update Peer Node Configuration", "description":"Use this endpoint to modify the configuration attributes of a peer.", "operationId":"updatePeerAttributes", "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer being modified", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"Updated peerPatchAttributes object", "required":true, "schema":{ "$ref":"#/definitions/peerPatchAttributes" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "$ref":"#/definitions/peerPatchActionResult" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-patch", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-patch" } }, "/console/admin/api/v1.1/nodes/peers/{peerId}/joinChannel":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Join a Peer to a Channel", "description":"You can add a peer node to a channel so that the node can use it to exchange private transaction information with other peer nodes on the channel.", "operationId":"joinChannel", "parameters":[ { "name":"peerId", "in":"path", "description":"ID of peer to join the channel", "required":true, "type":"string" }, { "name":"joinchannelbody", "in":"body", "description":"Channel name", "required":true, "schema":{ "$ref":"#/definitions/joinChannel" } } ], "responses":{ "200":{ "description":"Peer joined channel successfully", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-peers-{peerId}-joinChannel-post", "x-filename-id":"console-admin-api-v1.1-nodes-peers-peerid-joinchannel-post" } }, "/console/admin/api/v1.1/nodes/export":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Export Nodes", "description":"Export a node. nodeType specifies a node type list to be exported. nodes specifies an object which points out which nodes to be exported.", "operationId":"exportNodes", "parameters":[ { "name":"nodeType", "in":"query", "description":"Types of nodes to export", "required":true, "type":"string", "default":"[\"peer\"]" }, { "name":"nodes", "in":"query", "description":"Nodes to export", "required":false, "type":"string", "default":"{\"peers\":[\"defaultPeerId\"]}" } ], "responses":{ "200":{ "description":"Nodes exported successfully", "schema":{ "$ref":"#/definitions/exportedNodes" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-export-get", "x-filename-id":"console-admin-api-v1.1-nodes-export-get" } }, "/console/admin/api/v1.1/nodes/import":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Import Nodes", "description":"Import a node.", "operationId":"importNodes", "parameters":[ { "name":"nodes", "in":"body", "description":"Nodes to import", "required":true, "schema":{ "$ref":"#/definitions/exportedNodes" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal server error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-import-post", "x-filename-id":"console-admin-api-v1.1-nodes-import-post" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start an Orderer Node", "description":"Start an orderer node. This should be done after any changes are made to the node.", "operationId":"startOrderers", "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer being started", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer status", "schema":{ "type":"object", "example":{ "status":"up" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-start-post" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop an Orderer Node", "description":"Stop an orderer node.", "operationId":"stopOrderers", "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer being stopped", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer status", "schema":{ "type":"object", "example":{ "status":"down" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-stop-post" } }, "/console/admin/api/v1.1/nodes/orderers/{ordererId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Orderer Node Configuration", "description":"An orderer node's configuration determines how the node performs and behaves on the network. Use this endpoint to see an orderer node's configuration.", "operationId":"getOrdererAttributes", "produces":[ "application/json" ], "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer to fetch", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer attributes", "schema":{ "$ref":"#/definitions/getOrdererAttributes" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-get", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update Orderer Node Configuration", "description":"An orderer node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify an orderer node's configuration.", "operationId":"updateOrdererAttributes", "parameters":[ { "name":"ordererId", "in":"path", "description":"ID of orderer", "required":true, "type":"string" }, { "name":"patchOrdererBody", "in":"body", "description":"Updated orderer attributes", "required":true, "schema":{ "$ref":"#/definitions/setOrdererAttributes" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "type":"object", "example":{ "status":"Success", "message":"content" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-orderers-{ordererId}-patch", "x-filename-id":"console-admin-api-v1.1-nodes-orderers-ordererid-patch" } }, "/console/admin/api/v1.1/nodes/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 Fabric CA node", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Fabric CA status message", "schema":{ "type":"object", "example":{ "status":"up" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-start-post" } }, "/console/admin/api/v1.1/nodes/fabricCAs/{caId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a CA Node", "description":"Stop a CA node.", "operationId":"stopFabricCAs", "parameters":[ { "name":"caId", "in":"path", "description":"Fabric CA ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Fabric CA status message", "schema":{ "type":"object", "example":{ "status":"down" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-stop-post" } }, "/console/admin/api/v1.1/nodes/fabricCAs/{caId}/":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get Configuration of a CA Node", "description":"A certificate authority (CA) node's configuration determines how the node performs and behaves on the network. Use this endpoint to get the configuration of a CA node.", "operationId":"getFabricCAAttributes", "produces":[ "application/json" ], "parameters":[ { "name":"caId", "in":"path", "description":"ID of Fabric CA to fetch", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Fabric CA attributes", "schema":{ "$ref":"#/definitions/fabricCAAttributes" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}--get", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update CA Node Configuration", "description":"A certificate authority (CA) node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify the configuration of a CA node.", "operationId":"updateFabricCAAttributes", "parameters":[ { "name":"caId", "in":"path", "description":"ID of Fabric CA", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"Updated Fabric CA attributes", "required":true, "schema":{ "$ref":"#/definitions/fabricCAWritableAttributes" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "type":"object", "example":{ "status":"Success", "message":"content" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-fabricCAs-{caId}--patch", "x-filename-id":"console-admin-api-v1.1-nodes-fabriccas-caid-patch" } }, "/console/admin/api/v1.1/nodes/restproxies/{restProxyId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Get REST Proxy Node Configuration", "description":"A REST proxy node's configuration determines how the node performs and behaves on the network. Use this endpoint to get a REST proxy node configuration.", "operationId":"getRestProxyConfig", "produces":[ "application/json" ], "parameters":[ { "name":"restProxyId", "in":"path", "description":"Unique ID of the REST node", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"REST Proxy configuration", "schema":{ "$ref":"#/definitions/restProxyConfig" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-get", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Update REST Proxy Node Configuration", "description":"A REST proxy node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify the REST proxy node configuration.", "operationId":"updateRestProxyConfig", "parameters":[ { "name":"restProxyId", "in":"path", "description":"Unique ID of the REST Proxy", "required":true, "type":"string" }, { "name":"configRestProxyBody", "in":"body", "description":"Updated REST proxy configuration", "required":true, "schema":{ "$ref":"#/definitions/restProxyWritableConfig" } } ], "responses":{ "200":{ "description":"Update success message", "schema":{ "type":"object", "example":{ "status":"Success", "message":"content" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-patch", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-patch" } }, "/console/admin/api/v1.1/nodes/restproxies/{restProxyId}/start":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Start a REST Proxy Node", "description":"Start a REST proxy node.", "operationId":"startRestProxy", "parameters":[ { "name":"restProxyId", "in":"path", "description":"Array of REST proxy IDs", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Gateway node status", "schema":{ "type":"object", "example":{ "status":"up" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-start-post", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-start-post" } }, "/console/admin/api/v1.1/nodes/restproxies/{restProxyId}/stop":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Nodes" ], "summary":"Stop a REST Proxy Node", "description":"Stop a REST proxy node.", "operationId":"stopRestProxys", "parameters":[ { "name":"restProxyId", "in":"path", "description":"REST proxy ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Gateway node status", "schema":{ "type":"object", "example":{ "status":"down" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-nodes-restproxies-{restProxyId}-stop-post", "x-filename-id":"console-admin-api-v1.1-nodes-restproxies-restproxyid-stop-post" } }, "/console/admin/api/v1.1/channels":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Channel List", "description":"Get a list of channels, optionally filtering by whether they have a given chaincode instantiated or a given peer joined.", "operationId":"listChannels", "produces":[ "application/json" ], "parameters":[ { "name":"chaincode", "in":"query", "description":"List channels where this chaincode is instantiated", "required":false, "type":"string" }, { "name":"peerID", "in":"query", "description":"List channels that this peer has joined", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"List of channels meeting query criteria", "schema":{ "$ref":"#/definitions/channels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-get", "x-filename-id":"console-admin-api-v1.1-channels-get" }, "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Create a Channel", "description":"Create a channel on your blockchain network. You can set the application capabilities version for the channel. Refer to the Oracle Blockchain Platform User Guide to learn about capabilities and which version you should select.", "operationId":"creatChannel", "parameters":[ { "name":"createchannelbody", "in":"body", "description":"Create a channel. Only certificates from v1.1 API can be used.", "required":true, "schema":{ "$ref":"#/definitions/createchannel" } } ], "responses":{ "201":{ "description":"Channel created", "schema":{ "type":"object", "example":{ "status":"SUCCESS" } } }, "202":{ "description":"In progress", "schema":{ "type":"object", "example":{ "status":"IN PROGRESS" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-post", "x-filename-id":"console-admin-api-v1.1-channels-post" } }, "/console/admin/api/v1.1/channels/{channelName}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Channel Information", "description":"You can query by channel name to get information for a channel.", "operationId":"getChannelInfo", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Information for the channel", "schema":{ "$ref":"#/definitions/channelinfo" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Channel Configuration (Deprecated in v19.1.3)", "description":"You can modify a channel's configuration by supplying updated channel configuration information.", "operationId":"updateChannelOld", "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"patchChannelBody", "in":"body", "description":"Updated channel information", "required":true, "schema":{ "$ref":"#/definitions/patchChannel" } } ], "responses":{ "200":{ "description":"Success" }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-patch", "x-filename-id":"console-admin-api-v1.1-channels-channelname-patch" } }, "/console/admin/api/v1.1/channels/{channelName}/blocks/{blockId}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Channel Block Data", "description":"If you have the channel name and block ID, you can get one block of data from a channel.", "operationId":"getBlockData", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"blockId", "in":"path", "description":"Block id", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Block data", "schema":{ "$ref":"#/definitions/blockData" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-blocks-{blockId}-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-blocks-blockid-get" } }, "/console/admin/api/v1.1/channels/{channelName}/blocks":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get a List of Block's Data", "description":"Using the channel name, a block ID range, and a time range, you can get a list of the block's data for a range of blocks on a channel, including transactions, deployments, and invocations. The time range and id range can not be enabled together. If id range is specified, time range won't take effect. This API returns 1000 blocks data at most. If no parameter is specified, it will return the latest 1000 blocks. If only fromId(since) is input, the toId(until) will be set as the current ledger height by default. If only toId(until) is input, the fromId(since) will be set as 0 by default. If the query range is beyond this value, an error message will be returned.", "operationId":"getBlocksData", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"fromId", "in":"query", "description":"The beginning ID of the selected block range", "required":false, "type":"number" }, { "name":"toId", "in":"query", "description":"The end ID of the selected block range", "required":false, "type":"number" }, { "name":"since", "in":"query", "description":"The beginning UTC time of the selected block range in the format YYYYMMDDHHmmSS", "required":false, "type":"string" }, { "name":"until", "in":"query", "description":"The end UTC time of the selected block range in the format YYYYMMDDHHmmSS", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieved block statistics information successfully", "schema":{ "$ref":"#/definitions/blockStatistic" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-blocks-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-blocks-get" } }, "/console/admin/api/v1.1/channels/{channelName}/policies":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Policies of a Channel", "description":"Update the policies of a channel.", "operationId":"updateChannelPolicies", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"channelPolicies", "in":"body", "description":"The new policies", "required":true, "schema":{ "type":"object", "properties":{ "policies":{ "type":"object", "properties":{ "readers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } }, "writers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } } } } } } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-policies-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-policies-post" } }, "/console/admin/api/v1.1/channels/{channelName}/orderingSettings":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Get Orderer Advanced Attributes for a Channel", "description":"Get orderer advanced attributes for a channel.", "operationId":"getOrderingSettings", "parameters":[ { "name":"channelName", "in":"path", "description":"the specified channel name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Orderer attributes", "schema":{ "type":"object", "example":{ "ordererAddress":[ "example.com:30021" ], "absoluteMessageBytes":102760448, "maxMessageCount":10, "preferredMessageBytes":524288, "batchTimeout":"2s", "ordererType":"kafka" } } }, "400":{ "description":"Invalid argument" }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Resource not found", "schema":{ "$ref":"#/definitions/404errorModels" } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-orderingSettings-get", "x-filename-id":"console-admin-api-v1.1-channels-channelname-orderingsettings-get" }, "patch":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Update Orderer Advanced Attributes for a Channel", "description":"Update orderer advanced attributes for a channel.", "operationId":"updateOrderingSettings", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"orderingSettings", "in":"body", "description":"New orderer attributes to be updated for this channel. Note that 'batchTimeout' should be specified with a string, such as '2s'.", "required":true, "schema":{ "type":"object", "properties":{ "absoluteMessageBytes":{ "type":"number", "default":98, "example":98 }, "maxMessageCount":{ "type":"number", "default":10, "example":10 }, "preferredMessageBytes":{ "type":"number", "default":512, "example":512 }, "batchTimeout":{ "type":"string", "default":"2s", "example":"2s" } } } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-orderingSettings-patch", "x-filename-id":"console-admin-api-v1.1-channels-channelname-orderingsettings-patch" } }, "/console/admin/api/v1.1/channels/{channelName}/organizations":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Add an organization to a channel", "operationId":"updateChannel", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"postChannelBody", "in":"body", "description":"New organization configuration to be added. Only certificates exported from the v1.1 API can be used.", "required":true, "schema":{ "$ref":"#/definitions/postChannelNewOrg" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-organizations-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-organizations-post" } }, "/console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}":{ "delete":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Remove an organization from a channel", "operationId":"removeOrgInChannel", "parameters":[ { "name":"channelName", "in":"path", "description":"The specified channel name", "required":true, "type":"string" }, { "name":"mspId", "in":"path", "description":"The organization ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"set success", "schema":{ "type":"object", "example":{ "status":"Success" } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Error message for unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-organizations-{mspId}-delete", "x-filename-id":"console-admin-api-v1.1-channels-channelname-organizations-mspid-delete" } }, "/console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}/anchorPeers":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Channel" ], "summary":"Set Anchor Peers for a Channel", "description":"Each member on your network must designate an anchor peer. Anchor peers are primary network contact points and are used to discover additional peers in the network. You can designate one or more peers in your organization as an anchor peer on a channel. For a high availability network, you can specify two or more anchor peers. All members using the network channel must designate one or more of their peer nodes as anchor peers. ", "operationId":"setAnchorPeers", "produces":[ "application/json" ], "parameters":[ { "name":"channelName", "in":"path", "description":"Channel name", "required":true, "type":"string" }, { "name":"mspId", "in":"path", "description":"Organization id", "required":true, "type":"string" }, { "name":"anchorPeers", "in":"body", "description":"The host and port of the anchor peers", "required":true, "schema":{ "$ref":"#/definitions/setAnchorPeers" } } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "example":{ "status":"Success" } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-channels-{channelName}-organizations-{mspId}-anchorPeers-post", "x-filename-id":"console-admin-api-v1.1-channels-channelname-organizations-mspid-anchorpeers-post" } }, "/console/admin/api/v1.1/chaincodes":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Get Installed Chaincode List", "description":"Get a list of installed chaincodes, optionally filtering by whether they're instantiated on a given channel or installed on a given peer.", "operationId":"getInstalledChaincodes", "parameters":[ { "name":"channelName", "in":"query", "description":"Channel name where the chaincode is installed", "required":false, "type":"string" }, { "name":"peerId", "in":"query", "description":"ID of the peer where the chaincode is installed", "required":false, "type":"string" } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"List of installed chaincodes", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/chaincodeInfo" } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-get", "x-filename-id":"console-admin-api-v1.1-chaincodes-get" }, "post":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Install a Chaincode", "description":"Installs a chaincode on a specified peer. The chaincode must be BASE64 encoded zip file.", "operationId":"installChaincode", "parameters":[ { "name":"body", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/installChaincode" } } ], "responses":{ "200":{ "description":"Installed chaincode successfully", "schema":{ "$ref":"#/definitions/200successModels" } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-post", "x-filename-id":"console-admin-api-v1.1-chaincodes-post" } }, "/console/admin/api/v1.1/chaincodes/{chaincodeName}":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Get Chaincode Information", "description":"Returns the version and path of a specified chaincode name.", "operationId":"getChaincodesById", "produces":[ "application/json" ], "parameters":[ { "name":"chaincodeName", "in":"path", "description":"Chaincode name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Chaincode information", "schema":{ "type":"object", "properties":{ "name":{ "type":"string" }, "version":{ "type":"array", "items":{ "type":"string" } }, "path":{ "type":"string" } } } }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "404":{ "description":"Resource not found" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-{chaincodeName}-get", "x-filename-id":"console-admin-api-v1.1-chaincodes-chaincodename-get" } }, "/console/admin/api/v1.1/chaincodes/{chaincodeName}/instantiate":{ "post":{ "tags":[ "Blockchain Network Administrative Operations/Chaincode" ], "summary":"Instantiate a Chaincode", "description":"Instantiates a chaincode on a channel.", "operationId":"instantiateChaincode", "parameters":[ { "name":"chaincodeName", "in":"path", "description":"Name of the chaincode to instantiate.", "required":true, "type":"string" }, { "name":"chaincodeInstantiatedOnChannelBody", "in":"body", "description":"Information about where and how to instantiate the chaincode.", "required":true, "schema":{ "$ref":"#/definitions/instantiateChaincode" } } ], "responses":{ "200":{ "description":"Instantiated chaincode successfully", "schema":{ "$ref":"#/definitions/200successModels" } }, "202":{ "description":"In Progress" }, "400":{ "description":"Invalid argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-chaincodes-{chaincodeName}-instantiate-post", "x-filename-id":"console-admin-api-v1.1-chaincodes-chaincodename-instantiate-post" } }, "/console/admin/api/v1.1/organizations":{ "get":{ "tags":[ "Blockchain Network Administrative Operations/Organizations" ], "summary":"Get All Organizations", "description":"Use this endpoint to return the names of all organizations in a network. This is only available on the founder.", "operationId":"getAllOrgs", "responses":{ "200":{ "description":"Lists all organizations, including founder and participants", "schema":{ "type":"object", "example":{ "founder":"", "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-v1.1-organizations-get", "x-filename-id":"console-admin-api-v1.1-organizations-get" } }, "/console/admin/api/v1.1/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 certificate", "schema":{ "type":"object", "example":{ "mspId":"", "certs":{ "adminCert":"", "CACert":"", "tlsCACert":"" } } } }, "400":{ "description":"Invalid argument", "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-v1.1-organizations-{orgName}-certificates-get", "x-filename-id":"console-admin-api-v1.1-organizations-orgname-certificates-get" } }, "/console/admin/api/v1.1/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 argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-organizations-{orgName}-adminCredentials-get", "x-filename-id":"console-admin-api-v1.1-organizations-orgname-admincredentials-get" } }, "/console/admin/api/v1.1/console/admin/api/v1.1/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-v1.1-console-admin-api-v1.1-organizations-{orgName}-connectionProfile-{zip}-get", "x-filename-id":"console-admin-api-v1.1-console-admin-api-v1.1-organizations-orgname-connectionprofile-zip-get" } }, "/console/admin/api/v1.1/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 argument", "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-v1.1-organizations-{orgName}-joinNewOrgs-post", "x-filename-id":"console-admin-api-v1.1-organizations-orgname-joinneworgs-post" } }, "/console/admin/api/v1.1/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 argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-organizations-{orgName}-orderingService-get", "x-filename-id":"console-admin-api-v1.1-organizations-orgname-orderingservice-get" } }, "/console/admin/api/v1.1/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 argument", "schema":{ "$ref":"#/definitions/400errorModels" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/500errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-organizations-{orgName}-setOrderingService-post", "x-filename-id":"console-admin-api-v1.1-organizations-orgname-setorderingservice-post" } }, "/console/admin/api/v1.1/dashboard/statistics/nodeRes":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Node Usage Related Metrics", "description":"Get the node usage related metrics (CPU, memory, disk usage).", "operationId":"getStatsNodeResUsage", "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" }, { "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 usage records by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsNodeRes" } } } } }, "400":{ "description":"invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-dashboard-statistics-nodeRes-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-noderes-get" } }, "/console/admin/api/v1.1/dashboard/statistics/nodeHealth":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Node Health Status", "description":"Get the node health status (up or down).", "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-v1.1-dashboard-statistics-nodeHealth-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-nodehealth-get" } }, "/console/admin/api/v1.1/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-v1.1-dashboard-statistics-channelInfo-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-channelinfo-get" } }, "/console/admin/api/v1.1/dashboard/statistics/channelsJoined":{ "get":{ "tags":[ "Statistics" ], "summary":"Get Current Number and List of Channels Joined by the Specified Peer", "description":"Get the current number and list of channels joined by the specified peer.", "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-v1.1-dashboard-statistics-channelsJoined-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-channelsjoined-get" } }, "/console/admin/api/v1.1/dashboard/statistics/chaincodeInstalled":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Current Number and List of Installed Chaincodes on the Specified Peer", "description":"Get the current number and list of installed chaincodes on the specified peer.", "operationId":"getStatsChaincodeInstalled", "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 chaincode names for each peer by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChaincodeInstalled" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-dashboard-statistics-chaincodeInstalled-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-chaincodeinstalled-get" } }, "/console/admin/api/v1.1/dashboard/statistics/chaincodeInstantiated":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Current Number of Instantiated Chaincodes on the Specified Channel", "description":"Get the current number of instantiated chaincodes on the specified channel.", "operationId":"getStatsChaincodeInstantiated", "produces":[ "application/json" ], "parameters":[ { "name":"channel", "in":"query", "description":"Channel Name", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with the total number and a list of chaincode names for each channel by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChaincodeInstantiated" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-dashboard-statistics-chaincodeInstantiated-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-chaincodeinstantiated-get" } }, "/console/admin/api/v1.1/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 peer or channel or the entire network.", "operationId":"getStatsUserTrans", "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":"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", "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-v1.1-dashboard-statistics-userTrans-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-usertrans-get" } }, "/console/admin/api/v1.1/dashboard/statistics/billableTrans":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Billable Transactions", "description":"Get the number of billable transactions.", "operationId":"getStatsBillableTrans", "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 billable transactions by restriction", "schema":{ "type":"object", "properties":{ "data":{ "$ref":"#/definitions/StatsBillableTrans" } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-dashboard-statistics-billableTrans-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-billabletrans-get" } }, "/console/admin/api/v1.1/dashboard/statistics/endorsements":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Endorsements", "description":"Get the number of endorsements.", "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-v1.1-dashboard-statistics-endorsements-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-endorsements-get" } }, "/console/admin/api/v1.1/dashboard/statistics/commits":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Commits", "description":"Get the number of commits.", "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-v1.1-dashboard-statistics-commits-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-commits-get" } }, "/console/admin/api/v1.1/dashboard/statistics/blocks":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Blocks", "description":"Get the number of blocks.", "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-v1.1-dashboard-statistics-blocks-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-blocks-get" } }, "/console/admin/api/v1.1/dashboard/statistics/proxySyncInvocation":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Synchronous Invocations", "description":"Get the total number of synchronous invocations.", "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-v1.1-dashboard-statistics-proxySyncInvocation-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-proxysyncinvocation-get" } }, "/console/admin/api/v1.1/dashboard/statistics/proxyAsyncInvocation":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the Number of Asynchronous Invocations", "description":"Get the total number of asynchronous invocations.", "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-v1.1-dashboard-statistics-proxyAsyncInvocation-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-proxyasyncinvocation-get" } }, "/console/admin/api/v1.1/dashboard/statistics/proxyConfiguredCC":{ "get":{ "tags":[ "Statistics" ], "summary":"Get the List of Configured Chaincodes", "description":"Get the list of configured chaincodes for a specified proxy or for all proxies.", "operationId":"getStatsProxyConfiguredCC", "produces":[ "application/json" ], "parameters":[ { "name":"nodeID", "in":"query", "description":"Node ID of a specific proxy", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Response with the configured chaincode by restriction", "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/StatsProxyConfiguredCC" } } } } }, "400":{ "description":"Invalid arguments", "schema":{ "$ref":"#/definitions/400errorModels" } }, "default":{ "description":"Unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-dashboard-statistics-proxyConfiguredCC-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-proxyconfiguredcc-get" } }, "/console/admin/api/v1.1/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":"getNodeMetrics", "produces":[ "application/json" ], "parameters":[ { "name":"nodeId", "in":"query", "description":"Node ID of a peer or orderer", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Operational metrics exported for consumption by Prometheus." }, "400":{ "description":"The specified nodeId is invalid.", "schema":{ "type":"object", "properties":{ "respMesg":{ "type":"string", "description":"The response message." } }, "example":{ "respMesg":"invalid nodeId:peer100" } } }, "default":{ "description":"unexpected error", "schema":{ "$ref":"#/definitions/errorModel" } } }, "x-internal-id":"console-admin-api-v1.1-dashboard-statistics-metrics-get", "x-filename-id":"console-admin-api-v1.1-dashboard-statistics-metrics-get" } } }, "definitions":{ "AnyValue":{ }, "encode":{ "type":"string", "enum":[ "UTF-8", "JSON", "base64" ] }, "returnCode":{ "type":"string", "enum":[ "Success", "Failure" ] }, "EventSubscription":{ "type":"object", "required":[ "type", "callbackURL", "callbackTLSCerts" ], "properties":{ "role":{ "description":"Name of Fabric enrollment to be used", "type":"string" }, "type":{ "description":"Event type to subscribe to", "type":"string", "enum":[ "block", "filteredblock", "transaction", "chaincode" ] }, "callbackURL":{ "description":"Callback URL", "type":"string" }, "callbackTLSCerts":{ "type":"object", "properties":{ "caCert":{ "type":"string" }, "clientCert":{ "type":"string" }, "keyPassword":{ "type":"string" } } }, "expires":{ "description":"Expiration of the subscription", "type":"string" }, "txid":{ "description":"ID of the transaction", "type":"string" }, "chaincode":{ "description":"Name of the chaincode", "type":"string" }, "event":{ "description":"Name of the event", "type":"string" }, "seek":{ "description":"Start position of the event. Only used for type \"block\" and \"filteredblock\"", "type":"string", "enum":[ "oldest", "newest", "from" ] }, "block":{ "description":"Number of the block", "type":"integer", "format":"int64" } } }, "UnEventSubscription":{ "type":"object", "required":[ "subid" ], "properties":{ "subid":{ "description":"ID of the subscription when operation succeeds", "type":"string" }, "status":{ "type":"string" }, "errorMessage":{ "type":"string" } } }, "BlockchainPlatformCreationDetails":{ "type":"object", "required":[ "name", "platformRole", "configuration", "cluster", "additionalConfiguration" ], "properties":{ "name":{ "type":"string", "description":"instance name" }, "desc":{ "type":"string", "description":"description" }, "platformRole":{ "type":"string", "description":"instance role", "enum":[ "founder", "participant" ] }, "configuration":{ "type":"string", "enum":[ "Developer", "Enterprise" ], "description":"compute configuration", "default":"Developer" }, "peer":{ "type":"integer", "description":"peer number", "minimum":1, "maximum":14 }, "onFailure":{ "type":"string", "enum":[ "Rollback", "Retain" ], "description":"On instance creation failure, the instance will be either deleted or retained" }, "cluster":{ "$ref":"#/definitions/ClusterCreationDetails" }, "additionalConfiguration":{ "$ref":"#/definitions/AdditionalCreationDetails" } } }, "ClusterCreationDetails":{ "type":"object", "description":"VM to construct cluster", "properties":{ "platformHosts":{ "type":"array", "description":"Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager", "items":{ "type":"string" } }, "crcHosts":{ "type":"array", "description":"CRC VM list, not in swarm", "items":{ "type":"string" } }, "zkHosts":{ "type":"array", "description":"Kafka/ZooKeeper Service VM list, in swarm", "items":{ "type":"string" } } } }, "AdditionalCreationDetails":{ "type":"object", "description":"external server/path list", "properties":{ "instanceFQDN":{ "type":"string", "description":"FQDN value for the instance to be provided only when external load balancer is used. When this value is not provided the instance name is mapped to the internal load balancer that is used." }, "startPort":{ "type":"integer", "description":"External load balancer start port", "minimum":0, "maximum":65535 }, "enableTLS":{ "type":"boolean", "description":"Determines whether to enable or disable TLS with the default load balancer." } } }, "Error":{ "description":"Error Information.", "required":[ "status", "message" ], "properties":{ "status":{ "description":"A short error status that defines the error, meant for programmatic parsing.", "type":"string" }, "message":{ "description":"A human-readable error string.", "type":"string" }, "errors":{ "type":"array", "description":"list of errors", "items":{ "type":"string" } }, "warnings":{ "type":"array", "description":"list of warnings", "items":{ "type":"string" } } } }, "BlockchainPlatformSummaryWrapper":{ "description":"Blockchain Platform Summary List Wrapper", "type":"object", "properties":{ "instances":{ "description":"List of Blockchain Platform instances", "type":"array", "items":{ "$ref":"#/definitions/BlockchainPlatformSummary" } }, "summary":{ "$ref":"#/definitions/InstancesCountSummary" } } }, "InstancesCountSummary":{ "description":"Blockchain Platform Summary", "type":"object", "properties":{ "instancesCount":{ "description":"Total number of instances", "type":"integer" }, "founderCount":{ "description":"Total number of founder instances", "type":"integer" }, "participantCount":{ "description":"Total number of participant instances", "type":"integer" }, "enterpriseCount":{ "description":"Total number of enterprise instances", "type":"integer" }, "developerCount":{ "description":"Total number of developer instances", "type":"integer" } } }, "BlockchainPlatformSummary":{ "description":"Blockchain Platform Summary", "type":"object", "required":[ "id" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Instance display name, can be renamed", "type":"string" }, "timeCreated":{ "description":"The time the the instance was created. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the instance was updated. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The user who created the instance", "type":"string" }, "createOperationId":{ "description":"The operation id of the create operation that created the instance", "type":"string" }, "platformRole":{ "description":"Role of platform: Founder or Participant", "type":"string", "enum":[ "Founder", "Participant" ] }, "configuration":{ "description":"Type of compute configuration: Developer or Enterprise", "type":"string", "enum":[ "Developer", "Enterprise" ] }, "status":{ "type":"string", "description":"Instance status", "enum":[ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ] }, "statusDisplayName":{ "type":"string", "description":"instance status display name", "enum":[ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ] }, "lifecycleState":{ "description":"The current operation state of the instance", "enum":[ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ], "type":"string" }, "version":{ "description":"Instance version", "type":"string" }, "enableTLS":{ "type":"boolean", "description":"Determines whether to enable or disable TLS with the default load balancer." }, "startPort":{ "description":"External load balancer start port", "type":"integer" }, "instanceFQDN":{ "description":"Instance FQDN indicating external load balancer is used", "type":"string" } } }, "Tags":{ "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExample: `{\"bar-key\": \"value\"}`\n", "type":"array", "items":{ "type":"string", "description":"format key:value" } }, "BlockchainPlatformDetails":{ "description":"Blockchain Platform details", "type":"object", "properties":{ "id":{ "description":"Unique identifier that is immutable on creation", "type":"string" }, "displayName":{ "description":"Instance display name, can be renamed", "type":"string" }, "timeCreated":{ "description":"The time the the instance was created. A timestamp string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Instance was updated. A timestamp string.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The user who created the instance", "type":"string" }, "createOperationId":{ "description":"The operation ID of the create operation that created the instance", "type":"string" }, "platformRole":{ "description":"Role of platform: Founder or Participant", "type":"string", "enum":[ "Founder", "Participant" ] }, "configuration":{ "description":"Type of compute configuration: Developer or Enterprise", "type":"string", "enum":[ "Developer", "Enterprise" ] }, "version":{ "description":"Instance Version", "type":"string" }, "enableTLS":{ "type":"boolean", "description":"Determines whether to enable or disable TLS with the default load balancer." }, "startPort":{ "description":"External load balancer start port", "type":"integer" }, "instanceFQDN":{ "description":"Instance FQDN indicating external load balancer is used", "type":"string" }, "logging":{ "type":"string", "description":"Logging path on VM" }, "lastOpid":{ "type":"string", "description":"Last operation ID on the instance" }, "serviceEndpoint":{ "description":"Service endpoint URL, valid post-provisioning", "type":"string" }, "lifecycleState":{ "description":"The current operation state of the instance", "enum":[ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ], "type":"string" }, "stateMessage":{ "description":"An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.", "type":"string" }, "status":{ "type":"string", "description":"Instance status", "enum":[ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ] }, "statusDisplayName":{ "type":"string", "description":"instance status display name", "enum":[ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ] }, "cluster":{ "$ref":"#/definitions/BlockchainPlatformCluster" }, "components":{ "type":"array", "description":"All nodes(services) info", "items":{ "$ref":"#/definitions/BlockchainPlatformComponent" } }, "ledgerPlacement":{ "type":"array", "description":"List of (host - ledger location) pairs", "items":{ "$ref":"#/definitions/HostLedgerInfo" } } } }, "BlockchainPlatformCluster":{ "type":"object", "description":"VMs in cluster", "properties":{ "manager":{ "type":"array", "description":"Manager VM list", "items":{ "$ref":"#/definitions/ClusterVM" } }, "crc":{ "type":"array", "description":"CRC VM list", "items":{ "$ref":"#/definitions/ClusterVM" } }, "zk":{ "type":"array", "description":"ZooKeeper or Kafka VM list", "items":{ "$ref":"#/definitions/ClusterVM" } } } }, "ClusterVM":{ "type":"object", "properties":{ "vm":{ "type":"string", "description":"VM host name or IP" }, "vmStatus":{ "type":"string", "enum":[ "up", "down" ], "description":"VM status: up or down" }, "role":{ "type":"string", "description":"VM role in swarm cluster", "enum":[ "admin", "worker" ] } } }, "BlockchainPlatformComponent":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Node(service) name" }, "type":{ "type":"string", "enum":[ "ca", "console", "peer", "orderer", "proxy", "zookeeper", "kafka", "ldap", "prometheus", "lbr", "nodemanager", "authserver", "restproxy" ], "description":"Node(service) type" }, "status":{ "type":"string", "description":"Node(service) status: healthy for all replicas up, unhealthy for any replicas down, down for all replicas down", "enum":[ "healthy", "unhealthy", "down" ] }, "replicas":{ "type":"integer", "description":"Node(service) replicas number" }, "host":{ "type":"array", "description":"All node(service) replicas hosts, may be smaller than the replicas number when any replica is down", "items":{ "type":"string", "description":"VM host name or IP" } } } }, "HostLedgerInfo":{ "type":"object", "properties":{ "host":{ "type":"string", "description":"Host name" }, "sharedDirectory":{ "type":"string", "description":"ledger folder path on the host" } }, "additionalProperties":{ "type":"string", "description":"other dynamically generated orderer and peer name keys and ledger folder path" } }, "OperationStatus":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Instance ID" }, "operationId":{ "type":"string", "description":"Operation ID" }, "operation":{ "type":"string", "description":"Operation querying", "enum":[ "create", "delete", "start", "stop", "update", "patch", "scaleout", "scalein" ] }, "status":{ "type":"string", "enum":[ "norecord", "inprogress", "failed", "successful", "successfulwitherrors", "unknown" ], "description":"For delete, 404 will be returned after it succeeds." }, "details":{ "type":"string", "description":"e.g. step info, fail reason" } } }, "ScaleOutReplicaNumberDetails":{ "type":"object", "description":"One node(service) number to be added", "properties":{ "proxy":{ "type":"integer", "description":"REST proxy replicas number to add" }, "CA":{ "type":"integer", "description":"CA replicas number to add" } } }, "ScaleOutPeerDetails":{ "type":"object", "description":"One peer details to be added", "properties":{ "org":{ "type":"string", "description":"Organization name" }, "role":{ "type":"string", "description":"Peer role", "enum":[ "Member", "Admin" ] }, "logLevel":{ "type":"string", "description":"Peer log level", "enum":[ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ] }, "alias":{ "type":"string", "description":"Peer alias" }, "vm":{ "type":"string", "description":"VM hostname to locate peer" } } }, "ScaleOutPayload":{ "type":"object", "description":"scaleOut payload", "properties":{ "newVMs":{ "$ref":"#/definitions/ClusterCreationDetails" }, "newReplicas":{ "$ref":"#/definitions/ScaleOutReplicaNumberDetails" }, "newPeers":{ "type":"array", "description":"New peers list", "items":{ "$ref":"#/definitions/ScaleOutPeerDetails" } } } }, "ScaleInNodes":{ "type":"object", "description":"ScaleIn node details", "properties":{ "peer":{ "type":"array", "description":"Peer hostnames", "items":{ "type":"string" } } } }, "ScaleInPayload":{ "type":"object", "description":"scaleIn payload", "properties":{ "nodes":{ "$ref":"#/definitions/ScaleInNodes" } } }, "UpdatePayload":{ "type":"object", "description":"Update a Blockchain Platform instance", "properties":{ "updateLDAPConfig":{ "type":"boolean", "description":"Determines whether the instance should be updated with the active LDAP configuration." } } }, "InstancePatchPayload":{ "type":"object", "properties":{ "patchId":{ "type":"string", "description":"Patch ID to apply" } } }, "PatchInfoSummary":{ "type":"object", "properties":{ "patchId":{ "type":"string", "description":"Patch ID" }, "displayName":{ "type":"string", "description":"Patch display name" }, "description":{ "type":"string", "description":"Patch description or details" }, "serviceVersion":{ "type":"string", "description":"Patch service version" }, "release":{ "type":"string", "description":"Patch release version" }, "fullVersion":{ "type":"string", "description":"Patch full version" }, "prevVersion":{ "type":"string", "description":"Previous version" }, "rollbackable":{ "type":"boolean", "description":"Is patch able to be rolled back" }, "applicable":{ "type":"boolean", "description":"Is patch able to be applied" }, "status":{ "type":"string", "description":"Patch/rollback status" } } }, "InstancePatchInfoSummary":{ "type":"object", "properties":{ "available":{ "type":"array", "items":{ "$ref":"#/definitions/PatchInfoSummary" } }, "applied":{ "type":"array", "items":{ "$ref":"#/definitions/PatchInfoSummary" } } } }, "PatchTargetInfo":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Target instance ID" }, "instanceName":{ "type":"string", "description":"Target instance display name" }, "version":{ "type":"string", "description":"Target instance version" }, "status":{ "type":"string", "description":"Target instance status" }, "timeCreated":{ "type":"string", "description":"Target instance creation date" } } }, "PatchApplyPayload":{ "type":"array", "description":"List of patch target instance IDs", "items":{ "type":"string" } }, "PatchApplyStatus":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Patch applied instance ID" }, "instanceName":{ "type":"string", "description":"Patch applied instance display name" }, "status":{ "type":"string", "description":"Patch application request status", "enum":[ "Success", "Failure" ] }, "statusURL":{ "type":"string", "description":"Patch request status URL" } } }, "PatchApplySummary":{ "type":"object", "properties":{ "patchId":{ "type":"string", "description":"Patch ID that was applied" }, "applyStatus":{ "type":"array", "description":"Patch application request status for all targets", "items":{ "$ref":"#/definitions/PatchApplyStatus" } } } }, "LBRPortMappingWrapper":{ "description":"External load balancer port mapping list wrapper", "type":"object", "properties":{ "portMapping":{ "description":"List of external load balancer Port mapping", "type":"array", "items":{ "$ref":"#/definitions/LBRPortMapping" } } } }, "LBRPortMapping":{ "description":"External load balancer port mapping", "type":"object", "properties":{ "serviceName":{ "description":"Service name", "type":"string" }, "externalPort":{ "description":"External port number", "type":"integer" }, "externalHost":{ "description":"External host", "type":"string" }, "internalPort":{ "description":"Internal port number", "type":"integer" }, "internalHost":{ "description":"Internal host", "type":"string" } } }, "ReleaseBuildInfo":{ "description":"Release Build Information", "type":"object", "properties":{ "version":{ "type":"string" }, "build.date":{ "type":"string" } } }, "LdapConfigPayload":{ "description":"LDAP Configuration details", "type":"object", "properties":{ "ldapId":{ "type":"string" }, "ldapName":{ "type":"string" }, "ldapType":{ "type":"string" }, "ldapHost":{ "type":"string" }, "ldapPort":{ "type":"integer" }, "ldapTLSEnabled":{ "type":"boolean" }, "ldapBaseDN":{ "type":"string" }, "ldapBindDN":{ "type":"string" }, "ldapBindPassword":{ "type":"string" }, "userNameAttribute":{ "type":"string" }, "userClassName":{ "type":"string" }, "groupNameAttribute":{ "type":"string" }, "groupMembershipAttribute":{ "type":"string" }, "groupClassName":{ "type":"string" }, "connectTimeout":{ "type":"integer" } } }, "LdapConfigDetail":{ "description":"LDAP Configuration details", "type":"object", "properties":{ "ldapId":{ "type":"string" }, "ldapName":{ "type":"string" }, "ldapType":{ "type":"string" }, "ldapHost":{ "type":"string" }, "ldapPort":{ "type":"integer" }, "ldapTLSEnabled":{ "type":"boolean" }, "ldapTLSCACert":{ "type":"string" }, "ldapBaseDN":{ "type":"string" }, "ldapBindDN":{ "type":"string" }, "ldapBindPassword":{ "type":"string" }, "userNameAttribute":{ "type":"string" }, "userClassName":{ "type":"string" }, "groupNameAttribute":{ "type":"string" }, "groupMembershipAttribute":{ "type":"string" }, "groupClassName":{ "type":"string" }, "connectTimeout":{ "type":"integer" }, "tlsRootCACertFileName":{ "type":"string" } } }, "CpConfigDetail":{ "description":"Control plane configuration details", "type":"object", "properties":{ "cpConfigName":{ "type":"string" }, "cpConfigValue":{ "type":"string" } } }, "CpConfigMap":{ "description":"Control plane configuration map", "type":"object", "properties":{ "controlPlaneId":{ "type":"string", "description":"Blockchain Platform Manager ID" }, "activeLdapId":{ "type":"string", "description":"Active LDAP configuration ID" }, "additionalProperties":{ "type":"string", "description":"Other Control Plane Config name and value pairs" } } }, "BlockchainPlatformInstanceStatus":{ "description":"Blockchain Platform instance status", "type":"object", "properties":{ "instanceId":{ "type":"string" }, "status":{ "type":"string" }, "details":{ "type":"string" } } }, "PostLoginAuthConfig":{ "description":"Post-login authorization configuration map", "type":"object", "properties":{ "ldapConfigReminderPopup":{ "type":"boolean" }, "defaultUserDisabled":{ "type":"boolean" } } }, "BasicAuth":{ "description":"Basic authentication", "type":"object", "properties":{ "userName":{ "type":"string" }, "userPassword":{ "type":"string" } } }, "PatchStatusResponse":{ "type":"object", "required":[ "status" ], "properties":{ "status":{ "type":"string", "enum":[ "idle", "patching", "done" ] }, "message":{ "type":"string" } } }, "InstanceActivityInfoSummary":{ "description":"Activities for a Blockchain Platform Instance", "type":"object", "properties":{ "activities":{ "description":"List activities associated with a blockchain platform instance", "type":"array", "items":{ "$ref":"#/definitions/ActivityInfoSummary" } } } }, "ActivityInfoSummary":{ "type":"object", "properties":{ "instanceId":{ "type":"string", "description":"Platform instance ID" }, "instanceName":{ "type":"string", "description":"Name of the platform instance" }, "operation":{ "type":"string", "description":"Operation name" }, "operationId":{ "type":"string", "description":"Operation ID" }, "operationStatus":{ "type":"string", "description":"Operation status" }, "operationStartTime":{ "type":"string", "format":"date-time", "description":"Time when the operation started" }, "lastUpdatedTime":{ "type":"string", "format":"date-time", "description":"Most recent time when the operation status was tracked" }, "initiatedBy":{ "type":"string", "description":"User who initiated the activity" }, "details":{ "type":"string", "description":"Detailed message from the latest status of the operation" } } }, "LogLevelPayload":{ "type":"object", "description":"Updates the Blockchain Platform Manager log level", "required":[ "level" ], "properties":{ "level":{ "type":"string", "enum":[ "INFO", "DEBUG", "TRACE" ] } } }, "logLevel":{ "type":"string", "enum":[ "CRITICAL", "ERROR", "WARNING", "NOTICE", "INFO", "DEBUG" ] }, "nodes":{ "type":"object", "properties":{ "peers":{ "type":"array", "items":{ "$ref":"#/definitions/peer" } }, "orderers":{ "type":"array", "items":{ "$ref":"#/definitions/orderer" } }, "fabricCAs":{ "type":"array", "items":{ "$ref":"#/definitions/FabricCA" } }, "RESTProxies":{ "type":"array", "items":{ "$ref":"#/definitions/RESTProxy" } } } }, "peer":{ "type":"object", "required":[ "peerId" ], "properties":{ "peerId":{ "type":"string" }, "mspId":{ "type":"string" }, "role":{ "type":"string", "enum":[ "Member", "Admin" ] }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "eventUrl":{ "type":"string" }, "displayName":{ "type":"string" } } }, "peer2":{ "type":"object", "required":[ "peerId" ], "properties":{ "peerId":{ "type":"string" }, "mspId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "eventUrl":{ "type":"string" }, "displayName":{ "type":"string" } } }, "orderer":{ "type":"object", "properties":{ "ordererId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "adminUrl":{ "type":"string" }, "mspId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "FabricCA":{ "type":"object", "properties":{ "fabricCAId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "up", "down" ] }, "url":{ "type":"string" }, "mspId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "RESTProxy":{ "type":"object", "properties":{ "RESTProxyId":{ "type":"string" }, "status":{ "type":"string" }, "url":{ "type":"string" }, "mspId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "NodeStatus":{ "type":"object", "properties":{ "status":{ "type":"string", "enum":[ "up", "down" ] } } }, "ActionStatus":{ "type":"string", "enum":[ "Success" ] }, "peerPatchActionResult":{ "type":"object", "properties":{ "status":{ "type":"string", "enum":[ "Success" ] }, "message":{ "type":"string" } } }, "gossip":{ "type":"object", "properties":{ "bootstrapPeers":{ "type":"string" }, "maxBlockCountToStore":{ "type":"integer", "default":100, "example":100 }, "maxPropagationBurstLatency":{ "type":"integer", "default":10, "example":10 }, "maxPropagationBurstSize":{ "type":"integer", "default":10, "example":10 }, "propagateIterations":{ "type":"integer", "default":1, "example":1 }, "propagatePeerNumber":{ "type":"integer", "default":3, "example":3 }, "pullInterval":{ "type":"integer", "default":4, "example":4 }, "pullPeerNumber":{ "type":"integer", "default":3, "example":3 }, "requestStateInfoInterval":{ "type":"integer", "default":4, "example":4 }, "publishStateInfo":{ "type":"integer", "default":4, "example":4 }, "publicCertPeriod":{ "type":"integer", "default":10, "example":10 }, "dialTimeout":{ "type":"integer", "default":3, "example":3 }, "connectTimeout":{ "type":"integer", "default":2, "example":2 }, "receiveBufferSize":{ "type":"integer", "default":20, "example":20 }, "sendBufferSize":{ "type":"integer", "default":200, "example":200 }, "digestWaitTime":{ "type":"integer", "default":1, "example":1 }, "requestWaitTime":{ "type":"integer", "default":1500, "example":1500 }, "responseWaitTime":{ "type":"integer", "default":2, "example":2 }, "aliveTimeInterval":{ "type":"integer", "default":5, "example":5 }, "aliveExpirationTimeout":{ "type":"integer", "default":25, "example":25 }, "reconnectInterval":{ "type":"integer", "default":25, "example":25 }, "skipBlockVerification":{ "type":"boolean", "default":false, "example":false } } }, "peerAttributes":{ "type":"object", "properties":{ "peerId":{ "type":"string" }, "mspId":{ "type":"string" }, "alias":{ "type":"string" }, "role":{ "type":"string", "enum":[ "Member", "Admin" ] }, "url":{ "type":"string" }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "gossip":{ "$ref":"#/definitions/gossip" }, "gossipElection":{ "type":"object", "properties":{ "membershipSampleInterval":{ "type":"integer", "default":1, "example":1 }, "leaderALiveThreshold":{ "type":"integer", "default":10, "example":10 }, "leaderElectionDuration":{ "type":"integer", "default":5, "example":5 }, "leader":{ "type":"string", "enum":[ "UseLeaderElection", "OrgLeader" ] } } }, "eventService":{ "type":"object", "properties":{ "url":{ "type":"string" }, "bufferSize":{ "type":"integer", "default":100, "example":100 }, "timeout":{ "type":"integer", "default":10, "example":10 } } }, "chaincode":{ "type":"object", "properties":{ "startupTimeout":{ "type":"integer", "default":300, "example":300 }, "executeTimeout":{ "type":"integer", "default":30, "example":30 }, "mode":{ "type":"string", "enum":[ "dev", "net" ] }, "keepalive":{ "type":"integer", "default":0, "example":0 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "shimLevel":{ "$ref":"#/definitions/logLevel" } } } } }, "peerAddAttributes":{ "type":"object", "properties":{ "alias":{ "type":"string" }, "role":{ "type":"string", "enum":[ "Member", "Admin" ] }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "partition":{ "type":"string", "enum":[ "Partition 1", "Partition 2" ] }, "gossip":{ "$ref":"#/definitions/gossip" }, "gossipElection":{ "type":"object", "properties":{ "membershipSampleInterval":{ "type":"integer", "default":1, "example":1 }, "leaderALiveThreshold":{ "type":"integer", "default":10, "example":10 }, "leaderElectionDuration":{ "type":"integer", "default":5, "example":5 }, "userLeaderElection":{ "type":"boolean" }, "leader":{ "type":"string", "enum":[ "UseLeaderElection", "OrgLeader" ] } } }, "eventService":{ "type":"object", "properties":{ "bufferSize":{ "type":"integer", "default":100, "example":100 }, "timeout":{ "type":"integer", "default":10, "example":10 } } }, "chaincode":{ "type":"object", "properties":{ "startupTimeout":{ "type":"integer", "default":300, "example":300 }, "executeTimeout":{ "type":"integer", "default":30, "example":30 }, "mode":{ "type":"string", "enum":[ "dev", "net" ] }, "keepalive":{ "type":"integer", "default":0, "example":0 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "shimLevel":{ "$ref":"#/definitions/logLevel" } } } } }, "peerPatchAttributes":{ "type":"object", "properties":{ "alias":{ "type":"string" }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "gossip":{ "$ref":"#/definitions/gossip" }, "gossipElection":{ "type":"object", "properties":{ "membershipSampleInterval":{ "type":"integer", "default":1, "example":1 }, "leaderALiveThreshold":{ "type":"integer", "default":10, "example":10 }, "leaderElectionDuration":{ "type":"integer", "default":5, "example":5 }, "leader":{ "type":"string", "enum":[ "UseLeaderElection", "OrgLeader" ] } } }, "eventService":{ "type":"object", "properties":{ "bufferSize":{ "type":"integer", "default":100, "example":100 }, "timeout":{ "type":"integer", "default":10, "example":10 } } }, "chaincode":{ "type":"object", "properties":{ "startupTimeout":{ "type":"integer", "default":300, "example":300 }, "executeTimeout":{ "type":"integer", "default":30, "example":30 }, "mode":{ "type":"string", "enum":[ "dev", "net" ] }, "keepalive":{ "type":"integer" }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "shimLevel":{ "$ref":"#/definitions/logLevel" } } } } }, "addPeerActionResult":{ "type":"object", "properties":{ "status":{ "type":"string" } } }, "joinChannel":{ "type":"object", "properties":{ "channelName":{ "type":"string" } }, "example":{ "channelName":"mychannel1" } }, "exportedNodes":{ "type":"array", "items":{ "type":"object", "properties":{ "organization":{ "type":"string" }, "nodes":{ "type":"object", "properties":{ "peers":{ "type":"array", "items":{ "type":"object", "properties":{ "peerId":{ "type":"string" }, "displayName":{ "type":"string" }, "url":{ "type":"string" }, "eventUrl":{ "type":"string" }, "mspId":{ "type":"string" }, "joinedChannels":{ "type":"array", "items":{ "type":"string" } }, "installedChaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "version":{ "type":"string" }, "path":{ "type":"string" } } } } } } } } }, "tlsCACert":{ "type":"string" }, "signature":{ "type":"string" } } } }, "orgInfo":{ "type":"array", "items":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" } } }, "signature":{ "type":"string" } } }, "example":[ { "mspId":"Org6MSP", "certs":{ "adminCert":"", "CACert":"", "tlsCACert":"" }, "signature":"" } ] }, "ordererSettingInfo":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" } } }, "orderingServiceNodes":{ "type":"array", "items":{ "type":"object", "properties":{ "address":{ "type":"string" }, "adminAddress":{ "type":"string" } } } }, "signature":{ "type":"string" } } }, "getOrdererAttributes":{ "type":"object", "properties":{ "ordererId":{ "type":"string" }, "mspId":{ "type":"string" }, "url":{ "type":"string" }, "adminUrl":{ "type":"string" }, "batchTimeout":{ "type":"string", "default":"2s", "example":"2s" }, "batchSizeMaxMessageCount":{ "type":"integer", "default":10, "example":10 }, "batchSizeAbsMaxBytes":{ "type":"integer", "default":102760448, "example":102760448 }, "batchSizePrefMaxBytes":{ "type":"integer", "default":524288, "example":524288 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "Kafka/Retry":{ "$ref":"#/definitions/orderKafkaRetry" } } }, "setOrdererAttributes":{ "type":"object", "properties":{ "batchTimeout":{ "type":"string", "default":"2s", "example":"2s" }, "batchSizeMaxMessageCount":{ "type":"integer", "default":10, "example":10 }, "batchSizeAbsMaxBytes":{ "type":"integer", "default":102760448, "example":102760448 }, "batchSizePrefMaxBytes":{ "type":"integer", "default":524288, "example":524288 }, "logLevel":{ "$ref":"#/definitions/logLevel" }, "kafkaRetry":{ "$ref":"#/definitions/orderKafkaRetry" } } }, "orderKafkaRetry":{ "type":"object", "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 } } }, "fabricCAAttributes":{ "type":"object", "properties":{ "fabricCAId":{ "type":"string" }, "url":{ "type":"string" }, "maxEnrollments":{ "type":"integer", "default":-1, "example":-1 }, "logLevel":{ "type":"string", "enum":[ "INFO", "DEBUG" ] } } }, "fabricCAWritableAttributes":{ "type":"object", "properties":{ "maxEnrollments":{ "type":"integer", "default":-1, "example":-1 }, "logLevel":{ "type":"string", "enum":[ "DEBUG", "INFO" ] } } }, "restProxyConfig":{ "type":"object", "required":[ "RESTProxyId", "proposalWaitTime", "transactionWaitTime", "channels" ], "properties":{ "RESTProxyId":{ "type":"string" }, "proposalWaitTime":{ "type":"integer", "format":"int32", "example":60000, "default":60000 }, "transactionWaitTime":{ "type":"integer", "format":"int32", "example":300000, "default":300000 }, "logLevel":{ "type":"string", "enum":[ "INFO", "DEBUG", "WARNING", "ERROR" ] }, "channels":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"mychannel" }, "chaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "endorsers":{ "type":"array", "items":{ "type":"string" } } } }, "example":[ { "name":"mycc", "endorsers":[ "peer0.org1.example.com", "peer1.org1.example.com" ] } ] } } } } } }, "restProxyWritableConfig":{ "type":"object", "required":[ "proposalWaitTime", "transactionWaitTime", "channels" ], "properties":{ "proposalWaitTime":{ "type":"integer", "format":"int32", "example":60000, "default":60000 }, "transactionWaitTime":{ "type":"integer", "format":"int32", "example":300000, "default":300000 }, "logLevel":{ "type":"string", "enum":[ "ERROR", "WARNING", "INFO", "DEBUG" ] }, "channels":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"mychannel" }, "chaincodes":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "endorsers":{ "type":"array", "items":{ "type":"string" } } } }, "example":[ { "name":"mycc", "endorsers":[ "peer0.org1.example.com", "peer1.org1.example.com" ] } ] } } } } } }, "channels":{ "type":"array", "items":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "createor":{ "type":"string" }, "mspIds":{ "type":"array", "items":{ "type":"string" } } } } }, "createchannel":{ "type":"object", "properties":{ "channeName":{ "type":"string" }, "applicationCapabilitiesVersion":{ "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" } } }, "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", "applicationCapabilitiesVersion":"V1_1|V1_3(default)", "organizations":[ { "name":"Org1MSP", "mspId":"Org1MSP", "anchorPeers":[ "peer.org1.example.com:7051" ], "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example" }, "signature":"example" }, { "name":"Org2MSP", "mspId":"Org2MSP", "anchorPeers":[ "peer.org2.example.com:7051" ], "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"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 } } } }, "installChaincode":{ "type":"object", "properties":{ "source":{ "type":"object", "properties":{ "content":{ "type":"string" }, "fileName":{ "type":"string" } } }, "chaincodeId":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "peers":{ "type":"array", "items":{ "type":"object", "properties":{ "url":{ "type":"string" } } } } }, "example":{ "source":{ "fileName":"example_cc", "content":"example chaincode code (BASE64 encoded)" }, "chaincodeId":"exampleChaincodeId", "chaincodeVersion":"v1", "peers":[ { "url":"grpcs://peer0.org1.example.com:7051" } ] } }, "instantiateChaincode":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "chaincodeVersion":{ "type":"string" }, "args":{ "type":"array", "items":{ "type":"string" } }, "transientMap":{ "type":"object" }, "endorsementPolicy":{ "type":"object", "properties":{ "identities":{ "type":"array", "items":{ "type":"object", "properties":{ "role":{ "type":"object", "properties":{ "name":{ "type":"string", "enum":[ "member", "admin" ] }, "mspId":{ "type":"string" } } } } } }, "policy":{ "type":"object" } } }, "dataCollectionConfig":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "policy":{ "type":"string" }, "requiredPeerCount":{ "type":"number" }, "maxPeerCount":{ "type":"number" }, "blockToLive":{ "type":"number" } } } }, "upgrade":{ "type":"boolean" }, "chaincodeType":{ "type":"string", "enum":[ "golang", "node", "java" ] }, "peers":{ "type":"array", "items":{ "type":"object", "properties":{ "url":{ "type":"string" } } } } }, "example":{ "channelName":"mychannel1", "chaincodeVersion":"v1", "transientMap":{ }, "endorsementPolicy":{ "identities":[ ], "policy":{ "0-of":[ ] } }, "args":[ "a", "100", "b", "200" ], "dataCollectionConfig":{ "name":"", "policy":"", "requiredPeerCount":1, "maxPeerCount":2, "blockToLive":10 }, "chaincodeType":"golang", "peers":[ { "url":"grpcs://peer0.org1.example.com:7051" } ] } }, "blockData":{ "type":"object", "properties":{ "header":{ "type":"object" }, "data":{ "type":"object" } } }, "blockStatistic":{ "type":"object", "properties":{ "overview":{ "type":"object", "properties":{ "blocks":{ "type":"number" }, "blockSpeed":{ "type":"number" }, "transactionActivity":{ "type":"number" }, "deployment":{ "type":"number" }, "invokes":{ "type":"number" } } }, "activities":{ "type":"array", "items":{ "type":"object", "properties":{ "number":{ "type":"string" }, "deploy":{ "type":"string" }, "invoke":{ "type":"number" } } } }, "blocks":{ "type":"array", "items":{ "type":"object", "properties":{ "header":{ "type":"object" }, "data":{ "type":"object" } } } } } }, "postChannelNewOrg":{ "type":"object", "properties":{ "organization":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" } } }, "signature":{ "type":"string" } } }, "access":{ "type":"string" } }, "example":{ "organization":{ "mspId":"Org1MSP", "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example" }, "signature":"example" }, "access":"ReaderWriter|ReaderOnly" } }, "patchChannel":{ "type":"object", "properties":{ "organizations":{ "type":"array", "items":{ "type":"object", "properties":{ "mspId":{ "type":"string" }, "certs":{ "type":"object", "properties":{ "adminCert":{ "type":"string" }, "CACert":{ "type":"string" }, "tlsCACert":{ "type":"string" } } }, "signature":{ "type":"string" } } } }, "policies":{ "type":"object", "properties":{ "readers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } }, "writers":{ "type":"object", "properties":{ "mspIds":{ "type":"array", "items":{ "type":"string" } } } } } } }, "example":{ "organizations":[ { "name":"Org1MSP", "mspId":"Org1MSP", "certs":{ "adminCert":"example", "CACert":"example", "tlsCACert":"example" }, "signature":"example" } ], "policies":{ "readers":{ "mspids":[ "org1", "org2" ] }, "writers":{ "mspids":[ "org1", "org2" ] } } } }, "chaincodeInfo":{ "type":"object", "properties":{ "name":{ "type":"string" }, "paths":{ "type":"array", "items":{ "type":"string" } }, "versions":{ "type":"array", "items":{ "type":"string" } } } }, "setAnchorPeers":{ "type":"object", "properties":{ "anchorPeers":{ "type":"array", "items":{ "type":"string" } } }, "example":{ "anchorPeers":[ "org1peer0", "org1peer1" ] } }, "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" } } } }, "StatsChaincodeInstalled":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "chaincodeNum":{ "type":"number" }, "chaincodes":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChaincodeInfo" } } } }, "StatsChaincodeInfo":{ "type":"object", "properties":{ "ccName":{ "type":"string" }, "ccVersion":{ "type":"string" } } }, "StatsChaincodeInstantiated":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "chaincodeNum":{ "type":"number" }, "chaincodes":{ "type":"array", "items":{ "$ref":"#/definitions/StatsChaincodeInfo" } } } }, "StatsUserTrans":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "orderer":{ "type":"string" }, "userTrans":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsTransInfo":{ "type":"object", "properties":{ "channelName":{ "type":"string" }, "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "trans":{ "type":"number" } } }, "StatsBillableTrans":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "billableTrans":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsEndorsements":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "endorsements":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsCommits":{ "type":"object", "properties":{ "nodeId":{ "type":"string" }, "commits":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsBlocks":{ "type":"object", "properties":{ "blocks":{ "type":"array", "items":{ "$ref":"#/definitions/StatsTransInfo" } } } }, "StatsProxySyncInvocation":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "asyncInvocation":{ "type":"number" } } }, "StatsProxyAsyncInvocation":{ "type":"object", "properties":{ "nodeID":{ "type":"string" }, "startTime":{ "type":"string" }, "endTime":{ "type":"string" }, "asyncInvocation":{ "type":"number" } } }, "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" } } } }, "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" } } } }, "responses":{ "400":{ "description":"Bad Request" }, "401":{ "description":"Not authorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Invalid parameters" }, "500":{ "description":"Service unavailable" }, "409":{ "description":"Operation conflict", "schema":{ "$ref":"#/definitions/Error" } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" } } }, "produces":[ "application/json" ], "parameters":{ "BlockchainPlatformIdentifierPathParam":{ "name":"id", "type":"string", "in":"path", "required":true, "description":"Unique platform instance identifier" }, "IncludeSummaryQueryParam":{ "name":"includeSummary", "in":"query", "type":"string", "enum":[ true, false ], "description":"Include instances summary: true or false" }, "IfMatchHeader":{ "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "in":"header", "name":"if-match", "required":false, "type":"string" }, "PatchIdentifierPathParam":{ "name":"patchId", "type":"string", "in":"path", "required":true, "description":"Unique patch identifier" }, "InstancePatchTypeParam":{ "name":"type", "in":"query", "type":"string", "enum":[ "Applied", "Available", "All" ], "description":"The type of patch for an instance: Applied, Available, or All. All includes Applied and Available." }, "DataRetentionPolicyParam":{ "name":"retainData", "in":"query", "type":"string", "enum":[ true, false ], "description":"Retain user data: either true or false. Default is true." }, "ForceDeleteParam":{ "name":"force", "in":"query", "type":"string", "enum":[ true, false ], "description":"Force Delete an instance: either true or false. Default is false." }, "LdapConfigIdentifierPathParam":{ "name":"id", "type":"string", "in":"path", "required":true, "description":"Unique LDAP configuration identifier" }, "CPConfigIdentifierPathParam":{ "name":"configName", "type":"string", "in":"path", "required":true, "description":"Unique control plane configuration identifier" }, "InstanceNameTextQueryParam":{ "name":"instanceNameText", "in":"query", "type":"string", "description":"Instance name text to be used as search criteria" }, "OperationsQueryParam":{ "name":"operations", "in":"query", "type":"string", "description":"A comma separated list of operation types for which activities are to be retrieved" }, "FromDateQueryParam":{ "name":"fromDate", "in":"query", "type":"string", "description":"Lower bound of date range search criteria in format yyyy-MM-dd" }, "ToDateQueryParam":{ "name":"toDate", "in":"query", "type":"string", "description":"Higher bound of date range search criteria in format yyyy-MM-dd" } }, "consumes":[ "application/json" ], "securityDefinitions":{ "basicAuth":{ "type":"basic", "description":"HTTP Basic Authentication." } }, "security":[ { "basicAuth":[ ] } ] }