Jump to

• Request
• Response
• Examples

Apply Patch to Target Instances

post

/api/v1/blockchainPlatforms/patches/{patchId}/apply

Apply patch to one or more target instances.

Request

Supported Media Types

• application/json

Path Parameters

• patchId: string
  Unique patch identifier

Body ()

List of target instance IDs to apply the patch

Root Schema : PatchApplyPayload

Type: array

List of patch target instance IDs

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of patch target instance IDs",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : PatchApplySummary

Type: object

Show Source

• applyStatus(optional): array applyStatus
  Patch application request status for all targets
• patchId(optional): string
  Patch ID that was applied

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

Nested Schema : applyStatus

Type: array

Patch application request status for all targets

Show Source

• Array of: object PatchApplyStatus

{
    "type":"array",
    "description":"Patch application request status for all targets",
    "items":{
        "$ref":"#/definitions/PatchApplyStatus"
    }
}

Nested Schema : PatchApplyStatus

Type: object

Show Source

• instanceId(optional): string
  Patch applied instance ID
• instanceName(optional): string
  Patch applied instance display name
• status(optional): string
  Allowed Values: [ "Success", "Failure" ]

  Patch application request status
• statusURL(optional): string
  Patch request status URL

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

401 Response

Not authorized

404 Response

Invalid parameters

409 Response

Operation conflict

Body ()

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

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

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Service unavailable

Back to Top

Examples

This endpoint is used to apply a patch to one or more target instances.

The following example shows how to apply a patch to one or more target instances by submitting a POST request on the REST resource using cURL.

curl -X POST http://<hostname>:<port>/api/v1/blockchainPlatforms/patches/obp-patch-19-3-3/apply 
-H 'Authorization: Basic amFzc2l0ZXN0OndlbGNvbWUx' 
-H  'Content-Type: application/json' 
-d '["e1f7bcfe-cc7e-4d19-97fb-772b231fcf99"]'

Example of the Response Body

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

{
  "patchId" : "obp-patch-19-3-3",
  "applyStatus" : [ {
    "instanceId" : "e1f7bcfe-cc7e-4d19-97fb-772b231fcf55",
    "instanceName" : "JasFounder",
    "status" : "Success",
    "statusURL" : "http://myvm.oracle.com:7070/api/v1/blockchainPlatforms/instances/56cda494-e776-416e-a2fa-c7e2a95955b8/operation/IDp6T6cqcEOUe8XMJEpHi4S2PnYCY6xGkuPazlGAGM9C8=/status"
  } ]
}

Back to Top