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 Update Tier API updates the name of a tier in a workload. 

You can use the Get Workloads API to find the workload ID / app ID (id). 
You can use the Get Workload API to find the tier ID (id). 

Sample request

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

{
 "name": "New Tier 1"
}

Input

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

API Call / URLMethod / Type

/apps/{appId}/tiers/{tierId}

PUT

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

ParameterDescriptionRequired or optionalTypeExample
appIdThe ID of the workload that contains the tierRequiredInteger1
tierIdThe ID of the tier to updateRequiredInteger5
nameThe new name of the tierRequiredStringNew Tier 1



Sample return

StatusResponse
200
{
  "tiers": [
    {
      "id": 5,
      "name": "SMOKE-TEST-1",
      "vms": [
        {
          "id": 1,
          "coreInstanceId": "00000000-0000-0000-0000-000000000000",
          "name": "Smoke - Test - A1",
          "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
        }
      ]
    },
    {
      "id": 6,
      "name": "New Tier 1",
      "vms": [
        {
          "id": 9,
          "coreInstanceId": "00000000-0000-0000-0000-000000000000",
          "name": "New_Test_01",
          "provider": null,
          "location": null,
          "zone": null,
          "ipAddress": null,
          "status": 100,
          "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": 0,
          "tags": [],
          "scheduledEvents": null
        }
      ]
    }
  ],
  "id": 1,
  "name": "string",
  "location": "DFW01",
  "zone": "DFW01-VC01",
  "status": 8,
  "deployed": false,
  "tierCount": 2,
  "vmCount": 13,
  "totalCpu": 1,
  "totalMemory": 2048,
  "totalStorage": 30720,
  "notes": null,
  "health": 0,
  "tags": []
}