Get Blockchain Platform Status
get
/api/v1/blockchainPlatforms/instances/{id}/status
Get the Blockchain Platform status.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Unique platform instance identifier
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : BlockchainPlatformInstanceStatus
Type:
object
Blockchain Platform instance status
Show Source
401 Response
Unauthorized
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
404 Response
Not Found
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
Examples
This endpoint is used to get the status of a particular Blockchain Platform instance.
The following example shows how to query and get the status of a particular Blockchain Platform instance by submitting a GET request on the REST resource using cURL.
curl -X GET \ http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/operation/IDpJPaezDL9_7zTlfY2ti-LlxB7kW8hCoz5lZPQCv8Cr4=/status \ -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \ -H 'Content-Type: application/json'
Example of the Response Body
The following example shows the contents of the response body in JSON format:
{ "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99", "operation": "create", "status": "successful", "details": "", "operationId": "IDpJPaezDL9_7zTlfY2ti-LlxB7kW8hCoz5lZPQCv8Cr4=" }