Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

The Delete Workload API deletes a workload in your account. 

The workload must be empty in order to delete. You can empty the workload by deleting the virtual machine. You can use the Delete VM API to delete the virtual machine.
You can use the Get Workloads API to find the workload ID (id). 

Sample request

DELETE https://api.armor.com/apps/7

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/apps/{id} DELETE

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionRequired or optionalTypeExample
idThe ID of the workload to delete.RequiredInteger7



Sample return

StatusResponse
202
Accepted
400
  {
   "error": true,
   "message": "A workload cannot be deleted unless it is empty.  Please delete all
  virtual machines before deleting the workload."
  }