Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : BlockchainPlatformInstanceStatus

Type: object

Blockchain Platform instance status

Show Source

• details(optional): string
• instanceId(optional): string
• status(optional): string

{
    "description":"Blockchain Platform instance status",
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "details":{
            "type":"string"
        }
    }
}

401 Response

Not authorized

404 Response

Invalid parameters

500 Response

Service unavailable

Back to Top

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="
}

Back to Top