1. REST API for Lifecycle Management in Oracle API Platform Cloud Service - Classic
  2. Tasks
  3. Service Instances

Delete a Service Instance

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}

Deletes an API Platform Cloud Service - Classic instance.

Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Request

Supported Media Types
Path Parameters
  • Name of the identity domain for the API Platform Cloud Service - Classic account.
  • Name of the API Platform Cloud Service - Classic instance.

    Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Header Parameters
Body ()
The request body defines the details of the delete request.
Root Schema : delete-instance
Type: object
Request body for deleting a service instance.
Show Source
Nested Schema : componentParameters
Type: object
Object containing component-level properties. This object can be left blank.
Show Source
Nested Schema : serviceParameters
Type: object
Object containing service-level properties.
Show Source
  • Username for the Oracle Database Cloud - Database as a Service instance administrator. This value must be set to a database user with SYSDBA system privileges. You can use the default user SYS or a user that has been granted the SYSDBA privilege.
  • Password for the Oracle Database Cloud - Database as a Service instance administrator.
  • Flag that specifies whether you want to force the removal of the service instance even if the database instance cannot be reached to delete the database schemas. If set to true, you may need to delete the associated database schemas manually on the database instance if they are not deleted as part of the service instance delete operation. This value defaults to false.
  • Flag that specifies whether you want to skip backing up the service instance before deleting it. This value defaults to true.
Back to Top

Response

Supported Media Types

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Headers
Back to Top

Examples

The following example shows how to delete an Oracle API Platform Cloud Service - Classic instance by submitting a PUT request on the REST resource using cURL. For more information about cURL, see cURL Examples. 

curl -i -X PUT 
-u apicsadmin:password 
-H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json"
-d @delete.json 
https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics

Example of Request Body

The following shows an example of the request body in JSON format, including the username and password of the Oracle Database Cloud - Database as a Service instance administrator for the DBaaS instance associated with the service instance you want to delete.

{
   "serviceParameters": {
      "dbaName"    : "SYS",
      "dbaPassword":"password"
   },
   "componentParameters": {
   }
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 202 Accepted
Date: Wed, 23 Nov 2016 11:30:06 GMT
Transfer-Encoding: chunked
Location: https://example.com:7103/paas/api/v1.1/activitylog/apics/job/26366
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Service-URI: https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-000000000000601a
Access-Control-Allow-Origin: *
X-Frame-Options: DENY

Example of Response Body

The following example shows the contents of the response body in JSON format, including the jobId of the delete operation.

{
	"details": {
		"message": "Submitted job to delete service [apics] in domain [apics].",
		"jobId": "26366"
	}
}
Back to Top