Jump to

• Request
• Response
• Examples

Delete One or More Backups

post

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/deletedbackups

Deletes a backup of an Oracle SOA Service instance.

Request

Path Parameters

• domainName: string
  Name of the identity domain for the Oracle Cloud Service account.
• serviceName: string
  Name of the Oracle SOA Cloud Service instance.

Body ()

The request body to delete the backup.

Root Schema : deletebackup-request

Type: object

The request body to delete the backup.

Show Source

• backupId: string
  The ID of the backup.

{
    "required":[
        "backupId"
    ],
    "description":"The request body to delete the backup.",
    "properties":{
        "backupId":{
            "type":"string",
            "description":"The ID of the backup."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/plain

202 Response

Accepted.

Body ()

Root Schema : backup-response

Type: object

The response body contains information about the Backup operation.

Show Source

• job_id: string
  Job ID for the Backup operation.
• operationName: string
  Name of the Backup operation. Depending on the operation, name can be start-backup, delete-backup, or restore-backup
• target_uri: string
  Target Backup URL of the Oracle SOA Cloud Service instance.

{
    "required":[
        "operationName",
        "job_id",
        "target_uri"
    ],
    "description":"The response body contains information about the Backup operation.",
    "properties":{
        "operationName":{
            "type":"string",
            "description":"Name of the Backup operation. Depending on the operation, name can be <code>start-backup</code>, <code>delete-backup</code>, or <code>restore-backup</code>"
        },
        "job_id":{
            "type":"string",
            "description":"Job ID for the Backup operation."
        },
        "target_uri":{
            "type":"string",
            "description":"Target Backup URL of the Oracle SOA Cloud Service instance."
        }
    }
}

404 Response

Not found. Returned if the backup does not exist.

Back to Top

Examples

The following example shows how to delete a backup of an Oracle SOA Cloud Service instance by submitting a POST request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X POST -u username:Password1! -d @backup.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/deletedbackups

Example of Request Body

The following example shows the request body in JSON format.

{ 
	"backupId": "bc1b13d4-9a0f-4f99-8701-e203f645f732" 
}

Example of Response Header

The following example shows the response header:

-u '{userName}:{password}'
Content-type:application/json
X-ID-TENANT-NAME: {identityDomainId}
Accept: application/json

Example of Response Body

The following example shows the response body in JSON format, including the backup URI that you can use to view, update, or delete the backup.

{ 
	"operationName": "delete-backup", 
	"target_uri": "http://{host}:{port}/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/deletedbackups/2632",
	"job_id": "2632"
}

Back to Top