Page tree

Overview

The Get Workloads API retrieves any workloads that are associated to your account.

You can use this information to find the workload ID / app ID (id). You will need this ID for other workload-related APIs.

Sample request

GET https://api.armor.com/apps

Input

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

API Call / URLMethod / Type
/apps GET

There are no parameters for this API call. 


Sample return

StatusResponse
200
  [
   {
     "id": 1,
     "name": "VMA",
     "location": "DFW01",
     "zone": "dfw01-vc01",
     "status": 8,
     "deployed": false,
     "tierCount": 1,
     "vmCount": 13,
     "totalCpu": 1,
     "totalMemory": 2048,
     "totalStorage": 30720,
     "notes": null,
     "health": 0,
     "tags": []
   },
   {
     "id": 4,
     "name": "VMW",
     "location": "PHX01",
     "zone": "phx01-vc01",
     "status": 100,
     "deployed": false,
     "tierCount": 1,
     "vmCount": 1,
     "totalCpu": 0,
     "totalMemory": 0,
     "totalStorage": 0,
     "notes": null,
     "health": 2,
     "tags": []
   }
  ]


Output

The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

ReturnTypeDescriptionPossible valuesExample
statusIntegerThe state of the object

A range of numbers from:

  • -1 to 19
  • 100 to 103
0

 The following table lists the possible return values for Status:

Numeric valueString valueDescription
-1FAILED_CREATIONThe object could not be created
0UNRESOLVEDThe object is unresolved
1RESOLVEDThe object is resolved
2DEPLOYEDThe object is deployed
3SUSPENDEDThe object is suspended
4POWERED_ONThe object is powered on
5WAITING_FOR_INPUTThe object is waiting for user input
6UNKNOWNThe object is in an unknown state
7UNRECOGNIZEDThe object is in an unrecognized state
8POWERED_OFFThe object is powered off.
9INCONSISTENT_STATEThe object is in an inconsistent state
10MIXEDChildren do not all have the same status
11DESCRIPTION_PENDINGUpload initiated, OVF descriptor pending
12COPYING_CONTENTSUpload initiated, copying contents
13DISK_CONTENTS_PENDINGUpload initiated, disk contents pending
14QUARANTINEDUpload has been quarantined
15QUARANTINE_EXPIREDUpload quarantine period has expired
16REJECTEDUpload has been rejected
17TRANSFER_TIMEOUTUpload transfer session timed out
18VAPP_UNDEPLOYEDThe vApp is resolved and undeployed
19VAPP_PARTIALLY_DEPLOYEDThe vApp is resolved and partially deployed.
100CHANGES_PENDINGThe request has been received, but not completed. 
101COMPLETEThe action has been completed. 
102BUSYThe server is busy and cannot complete the action. Try again. 
103TEMPLATE_PENDINGThe virtual machine template is currently being generated.



In this topic



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