Jump to

• Request
• Response
• Examples

Get Instance Patch Details

get

/api/v1/blockchainPlatforms/instances/{id}/patch

Get instance patch details.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique platform instance identifier

Query Parameters

• type: string
  The type of patch for an instance: Applied, Available, or All. All includes Applied and Available.

  Allowed Values: [ "Applied", "Available", "All" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : InstancePatchInfoSummary

Type: object

Show Source

• applied(optional): array applied
• available(optional): array available

{
    "type":"object",
    "properties":{
        "available":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchInfoSummary"
            }
        },
        "applied":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchInfoSummary"
            }
        }
    }
}

Nested Schema : applied

Type: array

Show Source

• Array of: object PatchInfoSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PatchInfoSummary"
    }
}

Nested Schema : available

Type: array

Show Source

• Array of: object PatchInfoSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PatchInfoSummary"
    }
}

Nested Schema : PatchInfoSummary

Type: object

Show Source

• applicable(optional): boolean
  Is patch able to be applied
• description(optional): string
  Patch description or details
• displayName(optional): string
  Patch display name
• fullVersion(optional): string
  Patch full version
• patchId(optional): string
  Patch ID
• prevVersion(optional): string
  Previous version
• release(optional): string
  Patch release version
• rollbackable(optional): boolean
  Is patch able to be rolled back
• serviceVersion(optional): string
  Patch service version
• status(optional): string
  Patch/rollback status

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

401 Response

Not authorized

404 Response

Invalid parameters

500 Response

Service unavailable

Back to Top

Examples

This endpoint is used to get the details of the instance patch.

The following example shows how to query and get the details of the instance patch by submitting a GET request on the REST resource using cURL:

curl -X GET http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/56cda494-e776-416e-a2fa-c7e2a95955b8/patch?type=All 
-H 'Authorization: Basic amFzc2l0ZXN0OndlbGNvbWUx'

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "available" : [ ],
  "applied" : [ {
    "patchId" : "obp-patch-19-3-3",
    "displayName" : "OBP Patch 19.3.3",
    "description" : "OBP Patch 19.3.3",
    "serviceVersion" : "19.3",
    "release" : "3",
    "fullVersion" : "19.3.3",
    "prevVersion" : "19.3.2",
    "rollbackable" : true,
    "applicable" : null,
    "status" : "Applied"
  } ]
}

Back to Top