Jump to

• Request
• Response
• Examples

Delete a Service Instance

put

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

Deletes an existing service.

Request

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the service account
• service_name: string
  Name of the Integration Cloud instance

Header Parameters

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

Body ()

JSON payload for this REST endpoint

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• dbaName(optional): string
  RDBMS administration user name
• dbaPassword(optional): string
  RDBMS administration password
• force(optional): string
  The service deletion will the force option and will ignore any PaaS script failures
• skipBackupOnTerminate(optional): string
  To check whether the backup to be skipped

{
    "type":"object",
    "properties":{
        "dbaName":{
            "type":"string",
            "description":"RDBMS administration user name"
        },
        "dbaPassword":{
            "type":"string",
            "description":"RDBMS administration password"
        },
        "skipBackupOnTerminate":{
            "type":"string",
            "description":"To check whether the backup to be skipped"
        },
        "force":{
            "type":"string",
            "description":"The service deletion will the force option and will ignore any PaaS script failures"
        }
    },
    "title":"Request Body"
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId(optional): string
  Job ID of the operation.
• message(optional): string
  System message that describes the operation. For example: Submitted job to create service [{serviceName}] in domain [{identityDomainId}].

{
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceName}] in domain [{identityDomainId}].</code>"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to delete 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 "Content-type: application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" -d '{"dbaName":"SYS","dbaPassword":"password","force":true,"skipBackupOnTerminate":true}'http://example.com/paas/core/api/v1.1/instancemgmt/ExampleIdentityDomain/services/IntegrationCloud/instances/test 

Example of Request Header

The following shows an example of the response header.

headers: Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json
Authorization: <Basic Auth credentials>
X-ID-TENANT-NAME: <identity domain>

Example of Request Body

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

{
  "dbaName": "<dba name>",
  "dbaPassword": "<DBaaS Password>",
  "force": true,
  "skipBackupOnTerminate": true
}

Back to Top