Delete an Integration

To delete an integration, you make a DELETE request with the ID of the integration.

The following procedure shows how to delete an integration including an optional step to list the integration details before deleting the integration. It is a good practice to check the details of the integration so that you delete the correct integration.

Prerequisites

• Verify that all general prerequisites and prerequisites for the Automation Assembler Infrastructure as a Service (IaaS) service have been satisfied. See Prerequisites for API Use Case Examples.
• Verify that you have the ID of the integration that you want to delete. See Create an Integration with Github.

Procedure

1. Assign your integration ID variable.

   integration_id='<your_integration_id>'

2. (Optional) List the integration before deleting.

   curl -X GET -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/integrations/$integration_id?apiVersion=$api_version" | jq "."

3. (Optional) Examine the response to verify the integration details, such as integration name and integration type.
4. Submit a request to delete the integration.

   curl -X DELETE -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/integrations/$integration_id?apiVersion=$api_version" | jq "."

   The response includes a selfLink.

   {
     "progress": 0,
     "status": "INPROGRESS", 
     "name": "Integration deletion",
     "id": "example-selfLink-alphanumeric-string",  
     "selfLink": "/iaas/api/request-tracker/example-selfLink-alphanumeric-string"
   }

5. Assign the selfLink variable.

   selfLink_id='example-selfLink-alphanumeric-string'

6. Use the selfLink variable to track the request.

   curl -X GET -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/request-tracker/$selfLink_id | jq "."

   When the request completes successfully, the response shows the status as FINISHED.

   {
     "progress": 100,
     "message": "Deleted",
     "status": "FINISHED",  
     "name": "Integration deletion",
     "id": "example-selfLink-alphanumeric-string",
     "selfLink": "/iaas/api/request-tracker/example-selfLink-alphanumeric-string"
   }

Example: Delete an integration

Assign the required variables.

Note: If your organization uses an API service that is hosted outside of the United States, your URL variable must include a country abbreviation. See Regional Endpoints for VMware Aria Automation APIs.

$ url='https://api.mgmt.cloud.vmware.com'
$ api_version='2021-07-15'
$ integration_id='e5dda941-bb17-4f19bd15-7db0b8eab88c'

Delete the integration.

curl -X DELETE -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/integrations/$integration_id?apiVersion=$api_version" | jq "."

The response includes a selfLink.

{
  "progress": 0,
  "status": "INPROGRESS",
  "name": "Integration deletion",
  "id": "fe472e75-f346-4de7-bbc4-5edddefd9dfa",
  "selfLink": "/iaas/api/request-tracker/fe472e75-f346-4de7-bbc4-5edddefd9dfa"
}

Assign the selfLink variable

selfLink_id='fe472e75-f346-4de7-bbc4-5edddefd9dfa'

Use the selfLink variable to track the request.

curl -X GET -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/request-tracker/$selfLink_id | jq "."

When the request completes successfully, the response shows the status as FINISHED.

{
  "progress": 100,
  "message": "Deleted",
  "status": "FINISHED",
  "name": "Integration deletion",
  "id": "fe472e75-f346-4de7-bbc4-5edddefd9dfa",
  "selfLink": "/iaas/api/request-tracker/fe472e75-f346-4de7-bbc4-5edddefd9dfa"
}