Armor Infrastructure API

openapi: 3.2.0
info:
  version: v1
  title: Armor Services Infrastructure API
servers:
- url: https://api.armor.com
tags:
- name: Infrastructure
paths:
  /{entityType}/{entityId}/tasks:
    get:
      tags:
      - Infrastructure
      summary: Retrieve a list of scheduled events that are associated to your account.
      operationId: Task_GetList
      parameters:
      - name: entityType
        in: path
        description: The type of the entity
        required: true
        schema:
          type: string
      - name: entityId
        in: path
        description: id of the entity
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Services.Http.Scheduling.Models.TaskResponse'
              example:
              - entityType: vms
                entityId: '100'
                action: delete
                taskDate: '2015-01-01T00:00:00'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Services.Http.Scheduling.Models.TaskResponse'
      deprecated: false
    delete:
      tags:
      - Infrastructure
      summary: Delete a scheduled event that is associated to an entity.
      operationId: Task_CancelTask
      parameters:
      - name: entityType
        in: path
        description: The type of the entity
        required: true
        schema:
          type: string
      - name: entityId
        in: path
        description: id of the entity
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '400':
          description: Bad Request
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Scheduling.Models.TaskRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Scheduling.Models.TaskRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Scheduling.Models.TaskRequest'
        description: Request
        required: true
  /{entityType}/tasks:
    get:
      tags:
      - Infrastructure
      summary: Retrieve list of scheduled events for all accounts.
      operationId: Task_GetTaskList
      parameters:
      - name: entityType
        in: path
        description: The type of the entity
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Scheduling.Data.Domain.FullTaskResponse%5D'
              example:
                total: 1
                page: 1
                items:
                - entityType: vms
                  entityId: '100'
                  action: delete
                  taskDate: '2026-02-12T16:25:55.4031549Z'
                  vmName: IIS Web Server 01
                  accountId: 2
                  accountName: Development Test Account
                  type: Infrastructure
                  summary: Jonh Doe scheduled IIS Web Server 01 to be deleted on 09/01/2017 12:00
                  datetimeOfActivity: '0001-01-01T00:00:00'
            text/json:
              schema:
                $ref: '#/components/schemas/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Scheduling.Data.Domain.FullTaskResponse%5D'
      deprecated: false
  /apps:
    get:
      tags:
      - Infrastructure
      summary: Retrieve any workloads that are associated to your Account.
      operationId: App_GetAppList
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDto'
              example:
              - 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: []
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDto'
      deprecated: false
  /apps/{appId}/tiers:
    get:
      tags:
      - Infrastructure
      summary: Retrieves all the tiers associated with a specified workload.
      operationId: Tier_GetAppTiers
      parameters:
      - name: appId
        in: path
        description: id for the workload to retrieve tiers
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: ''
              example:
              - id: 5
                name: New Tier 1
                vms: []
              - id: 7
                name: New Tier 3
                vms: []
            text/json:
              schema:
                type: array
                items:
                  $ref: ''
        '400':
          description: Bad Request
      deprecated: false
    post:
      tags:
      - Infrastructure
      summary: Create a new tier on a workload, to serve as a logical grouping of servers within a workload.
      operationId: Tier_AddTier
      parameters:
      - name: appId
        in: path
        description: id of the workload to which the tier should be added
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
              example:
                tiers:
                - id: 5
                  name: New Tier 1
                  vms: []
                - id: 6
                  name: New Tier 2
                  vms: []
                - id: 7
                  name: New Tier 3
                  vms: []
                id: 1
                name: Name
                location: null
                zone: null
                status: 8
                deployed: false
                tierCount: 4
                vmCount: 13
                totalCpu: 1
                totalMemory: 2048
                totalStorage: 30720
                notes: null
                health: 0
                tags: []
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
        '400':
          description: Bad Request
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.AddTierSampleRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.AddTierSampleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.AddTierSampleRequest'
        description: Details for the new tier (Name)
        required: true
  /apps/{appId}/tiers/{tierId}:
    get:
      tags:
      - Infrastructure
      summary: Retrieves information for a specified tier from a workload.
      operationId: Tier_Get
      parameters:
      - name: appId
        in: path
        description: The ID of the workload that contains the tier
        required: true
        schema:
          type: integer
          format: int32
      - name: tierId
        in: path
        description: The ID of the tier
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: ''
              example:
                id: 5
                name: New Tier 1
                vms: []
            text/json:
              schema:
                type: array
                items:
                  $ref: ''
        '400':
          description: Bad Request
      deprecated: false
    put:
      tags:
      - Infrastructure
      summary: Updates an existing tier on a workload
      operationId: Tier_UpdateTier
      parameters:
      - name: appId
        in: path
        description: id of the workload to which the tier should be added
        required: true
        schema:
          type: integer
          format: int32
      - name: tierId
        in: path
        description: id of the tier
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
              example:
                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: []
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
        '400':
          description: Bad Request
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.UpdateTierExampleRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.UpdateTierExampleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.UpdateTierExampleRequest'
        description: Details for the tier (Name) to be updated
        required: true
    delete:
      tags:
      - Infrastructure
      summary: Delete a single tier from a workload.
      description: <b>The tier must not contain any VMs.</b> If the tier does contain one or more VMs you will get a 400 back with an appropriate error message.
      operationId: Tier_DeleteTier
      parameters:
      - name: appId
        in: path
        description: id of the target workload
        required: true
        schema:
          type: integer
          format: int32
      - name: tierId
        in: path
        description: id of the tier targeted for deletion
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDto'
              example:
                id: 1
                name: Name
                location: null
                zone: null
                status: 8
                deployed: false
                tierCount: 4
                vmCount: 13
                totalCpu: 1
                totalMemory: 2048
                totalStorage: 30720
                isRecoveryWorkload: false
                tiers:
                - id: 5
                  name: New Tier 1
                  vms: []
                - id: 7
                  name: New Tier 3
                  vms: []
                notes: null
                health: 0
                tags: []
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDto'
        '400':
          description: You cannot delete a tier that has VMs assigned to it.
      deprecated: false
  /apps/{id}:
    get:
      tags:
      - Infrastructure
      summary: Retrieve details for a workload that is associated to your Account.
      operationId: App_GetAppDetail
      parameters:
      - name: id
        in: path
        description: id for the workload to retrieve details
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
              example:
                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
                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: []
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
        '404':
          description: Unable to find workload
      deprecated: false
    put:
      tags:
      - Infrastructure
      summary: Update the details for a workload that is associated to your Account.
      operationId: App_UpdateApp
      parameters:
      - name: id
        in: path
        description: id of a workload (ignored)
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
              example:
                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
                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: []
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail'
        '400':
          description: Invalid request
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.UpdateAppSampleRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.UpdateAppSampleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.UpdateAppSampleRequest'
        description: New name for the workload<br /><br />id of the workload
        required: true
    delete:
      tags:
      - Infrastructure
      summary: Delete a workload that is associated to your Account.
      description: Workload must be empty for it to be deleted.
      operationId: App_DeleteApp
      parameters:
      - name: id
        in: path
        description: id for the workload to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Accepted
        '400':
          description: A workload cannot be deleted unless it is empty. Please delete all virtual machines before deleting the workload.
      deprecated: false
  /apps/vms/{id}:
    put:
      tags:
      - Infrastructure
      summary: Assign VM to Workload
      operationId: App_AssignVmToWorkLoad
      parameters:
      - name: id
        in: path
        description: ID of the VM
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: ''
              example:
                vmId: 1
                workloadId: 2
                tierId: 3
                accountId: 4
                userName: example@armor.com
            text/json:
              schema:
                type: array
                items:
                  $ref: ''
        '400':
          description: Invalid request
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.SampleAssignVmToWorkloadRequestDto'
          text/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.SampleAssignVmToWorkloadRequestDto'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Compute.ApiExamples.Models.SampleAssignVmToWorkloadRequestDto'
        description: "vmId: ID of the VM\n            <br /><br />workloadId: ID of the workload\n            <br /><br />tierId: ID of the tier\n            <br /><br />accountId: ID of the account\n            <br /><br />userName: email of the user making this change"
        required: true
  /health-monitoring/core/health/{vmId}:
    get:
      tags:
      - Infrastructure
      operationId: ServiceHealth_HealthStatus
      parameters:
      - name: vmId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsResponse'
              example:
                healthDetails:
                - name: FIM
                  state: OK
                  message: ''
                  messageHoverText: null
                  duration: '2026-02-12T15:25:55.4194119+00:00'
                  ticketNumber: null
                  subAgentVersion: null
                  subAgentProductName: null
                  hideServices: false
                - name: MalwareProtection
                  state: Needs Attention
                  message: Malware Protection has not provided a heartbeat in the past 4 hours.
                  messageHoverText: null
                  duration: '2026-02-12T15:25:55.4194119+00:00'
                  ticketNumber: 12345
                  subAgentVersion: null
                  subAgentProductName: null
                  hideServices: false
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsResponse'
        '400':
          description: Bad Request
      deprecated: false
  /health-monitoring/core/health-status/{vmId}:
    get:
      tags:
      - Infrastructure
      operationId: ServiceHealth_HealthStatusPublic
      parameters:
      - name: vmId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsPublicResponse'
              example:
                healthDetails:
                - name: FIM
                  state: OK
                  message: ''
                  messageHoverText: null
                  subAgentVersion: null
                  subAgentProductName: null
                - name: MalwareProtection
                  state: Needs Attention
                  message: Malware Protection has not provided a heartbeat in the past 4 hours.
                  messageHoverText: null
                  subAgentVersion: null
                  subAgentProductName: null
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsPublicResponse'
        '400':
          description: Bad Request
      deprecated: false
  /locations:
    get:
      tags:
      - Infrastructure
      summary: Return a set of available locations for provisioning new servers.
      operationId: Location_Get
      parameters:
      - name: requireZone
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Environment.LocationDto'
              example:
              - id: 1
                location: DFW01
                name: US Central
                zones:
                - DFW01T01-VC01
                displayName: null
              - id: 2
                location: PHX01
                name: US West
                zones:
                - PHX01T01-VC03
                - PHX01T01-VC02
                - PHX01T01-VC01
                displayName: null
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Compute.Models.Environment.LocationDto'
        '400':
          description: Bad Request
      deprecated: false
  /orders:
    get:
      tags:
      - Infrastructure
      summary: Retrieve the list of orders that are associated to your account.
      operationId: Orders_GetOrdersAsync
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Data.Domain.Order'
              example:
              - orderId: 101
                accountId: 2
                appId: null
                dateOrdered: '2015-01-01T00:00:00'
                status: Provisioned
                jsonData: '{ }'
                secret: null
                createdBy: user@example.com
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Data.Domain.Order'
        '400':
          description: Bad Request
      deprecated: false
  /orders/{id}:
    get:
      tags:
      - Infrastructure
      summary: Retrieve a specific order for your account.
      operationId: Orders_GetOrderAsync
      parameters:
      - name: id
        in: path
        description: id of the Order
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Data.Domain.Order'
              example:
                orderId: 101
                accountId: 2
                appId: null
                dateOrdered: '2015-01-01T00:00:00'
                status: Provisioned
                jsonData: '{ }'
                secret: null
                createdBy: user@example.com
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Data.Domain.Order'
        '400':
          description: Bad Request
      deprecated: false
  /orders/{osname}/wsus:
    get:
      tags:
      - Infrastructure
      summary: Retrieve the Wsus details for your ordered vm.
      operationId: Orders_GetWsusDetails
      parameters:
      - name: osname
        in: path
        description: OS Name of the vm Ordered
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Data.Domain.Order'
              example:
                orderId: 101
                accountId: 2
                appId: null
                dateOrdered: '2015-01-01T00:00:00'
                status: Provisioned
                jsonData: '{ }'
                secret: null
                createdBy: user@example.com
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Data.Domain.Order'
        '400':
          description: Bad Request
      deprecated: false
  /orders/subscriptions:
    post:
      tags:
      - Infrastructure
      summary: Submit a subscription order.
      operationId: Orders_PostSubscriptionOrderAsync
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Models.OrderDto'
              example:
                id: 33
                accountId: 2
                status: Submitted
                dateCreated: '2015-01-07T02:00:00+00:00'
                subscriptions:
                - location: null
                  sku: DB-SQL-EXPRESS-2012
                  quantity: 1
                  accountId: 1
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FireHost.Infrastructure.Orders.Models.OrderDto'
        '400':
          description: Bad Request
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Orders.ApiExamples.Models.PostSubscriptionOrderAsyncSampleRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FireHost.Services.Http.Orders.ApiExamples.Models.PostSubscript

# --- truncated at 32 KB (107 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/armor/refs/heads/main/openapi/armor-infrastructure-api-openapi.yml