Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »


Armor Knowledge Base


Feedback

Have a suggestion for the Armor Knowledge Base?

Send a message to kb@armor.com.









Overview

The Update Workload API updates the details for a workload in your account, specifically the name of the workload.  

You can use the Get Workloads API to find the workload ID (id). 

Sample request

PUT https://api.armor.com/apps/1

{
 "id": 1,
 "name": "VMW Workload"
}

Input

Error rendering macro 'excerpt-include'

No link could be created for 'API table parts (snippet)'.

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

Error rendering macro 'excerpt-include'

No link could be created for 'Parameters to include (snippet)'.

ParameterDescriptionRequired or optionalTypeExample
idThe ID of the workloadRequiredInteger1
NameThe new name for the workloadRequiredStringVMW Workload
idThe ID of the workloadRequiredInteger1



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,
 "tiers": [
   {
     "id": 1,
     "name": "VMA",
     "vms": [
       {
         "id": 1,
         "coreInstanceId": "00000000-0000-0000-0000-000000000000",
         "name": "VMA",
         "provider": null,
         "location": null,
         "zone": null,
         "ipAddress": null,
         "status": 4,
         "appId": 0,
         "appName": null,
         "osId": null,
         "os": "Ubuntu 14.04",
         "deployed": false,
         "cpu": 1,
         "memory": 2048,
         "storage": 30720,
         "notes": null,
         "vCenterId": 0,
         "vCenterName": null,
         "product": null,
         "uuid": null,
         "health": 1,
         "tags":[],
         "scheduledEvents": null
       }
     ]
   }
 ],
 "notes": null,
 "health": 0,
 "tags": []
}
400
{
 "error": true,
 "message": "Invalid request"
}