Jump to

• Request
• Response
• Examples

Apply a Patch

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/patches/{patchId}

Applies a patch to an Oracle Integration Classic instance. To minimize service disruption, a patch is applied in a rolling pattern, patching a single node at a time.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Integration Classic account.
• patchId: string
  Patch ID. The patch ID can be retrieved by getting the list of available patches.
• service_name: string
  Name of the Oracle Integration Classic instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Integration Classic account.

Body ()

The request contains information about the patch operation. There are no required values.

Root Schema : patch-request

Type: object

Show Source

• additionalNote(optional): string
  Free-form text to provide additional information about the patch.
• dgStatusHaPolicy(optional): string
• dgStatusHaState(optional): string
  Note: Applicable only for a service instance that has Oracle Coherence enabled.

  Target StatusHA state for the Coherence distributed services. Valid values include:

  • NODE-SAFE (this is the default)
  • MACHINE-SAFE

• dgStatusHaTimeoutSecs(optional): integer
  Note: Applicable only for a service instance that has Oracle Coherence enabled.

  Number of seconds to wait for StatusHA to reach the given state before timing out. This value defaults to 300 seconds.

{
    "properties":{
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the patch."
        },
        "dgStatusHaPolicy":{
            "type":"string"
        },
        "dgStatusHaState":{
            "type":"string",
            "description":"<b>Note:</b> Applicable only for a service instance that has Oracle Coherence enabled. <p>Target <code>StatusHA</code> state for the Coherence distributed services. Valid values include:<ul><li><code>NODE-SAFE</code> (this is the default)</li><li><code>MACHINE-SAFE</code></li></ul>"
        },
        "dgStatusHaTimeoutSecs":{
            "type":"integer",
            "description":"<b>Note:</b> Applicable only for a service instance that has Oracle Coherence enabled.<p>Number of seconds to wait for <code>StatusHA</code> to reach the given state before timing out. This value defaults to 300 seconds."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

Body ()

The response body includes information about the operation.

Root Schema : patch-response

Type: object

The response body includes information about the operation.

Show Source

• details(optional): object details
  Groups the details of the operation.
• status(optional): string
  Status of the operation. When first initiated, the status is set to New. The status may transition to one of the following values: Completed and Cannot Complete

{
    "description":"The response body includes information about the operation.",
    "properties":{
        "details":{
            "type":"object",
            "description":"Groups the details of the operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the patch operation or patch precheck operation."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation."
                }
            }
        },
        "status":{
            "type":"string",
            "description":"Status of the operation. When first initiated, the status is set to <code>New</code>. The status may transition to one of the following values: <code>Completed</code> and <code>Cannot Complete</code>"
        }
    }
}

Nested Schema : details

Type: object

Groups the details of the operation.

Show Source

• jobId(optional): string
  Job ID for the patch operation or patch precheck operation.
• message(optional): string
  System message that describes the operation.

{
    "type":"object",
    "description":"Groups the details of the operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the patch operation or patch precheck operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to apply a patch to an Oracle Integration Classic Instance by submitting a PUT request on the REST resource using cURL.

Note:

The command in this example uses the URL structure https://example.com/resource-path, where example.com is the Oracle Cloud server to contact for your identity domain.

cURL Command

curl -v -X PUT -u jstein:Password -H "Accept:application/json" -H "Content-type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" http://example.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/IntegrationCloud/instances/L1patch/patches/17.3.3.170724.2107-1194 

Example of Request Header

The following shows an example of the response header.

headers: Content-Type:application/json
Authorization: <Basic Auth credentials>
X-ID-TENANT-NAME: <identity domain>
Accept:application/json

Example of Response Body

The following shows an example of the request body in JSON format.

{
   "status":"Completed",
   "details":
   {
      "message":"PATCHING-5068: Patching service with patch [wls_patch_12.2.1.2.0_170308] is submitted as an asynchronous job.",
      "jobId":"4953052"
   }
}

Back to Top