Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

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

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

Sample request

Code Block
languagetext
PUT https://api.armor.com/apps/1

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

Input


Excerpt Include
ESLP:API table parts (snippet)
ESLP:API table parts (snippet)
nopaneltrue

...

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

Sample return

StatusResponse
200
Code Block
languagetext
{
 "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
Code Block
languagetext
{
 "error": true,
 "message": "Invalid request"
}

Output

Excerpt Include
ESLP:Output results (snippet)
ESLP:Output results (snippet)
nopaneltrue

ReturnTypeDescriptionPossible valuesExample
statusIntegerThe state of the objectA range of numbers from -1 to 19 (See Note below for possible values)
4



 

Excerpt Include
ESLP:Status return values (snippet)
ESLP:Status return values (snippet)
nopaneltrue