Jump to

• Request
• Response
• Examples

Delete a Snapshot

delete

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots/{snapshotName}

Deletes a snapshot created for an Oracle Java Cloud Service instance.

On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer: A snapshot cannot be deleted as long as there exists one or more service instance clones created from the snapshot.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.
• serviceId: string
  Name of the Oracle Java Cloud Service instance.
• snapshotName: string
  Name of the snapshot.

Header Parameters

• Authorization: string
  Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Java Cloud Service account.

Back to Top

Response

202 Response

Accepted. The Location header returns a REST URI you can use to view the job status. See View the Status of an Operation by Job Id.

Body ()

Root Schema : snapshot-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 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 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 operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to delete a snapshot by submitting a DELETE request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X DELETE -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/snapshots/mySnapshot-1

Example of Response Header

The following shows an example of the response header when you delete a snapshot.

HTTP/1.1 202 Accepted
Date: Wed, 22 Mar 2017 23:02:17 GMT
Transfer-Encoding: chunked
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/1457148
Content-Type: application/json

Example of Response Body

The following shows an example of the response body when you delete a snapshot.

{
   "status": "New",
   "details": 
   {
      "message": "Remove snapshot [mySnapshot-1] of a service [ExampleInstance] is submitted as an asynchronous job",
      "jobId": "58775"
   }
}

Back to Top