{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Armor Services API"
},
"host": "api.armor.com",
"schemes": ["https"],
"paths": {
"/{entityType}/{entityId}/tasks": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieve a list of scheduled events that are associated to your account.",
"operationId": "Task_GetList",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "The type of the entity",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "id of the entity",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Scheduling.Models.TaskResponse"
}
},
"examples": {
"application/json": [{
"entityType": "vms",
"entityId": "100",
"action": "delete",
"taskDate": "2015-01-01T00:00:00"
}]
}
}
},
"deprecated": false
},
"delete": {
"tags": ["Infrastructure"],
"summary": "Delete a scheduled event that is associated to an entity.",
"operationId": "Task_CancelTask",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "The type of the entity",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "id of the entity",
"required": true,
"type": "string"
}, {
"name": "request",
"in": "body",
"description": "Request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Scheduling.Models.TaskRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/{entityType}/tasks": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieve list of scheduled events for all accounts.",
"operationId": "Task_GetTaskList",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "The type of the entity",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Scheduling.Data.Domain.FullTaskResponse%5D"
},
"examples": {
"application/json": {
"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"
}]
}
}
}
},
"deprecated": false
}
},
"/apps": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieve any workloads that are associated to your Account.",
"operationId": "App_GetAppList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Application.ApplicationDto"
}
},
"examples": {
"application/json": [{
"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": []
}]
}
}
},
"deprecated": false
}
},
"/apps/{appId}/tiers": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieves all the tiers associated with a specified workload.",
"operationId": "Tier_GetAppTiers",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "appId",
"in": "path",
"description": "id for the workload to retrieve tiers",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": [{
"id": 5,
"name": "New Tier 1",
"vms": []
}, {
"id": 7,
"name": "New Tier 3",
"vms": []
}]
}
},
"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",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "appId",
"in": "path",
"description": "id of the workload to which the tier should be added",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "tierDto",
"in": "body",
"description": "Details for the new tier (Name)",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Compute.ApiExamples.Models.AddTierSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail"
}
},
"examples": {
"application/json": {
"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": []
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/apps/{appId}/tiers/{tierId}": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieves information for a specified tier from a workload.",
"operationId": "Tier_Get",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "appId",
"in": "path",
"description": "The ID of the workload that contains the tier",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "tierId",
"in": "path",
"description": "The ID of the tier",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"id": 5,
"name": "New Tier 1",
"vms": []
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Infrastructure"],
"summary": "Updates an existing tier on a workload",
"operationId": "Tier_UpdateTier",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "appId",
"in": "path",
"description": "id of the workload to which the tier should be added",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "tierId",
"in": "path",
"description": "id of the tier",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "tier",
"in": "body",
"description": "Details for the tier (Name) to be updated",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Compute.ApiExamples.UpdateTierExampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail"
}
},
"examples": {
"application/json": {
"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": []
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Infrastructure"],
"summary": "Delete a single tier from a workload.",
"description": "The tier must not contain any VMs. If the tier does contain one or more VMs you will get a 400 back with an appropriate error message.",
"operationId": "Tier_DeleteTier",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "appId",
"in": "path",
"description": "id of the target workload",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "tierId",
"in": "path",
"description": "id of the tier targeted for deletion",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Application.ApplicationDto"
}
},
"examples": {
"application/json": {
"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": []
}
}
},
"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",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the workload to retrieve details",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail"
}
},
"examples": {
"application/json": {
"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": []
}
}
},
"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",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of a workload (ignored)",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "New name for the workload
id of the workload",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Compute.ApiExamples.Models.UpdateAppSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail"
}
},
"examples": {
"application/json": {
"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": []
}
}
},
"400": {
"description": "Invalid request"
}
},
"deprecated": false
},
"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",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the workload to delete",
"required": true,
"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",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "ID of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "requestDto",
"in": "body",
"description": "vmId: ID of the VM\r\n
workloadId: ID of the workload\r\n
tierId: ID of the tier\r\n
accountId: ID of the account\r\n
userName: email of the user making this change",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Compute.ApiExamples.Models.SampleAssignVmToWorkloadRequestDto"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"vmId": 1,
"workloadId": 2,
"tierId": 3,
"accountId": 4,
"userName": "example@armor.com"
}
}
},
"400": {
"description": "Invalid request"
}
},
"deprecated": false
}
},
"/backup/activity-logs": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of restore activity logs",
"description": "Get request URI contain the following query options\r\n
\r\n
\r\n$top (required): total number of results to display. Data Type: integer. Example: $top=25
$skip (required): skips the top number of results. Data Type: integer. Example: $skip=1
$filter (optional): filters down results. Data Type: string. Example: $filter=status%20eq%20%27Success%27%20and%20taskCategory%20eq%20%27Restoring%20files%27
$search (optional): search for specific result. Data Type: string. Example: $search=file%20restore
$orderby (optional): order by column name (name, message, startTime, endTime, errorMessage). Data Type: string. Example: $orderby=startTime%20desc",
"operationId": "AdvancedBackup_GetActivityLogList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.ActivityLogDto"
},
"examples": {
"application/json": {
"taskId": "00000000-0000-0000-0000-000000000000",
"event": "Adjusting Vm Resources",
"message": "Backup VM refresh completed for VM: VmId: 1",
"status": "Success",
"errorMessage": "example error",
"snapshotDate": "2026-02-12T16:25:52.8467555Z",
"accountId": 1,
"isPublic": false,
"userId": 1,
"startTime": "2026-02-12T16:25:52.8467555Z",
"endTime": "2026-02-12T16:25:52.8467555Z",
"id": 1,
"createdDate": "2026-02-12T16:25:52.8467555Z",
"createdBy": "example user",
"modifiedDate": null,
"modifiedBy": null
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/agent-url": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns the Rubrik agent download URL",
"operationId": "AdvancedBackup_GetDownloadRubrikAgentBaseUrl",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
},
"examples": {
"application/json": "https://example.url/"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/availablelocation": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of active locations",
"operationId": "AdvancedBackup_GetActiveRubrikLocations",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.RubrikApplianceListDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"name": "example Rubrik Appliance name",
"url": "https://example.url/",
"description": "example Rubrik Appliance discription",
"version": "4",
"podId": 1,
"location": "example location",
"locationId": 1,
"replicationPodId": 1,
"replicationLocationData": [{
"replicationLocation": "example location",
"replicationLocationId": 1,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"id": 1,
"createdDate": "2026-02-12T16:25:52.6844464Z",
"createdBy": "example user",
"modifiedDate": null,
"modifiedBy": null
}, {
"replicationLocation": "example location",
"replicationLocationId": 1,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"id": 1,
"createdDate": "2026-02-12T16:25:52.6844464Z",
"createdBy": "example user",
"modifiedDate": null,
"modifiedBy": null
}]
}, {
"id": 2,
"name": "example Rubrik Appliance name",
"url": "https://example.url/",
"description": "example Rubrik Appliance discription",
"version": "4",
"podId": 2,
"location": "example location",
"locationId": 1,
"replicationPodId": 1,
"replicationLocationData": [{
"replicationLocation": "example location",
"replicationLocationId": 1,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"id": 1,
"createdDate": "0001-01-01T00:00:00",
"createdBy": null,
"modifiedDate": null,
"modifiedBy": null
}, {
"replicationLocation": "example location",
"replicationLocationId": 1,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"id": 1,
"createdDate": "0001-01-01T00:00:00",
"createdBy": null,
"modifiedDate": null,
"modifiedBy": null
}]
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/externalpolicies": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of policies",
"operationId": "AdvancedBackup_GetExternalSlaDomainList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.ExternalSlaDomainDto"
}
},
"examples": {
"application/json": [{
"rubrikSlaDomainId": 1,
"rubrikApplianceId": 1,
"timeunit": "Daily",
"name": "Test VM Policy",
"location": "example location",
"locationId": 1,
"slaDomainTypeId": 1,
"slaDomainTypeName": "VM Protection",
"frequencies": [{
"id": 0,
"frequency": 1,
"retention": 10,
"timeUnit": "Daily",
"createdDate": "2026-02-12T16:25:52.423189Z"
}, {
"id": 0,
"frequency": 1,
"retention": 10,
"timeUnit": "Monthly",
"createdDate": "2026-02-12T16:25:52.423189Z"
}],
"isCustomerDefault": false
}, {
"rubrikSlaDomainId": 2,
"rubrikApplianceId": 1,
"timeunit": "Daily",
"name": "Example policy name",
"location": "example location",
"locationId": 1,
"slaDomainTypeId": 1,
"slaDomainTypeName": "VM Protection",
"frequencies": [{
"id": 0,
"frequency": 1,
"retention": 10,
"timeUnit": "Daily",
"createdDate": "2026-02-12T16:25:52.423189Z"
}, {
"id": 0,
"frequency": 1,
"retention": 10,
"timeUnit": "Monthly",
"createdDate": "2026-02-12T16:25:52.423189Z"
}],
"isCustomerDefault": false
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/fileset/snapshot/{snapshotId}/browse": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of fileset snapshot files by snapshot id",
"operationId": "Fileset_BrowseFilesetFiles",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "snapshotId",
"in": "path",
"description": "Id of the snapshot",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "limit",
"in": "query",
"description": "total filesets to display",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "offset",
"in": "query",
"description": "Offset filesets number",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "path",
"in": "query",
"description": "filesets path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Rubrik.Response.BrowseFilesetFilesResponseDto"
},
"examples": {
"application/json": {
"hasMore": true,
"data": [{
"filename": "example file name",
"path": "\\example_path",
"lastModified": "0001-01-01T00:00:00",
"size": 123,
"fileMode": "example filemode",
"statusMessage": "status"
}, {
"filename": "example file name",
"path": "\\example_path",
"lastModified": "0001-01-01T00:00:00",
"size": 123,
"fileMode": "example filemode",
"statusMessage": "status"
}],
"osGroup": "example OS group",
"hostName": "example host name"
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/fileset/snapshot/{snapshotId}/restore_file": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Restores fileset snapshot files by snapshot id",
"operationId": "Fileset_RestoreFilesetFiles",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "snapshotId",
"in": "path",
"description": "Id of the snapshot",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Config: config containing DestinationDir and SourceDir paths",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RestoreFilesetRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/filesets": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Creates a new fileset",
"operationId": "Host_CreateFileSet",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "HostName: Host name
VmId: id of the VM
FileSets: list of filesets",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.CreateFileSetRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/filesets/{id}": {
"put": {
"tags": ["Advanced Backup"],
"summary": "Updates a fileset by id",
"operationId": "Host_UpdateHostFileSetById",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "HostId: id of the host
FileSetId: id of the fileset
PolicyId: Id of the policy",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "updateRequest",
"in": "body",
"description": "Request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.UpdateFileSetRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/fileset-template": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of fileset templates by page",
"description": "Get request URI contain the following query options\r\n
\r\n
\r\n$top (required): total number of results to display. Data Type: integer. Example: $top=25
$skip (required): skips the top number of results. Data Type: integer. Example: $skip=1
$filter (optional): filters down results. Data Type: string. Example: $filter=status%20eq%20%27Success%27%20and%20taskCategory%20eq%20%27null%27
$search (optional): search for specific result. Data Type: string. Example: $search=file%20restore
$orderby (optional): order by column name (name, location, operatingSystemType, hostCount). Data Type: string. Example: $orderby=startTime%20desc",
"operationId": "Host_GetFileSetTemplateList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FileSetTemplateListDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "example fileset template name",
"rubrikName": "example rubrik name",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"accountId": 1,
"isInternal": false,
"operatingSystemType": "Linux",
"hostCount": 1,
"createdBy": "example user",
"createdDate": "2026-02-12T16:25:53.1795217Z",
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00",
"location": "example location",
"isDeleted": false,
"include": "/usr/example",
"exclude": "/usr/example",
"doNotExclude": "/usr/example",
"userId": 0
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"post": {
"tags": ["Advanced Backup"],
"summary": "Creates a new fileset template",
"operationId": "Host_CreateFileSetTemplate",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "reqDto",
"in": "body",
"description": "Name: fileset template Name
\r\n LocationId: Id of the location
\r\n Include: list of file paths to inclue
\r\n Exclude: list of file paths to exclue
\r\n DoNotExclude: list of file paths to never exclue
\r\n OperatingSystemType: type of OperatingSystem
\r\n Etag: etag id
RubrikId: Guid id of Rubrik",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.FilesetTemplateRequestDetailstSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/fileset-template/{id}": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a fileset template by id",
"operationId": "Host_GetFileSetTemplate",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Fileset template Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FilesetTemplateResponseDetailsDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "example fileset template name",
"rubrikName": "exemple rubrik name",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"rubrikApplianceId": 1,
"primaryClusterId": "00000000-0000-0000-0000-000000000000",
"isInternal": false,
"accountId": 1,
"filesetTemplateShareType": "example fileset template share type",
"operatingSystemType": "Linux",
"hostCount": 2,
"allowBackupNetworkMounts": false,
"allowBackupHiddenFoldersInNetworkMounts": false,
"preBackupScript": "example prebackup script",
"postBackupScript": "example postbackup script",
"backupScriptTimeout": 0,
"backupScriptErrorHandling": "example backupscript error",
"isArchived": false,
"shareCount": 0,
"useWindowsVss": false,
"isDeleted": false,
"etag": "123abcdefghijklmnop",
"createdBy": "example user",
"createdDate": "2026-02-12T16:25:53.2272203Z",
"modifiedDate": null,
"modifiedBy": null,
"locationId": 1,
"include": ["/usr/example"],
"exclude": ["/usr/example"],
"doNotExclude": ["/usr/example"]
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"delete": {
"tags": ["Advanced Backup"],
"summary": "Deletes a fileset template by id",
"operationId": "Host_DeleteFileSetTemplate",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "FileSet Template Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"patch": {
"tags": ["Advanced Backup"],
"summary": "Updates a fileset template by id",
"operationId": "Host_UpdateFileSetTemplate",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Fileset template Id",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "reqDto",
"in": "body",
"description": "Name: fileset template Name
\r\n LocationId: Id of the location
\r\n Include: list of file paths to inclue
\r\n Exclude: list of file paths to exclue
\r\n DoNotExclude: list of file paths to never exclue
\r\n OperatingSystemType: type of OperatingSystem
\r\n Etag: etag id
\r\n RubrikId: Guid id of Rubrik",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.FilesetTemplateRequestDetailstSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/fileset-templates": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of all fileset templates",
"operationId": "Host_GetFileSetTemplateNames",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FileSetTemplateListDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"name": "example fileset template name",
"rubrikName": "example rubrik name",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"accountId": 1,
"isInternal": false,
"operatingSystemType": "Linux",
"hostCount": 0,
"createdBy": null,
"createdDate": "0001-01-01T00:00:00",
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00",
"location": "example location",
"isDeleted": false,
"include": "/usr/example",
"exclude": "/usr/example",
"doNotExclude": "/usr/example",
"userId": 0
}, {
"id": 2,
"name": "example fileset template name",
"rubrikName": "example rubrik name",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"accountId": 1,
"isInternal": false,
"operatingSystemType": "Linux",
"hostCount": 0,
"createdBy": null,
"createdDate": "0001-01-01T00:00:00",
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00",
"location": "example location",
"isDeleted": false,
"include": "/usr/example",
"exclude": "/usr/example",
"doNotExclude": "/usr/example",
"userId": 0
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of VMs eligible for fileset protection",
"description": "Get request URI contain the following query options\r\n
\r\n
\r\n$top (required): total number of results to display. Data Type: integer. Example: $top=25
$skip (required): skips the top number of results. Data Type: integer. Example: $skip=1
$filter (optional): filters down results. Data Type: string. Example: $filter=status%20eq%20%27Success%27%20and%20taskCategory%20eq%20%27null%27
$search (optional): search for specific result. Data Type: string. Example: $search=file%20restore
$orderby (optional): order by column name (name, location, status). Data Type: string. Example: $orderby=startTime%20desc",
"operationId": "Host_GetRubrikHosts",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "example name",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"agentId": "00000000-0000-0000-0000-000000000000",
"vmId": 1,
"vmName": "example vm name",
"ipAddress": "197.168.1.1",
"location": "example location",
"osName": "example os name",
"status": "status",
"fileSetsCsv": "file set name",
"policiesCsv": "policy name",
"localStorageCsv": "local storeage name",
"fileSets": ["example fileset"],
"policies": [{
"policyId": 1,
"policyName": "example policy1"
}, {
"policyId": 2,
"policyName": "example policy2"
}],
"totalStorage": 0,
"applianceUrl": "\\example.url\\",
"applianceCredentialId": "example credential Id",
"rubrikApplianceId": 1,
"primaryClusterId": "00000000-0000-0000-0000-000000000000",
"osId": 1,
"accountId": 1,
"userId": "example user",
"localUsageCsv": "example local useage",
"localUsage": 0,
"localArchiveUsage": 0,
"replicationArchiveUsage": 0,
"replicationUsageCsv": "replcation usage name",
"replicationUsage": 0,
"storageUsed": 0
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"post": {
"tags": ["Advanced Backup"],
"summary": "Makes a VM eligible for fileset protection by VM id",
"operationId": "Host_AddHost",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "hostRequest",
"in": "body",
"description": "VmId: id of the VM",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.AddRubrikHostRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "example name",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"agentId": "00000000-0000-0000-0000-000000000000",
"vmId": 1,
"vmName": "example vm name",
"ipAddress": "197.168.1.1",
"location": "example location",
"osName": "example os name",
"status": "status",
"fileSetsCsv": "file set name",
"policiesCsv": "policy name",
"localStorageCsv": "local storeage name",
"fileSets": ["example fileset"],
"policies": [{
"policyId": 1,
"policyName": "example policy1"
}, {
"policyId": 2,
"policyName": "example policy2"
}],
"totalStorage": 0,
"applianceUrl": "\\example.url\\",
"applianceCredentialId": "example credential Id",
"rubrikApplianceId": 1,
"primaryClusterId": "00000000-0000-0000-0000-000000000000",
"osId": 1,
"accountId": 1,
"userId": "example user",
"localUsageCsv": "example local useage",
"localUsage": 0,
"localArchiveUsage": 0,
"replicationArchiveUsage": 0,
"replicationUsageCsv": "replcation usage name",
"replicationUsage": 0,
"storageUsed": 0
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts/{id}": {
"delete": {
"tags": ["Advanced Backup"],
"summary": "Removes a VM from fileset protection eligibility by VM id",
"operationId": "Host_DeleteFileSetProtection",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "FileSet Template Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts/{id}/filesets": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of filesets by VM id",
"operationId": "Host_GetFilesetsByHostId",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Rubrik Host Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FilesetsListDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"rubrikApplianceId": 1,
"name": "example name",
"configuredSlaDomainId": 1,
"effectiveSlaDomainId": 1,
"fileSetTemplateId": 1,
"storageUsed": 0,
"policyId": 1,
"policyName": "example policy name",
"hostId": 12,
"vmName": "example vm name",
"include": ["/usr/example"],
"location": "example location",
"osFamily": "Linux",
"localUsage": 0,
"archiveUsage": 0,
"replicationUsage": 0,
"replicationArchiveUsage": 0,
"totalStorageUsed": 0
}, {
"id": 1,
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"rubrikApplianceId": 1,
"name": "example name",
"configuredSlaDomainId": 1,
"effectiveSlaDomainId": 1,
"fileSetTemplateId": 1,
"storageUsed": 0,
"policyId": 1,
"policyName": "example policy name",
"hostId": 12,
"vmName": "example vm name",
"include": ["/usr/example"],
"location": "example location",
"osFamily": "Linux",
"localUsage": 0,
"archiveUsage": 0,
"replicationUsage": 0,
"replicationArchiveUsage": 0,
"totalStorageUsed": 0
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts/{id}/overview": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns fileset overview by VM id",
"operationId": "Host_GetFilesetsOverviewByHostId",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Rubrik Host Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostOverviewDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "example fileset name",
"vmName": "example VM name",
"ipAddress": "192.168.1.1",
"location": "example location",
"osName": "CentOS 7.1",
"status": "example status",
"filesets": 1,
"totalLocalUsage": 45645645645,
"totalArchiveUsage": 2,
"osFamily": "Linux",
"vmId": 1,
"totalReplicationUsage": 34543534,
"totalReplicationArchiveUsage": 4543534,
"storageUsed": 45684732715
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts/{id}/snapshots": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of fileset snapshots by VM id for a specific time frame",
"operationId": "Host_GetFilesetsSnapshotByHostId",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "StartDate: seleted start date in UTC
EndDate: seleted end date in UTC",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.HostDetailsByIdRequestSample"
}
}, {
"name": "id",
"in": "path",
"description": "Rubrik Host Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostSnapshotDto"
},
"examples": {
"application/json": {
"id": 1,
"rubrikSnapshotId": "00000000-0000-0000-0000-000000000000",
"filesetName": "example fileset name",
"snapshotDate": "2026-02-12T16:25:53.7993473Z",
"filesetId": 1,
"rubrikFilesetId": "00000000-0000-0000-0000-000000000000",
"fileCount": 10
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts/{id}/syncsnapshots": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Refresh list of fileset snapshots by VM id",
"operationId": "Host_SyncFilesetSnapshotByHostId",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Host Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/hosts/fileset/{id}": {
"delete": {
"tags": ["Advanced Backup"],
"summary": "Deletes a fileset by id",
"operationId": "Host_RemoveFilesetById",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "FileSetId: id of the fileset
\r\n RubrikId: Guid id of Rubrik
\r\n RubrikApplianceId: id of the Rubrik Appliance
\r\n PreserveSnapshots: Preserve Snapshots bool",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RemoveFilesetByIdRequestSample"
}
}, {
"name": "id",
"in": "path",
"description": "Id of the Fileset",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Data.Domain.FileSet"
},
"examples": {
"application/json": {
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"name": "example fileset name",
"rubrikHostId": "example rurik host id",
"configureSlaDomainId": 12,
"effectiveSlaDomainId": 12,
"fileSetTemplateId": 1,
"accountId": 2,
"rubrikApplianceId": 1,
"localStorage": 0,
"archiveStorage": 0,
"hostId": 1,
"vmName": "example vm name",
"location": "example location",
"osFamily": "Linux",
"localUsage": 0,
"replicationUsage": 0,
"replicationArchiveUsage": 0,
"id": 1,
"createdDate": "2026-02-12T16:25:53.4558658Z",
"createdBy": "example user",
"modifiedDate": null,
"modifiedBy": null
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/overview/historicstorageusage": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Returns Vm Historical Physical Usage datas for the given date range",
"operationId": "Dashboard_GetAllVmHistoricalPhysicalStorageData",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.VmHistoricalUsageRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.VmHistoricalPhysicalStorageUsageDto"
}
},
"examples": {
"application/json": [{
"createdDate": "2026-02-11T16:25:51.8655281+00:00",
"physicalStorage": 435345345345,
"historicalIngestedStorage": 4564564564
}, {
"createdDate": "2026-02-10T16:25:51.8655281+00:00",
"physicalStorage": 434345345345,
"historicalIngestedStorage": 4564564564
}, {
"createdDate": "2026-02-09T16:25:51.8655281+00:00",
"physicalStorage": 433345345345,
"historicalIngestedStorage": 4564564564
}, {
"createdDate": "2026-02-08T16:25:51.8655281+00:00",
"physicalStorage": 435345345345,
"historicalIngestedStorage": 4564564564
}]
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/overview/vms": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Returns Vm Historical overview details for the given date range",
"operationId": "Dashboard_GetAllVmsHistoricalOverview",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.GetVmsHistoricalOverviewRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.VmHistoricalOverviewDto"
}
},
"examples": {
"application/json": [{
"vmName": "VM Name 1",
"vmId": 1
}, {
"vmName": "VM Name 2",
"vmId": 2
}, {
"vmName": "VM Name 3",
"vmId": 3
}, {
"vmName": "VM Name 4",
"vmId": 4
}]
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/policies": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of policies",
"description": "Get request URI contain the following query options\r\n
\r\n
\r\n$top (required): total number of results to display. Data Type: integer. Example: $top=25
$skip (required): skips the top number of results. Data Type: integer. Example: $skip=1
$filter (optional): filters down results. Data Type: string. Example: $filter=location%20eq%20%27null%27%20and%20slaDomainTypeName%20eq%20%27Fileset%20Protection%27
$search (optional): search for specific result. Data Type: string. Example: $search=file%20restore
$orderby (optional): order by column name (name, location, isReplicationEnabled, slaDomainTypeName, default). Data Type: string. Example: $orderby=startTime%20desc",
"operationId": "AdvancedBackup_GetBackupPoliciesList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.AdvancedBackup.Models.PoliciesListDto%5D"
},
"examples": {
"application/json": {
"id": 1,
"name": "example plan name",
"frequencies": [{
"id": 0,
"frequency": 3,
"retention": 72,
"timeUnit": "Hourly",
"createdDate": "2026-02-12T16:25:51.9907771+00:00"
}, {
"id": 0,
"frequency": 3,
"retention": 72,
"timeUnit": "Daily",
"createdDate": "2026-02-12T16:25:51.9907771+00:00"
}],
"assets": 1,
"isInternal": false,
"location": "example location",
"slaDomainTypeId": 1,
"slaDomainTypeName": "VM Protection",
"isReplicationEnabled": false,
"offsiteRetention": 0,
"isActive": 1,
"isCustomerDefault": true
}
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"post": {
"tags": ["Advanced Backup"],
"summary": "Creates a new policy",
"operationId": "AdvancedBackup_CreateAdvancedBackupPolicies",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "requestDto",
"in": "body",
"description": "Name: Policy Name
\r\n Frequencies: List of Frequencies
\r\n FirstFullAllowedBackupWindows: List of Allowed Backup Windows
\r\n IsInternal: Is internal
SlaDomainTypeId: Id of the Sla Doamin Type
\r\n IsReplicationEnabled: Allow replation
\r\n RetentionLimit: How long to Retain
\r\n IsCustomerDefault: Is account default",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.BackupPolicyRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.AdvancedBackup.Models.BackupPolicyRequestDto%5D"
},
"examples": {
"application/json": {
"accountId": 3,
"id": 5,
"name": "New Policy Name",
"frequencies": [{
"id": 0,
"frequency": 3,
"retention": 72,
"timeUnit": "Hourly",
"createdDate": "2026-02-12T16:25:52.0881481+00:00"
}, {
"id": 0,
"frequency": 3,
"retention": 72,
"timeUnit": "Daily",
"createdDate": "2026-02-12T16:25:52.0881481+00:00"
}],
"firstFullAllowedBackupWindows": [{
"startTimeAttributes": {
"id": 1,
"minutes": 0,
"hour": 5,
"dayOfWeek": 3
},
"durationInHours": 48,
"isFirstFullBackupWindow": true,
"createdDate": "2026-02-12T16:25:52.0881481+00:00"
}],
"allowedBackupWindows": null,
"createdBy": "user email@armor.com",
"locationId": 1,
"podId": 1,
"userId": 1,
"isInternal": false,
"etag": "123abcdefghijklmnop",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"slaDomainTypeId": 444,
"typeCode": 0,
"isReplicationEnabled": true,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"retentionLimit": 0,
"isCustomerDefault": false
}
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/policies/{id}": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a policy by id",
"operationId": "AdvancedBackup_GetBackupPolicyById",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.BackupPolicyResponse"
},
"examples": {
"application/json": {
"name": "example policy name",
"totalDbs": 0,
"totalFilesets": 0,
"totalVms": 2,
"rubrikId": "00000000-0000-0000-0000-000000000000",
"rubrikCloudId": null,
"rubrikApplianceId": 1,
"isInternal": false,
"primaryClusterId": "00000000-0000-0000-0000-000000000000",
"isDeleted": false,
"etag": "123abcdefghijklmnop",
"etagString": "example etag string",
"isDefault": false,
"accountId": 4211,
"rubrikName": "example rubrik name",
"frequencies": [{
"id": 0,
"frequency": 3,
"retention": 72,
"timeUnit": "Hourly",
"createdDate": "2026-02-12T16:25:52.1929848+00:00"
}, {
"id": 0,
"frequency": 3,
"retention": 72,
"timeUnit": "Daily",
"createdDate": "2026-02-12T16:25:52.1929848+00:00"
}],
"backupWindows": [{
"id": 1,
"minutes": 0,
"hour": 1,
"dayOfWeek": 2,
"durationInHours": 123,
"isFirstFullBackupWindow": true
}, {
"id": 1,
"minutes": 0,
"hour": 1,
"dayOfWeek": 2,
"durationInHours": 123,
"isFirstFullBackupWindow": true
}],
"allowedBackupWindows": null,
"locationId": 1,
"podId": 1,
"userId": 0,
"totalSlaInUse": 1,
"slaDomainTypeId": 1,
"slaDomainTypeName": "VM Protection",
"typeCode": 0,
"isAssignedToMultipleAccount": false,
"mappedAccountId": 0,
"isReplicationEnabled": false,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"retentionLimit": 0,
"isCustomerDefault": false,
"id": 1,
"createdDate": "2026-02-12T16:25:52.1929848Z",
"createdBy": "example user",
"modifiedDate": null,
"modifiedBy": null
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"delete": {
"tags": ["Advanced Backup"],
"summary": "Deletes a policy by id",
"operationId": "AdvancedBackup_DeleteAdvancedBackupPolicies",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"409": {
"description": "Conflict"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"patch": {
"tags": ["Advanced Backup"],
"summary": "Updates a policy by id",
"operationId": "AdvancedBackup_UpdateBackupPolicy",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Policy Id",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "reqDto",
"in": "body",
"description": "Name: Policy Name
\r\n Frequencies: lit of backup frequencies
\r\n FirstFullAllowedBackupWindows: list of first full allowed backup windows
\r\n AllowedBackupWindows: list of allowed backup windows
LocationId: Id of the location
\r\n IsInternal: internal flag
Etag: etag id
\r\n RubrikId: Guid id of Rubrik
\r\n SlaDomainTypeId: Id for the type of Sla Domain
\r\n IsReplicationEnabled: replication allow flag
\r\n ReplicationClusterId: Guid id of the Replication Cluster
\r\n RetentionLimit: limit of Retention count
\r\n IsCustomerDefault: is Customer Default bool",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.BackupPolicyRequestDtoSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/policies/default": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of default policies",
"operationId": "AdvancedBackup_GetDefaultBackupPolicyForAccount",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.DefaultPolicyForAccountDto"
}
},
"examples": {
"application/json": [{
"isDefaultExist": false,
"locationId": 1,
"location": "example location",
"podId": 1,
"rubrikApplianceId": 1
}, {
"isDefaultExist": false,
"locationId": 2,
"location": "example location",
"podId": 2,
"rubrikApplianceId": 2
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/policies/types": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of policy types",
"operationId": "AdvancedBackup_GetSlaDomainTypes",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Data.Domain.RubrikSlaDomainType"
}
},
"examples": {
"application/json": [{
"id": 1,
"name": "Example Name"
}, {
"id": 2,
"name": "Example Name"
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/policy/default/{locationId}": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns the default policy by location id",
"operationId": "AdvancedBackup_GetDefaultPolicy",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "locationId",
"in": "path",
"description": "Id of a location",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "accountId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.DefaultPolicyDto"
},
"examples": {
"application/json": {
"policyId": 1,
"policyName": "eample Policy name",
"frequency": 0,
"retention": 5,
"timeUnit": "Hourly",
"isDefault": true,
"accountId": 1,
"podId": 1,
"location": "example location"
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/unregistered-hosts": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of VMs not registered with the Rubrik agent",
"operationId": "Host_GetUnRegisteredRubrikHosts",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.VmDetailDto"
}
},
"examples": {
"application/json": [{
"vmId": 5,
"vmName": "example vm name",
"ipAddress": "197.168.1.1",
"location": "example location",
"osFamily": "Linux"
}, {
"vmId": 0,
"vmName": "example vm name",
"ipAddress": "197.168.1.2",
"location": "example location",
"osFamily": "Linux"
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vm/{vmId}/policy": {
"put": {
"tags": ["Advanced Backup"],
"summary": "Updates a policy for a protected VM by VM id",
"operationId": "AdvancedBackup_UpdateVmPolicy",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "SlaDomainId: Id of the Sla Domain
VmId: id of the VM",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.UpdateVmPolicyRequestSample"
}
}, {
"name": "vmId",
"in": "path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vm/{vmId}/protected": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns VM protection overview by VM id",
"operationId": "AdvancedBackup_GetProtectedVmById",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.ProtectedVmDetailDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "example vm name",
"podId": 1,
"location": "example location",
"locationId": 1,
"rubrikSlaDomainId": 1
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{id}/snapshots": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of snapshots for a protected VM for a specific time frame",
"operationId": "AdvancedBackup_GetVmSnapShots",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "VmId",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "snapShotRequestDto",
"in": "body",
"description": "StartDate: seleted start date in UTC
EndDate: seleted end date in UTC",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.SnapshotRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.SnapShotDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"snapshotId": "00000000-0000-0000-0000-000000000000",
"vmName": "example Vm Name",
"slaName": null,
"snapshotDate": "2026-02-12T16:25:52.2707579Z",
"snapshotExpiryDate": "9999-12-31T23:59:59.9999999",
"isOnDemandSnapshot": true,
"isDeleted": false,
"slaDomainId": "example slaDomain Id",
"isCorrupted": false
}, {
"id": 1,
"snapshotId": "00000000-0000-0000-0000-000000000000",
"vmName": "Vm example",
"slaName": null,
"snapshotDate": "2026-02-12T16:25:52.2707579Z",
"snapshotExpiryDate": "9999-12-31T23:59:59.9999999",
"isOnDemandSnapshot": true,
"isDeleted": false,
"slaDomainId": "example slaDomain Id",
"isCorrupted": false
}]
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/cancelbackuprestore": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Cancels a VM snapshot restore by VM id",
"operationId": "AdvancedBackup_CancelBackupRestore",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "SagaId: Guid Id of the Saga
\r\n CustomerCommitted: Customer submited bool
\r\n SnapshotId: Guid Id of the snapshot
\r\n StatusDescription: Description of the snapshot",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.SnapshotRestoreActionRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/register-agent": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Registers VM with the Rubrik agent by VM id",
"operationId": "AdvancedBackup_RegisterAgent",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.RegisterAgentRequestDto"
},
"examples": {
"application/json": {
"vmId": 1,
"accountId": 1,
"modifiedBy": "example user"
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/restoresnapshot": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Begin a VM snapshot restore by VM id",
"operationId": "AdvancedBackup_ValidateRestoreVmSnapshotDetails",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "SnapshotId: Guid Id of the snapshot",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RestoreVmSnapshotRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/snapshot/{snapshotId}/browse": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of VM snapshot files by snapshot id",
"operationId": "AdvancedBackup_BrowseFiles",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of a VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "snapshotId",
"in": "path",
"description": "Id of a snapshot",
"required": true,
"type": "string"
}, {
"name": "limit",
"in": "query",
"description": "Number of records in page",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "offset",
"in": "query",
"description": "Offset number of records in page",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "path",
"in": "query",
"description": "Location of the file",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Rubrik.Response.BrowseFilesResponseDto"
},
"examples": {
"application/json": {
"hasMore": true,
"data": [{
"filename": "example file name",
"path": "\\example_path",
"lastModified": "2026-02-12T16:25:52.7737009Z",
"size": 123,
"fileMode": "example file mode",
"statusMessage": "status"
}, {
"filename": "example file name",
"path": "\\example_path",
"lastModified": "2026-02-12T16:25:52.7737009Z",
"size": 123,
"fileMode": "example file mode",
"statusMessage": "status"
}]
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/snapshot/{snapshotid}/restore_file": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Restores VM snapshot files by snapshot id",
"operationId": "AdvancedBackup_RestoreFile",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "snapshotid",
"in": "path",
"description": "Id of the snapshot",
"required": true,
"type": "string"
}, {
"name": "requeDto",
"in": "body",
"description": "SourcePath: path of the source
DestinationPath: path of the destination",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RestoreVmFileSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/snapshotrestoreaction": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Commits a VM snapshot restore by VM id",
"operationId": "AdvancedBackup_SnapshotRestoreAction",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "SagaId: Guid Id of the Saga
\r\n CustomerCommitted: Customer submited bool
\r\n SnapshotId: Guid Id of the snapshot
\r\n StatusDescription: Description of the snapshot",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.SnapshotRestoreActionRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/storage": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Get the backup details of the VM's storage (Disks)",
"operationId": "AdvancedBackup_GetBackupVmStorageDetails",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": ""
},
"examples": {
"application/json": {
"vmId": 1,
"accountId": 1,
"accountName": "Example Account",
"disks": [{
"diskId": 1,
"name": "Disk 1",
"nameId": "Hard disk 1",
"isBackupEnabled": true,
"size": 30720,
"isRubrikDiscovered": true
}, {
"diskId": 2,
"name": "Disk 2",
"nameId": "Hard disk 2",
"isBackupEnabled": false,
"size": 30720,
"isRubrikDiscovered": false
}]
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"post": {
"tags": ["Advanced Backup"],
"summary": "Update the back up details of the VM's storage (disks)",
"operationId": "AdvancedBackup_UpdateBackupVmStorageDetails",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "protectedVmRequestDto",
"in": "body",
"description": "VmId: Id of the VM
\r\n Disks: Disks for which back up details should be updated",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.UpdateBackupVmStorageDetailsRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/{vmId}/syncsnapshots": {
"post": {
"tags": ["Advanced Backup"],
"summary": "Refresh list of VM snapshots by VM id",
"operationId": "AdvancedBackup_ExecuteSyncSnapshot",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "Virtual machine Id to sync the snapshots",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Data.Domain.VmRubrikDetailDto"
},
"examples": {
"application/json": {
"rubrikApplianceId": 1,
"vmId": 98741,
"isEnabled": true,
"lastBackupDate": "2026-02-12T16:25:52.3599011Z",
"isDeleted": false,
"userName": "example user",
"applianceUrl": "https://example.url/",
"applianceCredentialId": "00000000-0000-0000-0000-000000000000",
"rubrikVmId": "example RubrikVmId",
"clusterUuId": null,
"location": "example location",
"isAgentRegistered": true,
"vsphereVmName": null,
"id": 0,
"createdDate": "2026-02-12T16:25:52.3599011Z",
"createdBy": "example user",
"modifiedDate": null,
"modifiedBy": null
}
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/backup/vms/services": {
"get": {
"tags": ["Advanced Backup"],
"summary": "Returns a list of unprotected VMs",
"operationId": "AdvancedBackup_GetUnprotectedVmsList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.UnprotectedVmsDetailDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"name": "VM name",
"memory": 2,
"storage": 3,
"podId": 1,
"location": "example location",
"locationId": 1,
"disks": null,
"createdDate": "0001-01-01T00:00:00",
"createdBy": null,
"modifiedDate": null,
"modifiedBy": null
}, {
"id": 2345,
"name": "VM name",
"memory": 2,
"storage": 3,
"podId": 1,
"location": "example location",
"locationId": 1,
"disks": null,
"createdDate": "0001-01-01T00:00:00",
"createdBy": null,
"modifiedDate": null,
"modifiedBy": null
}]
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"post": {
"tags": ["Advanced Backup"],
"summary": "Subscribes a list of VMs to VM protection",
"operationId": "AdvancedBackup_AssignVmsToSlaDomain",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "LocationId: Id of the location
SlaDomainId: Id of the Sla Domain
VmIds: list of Vm Ids",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.AdvancedBackup.ApiExample.Models.UnprotectedVmsRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/groups": {
"get": {
"tags": ["Network Services"],
"summary": "Get information about firewall groups in your account. These groups define the individual IPs, IP ranges, and/or subnets to be used as sources and destinations in firewall rules.",
"operationId": "Groups_GetGroups",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Groups.GroupDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"deviceId": 2,
"name": "ANY",
"description": "The CIDR 0.0.0.0/0 represents ANY Ip, range, or CIDR.",
"type": "any",
"values": ["0.0.0.0/0"],
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0,
"isDefaultGroupCopied": false
}, {
"id": 2,
"deviceId": 2,
"name": "SSL VPN (100-127-255-192--026)",
"description": "SSL VPN for CIDR",
"type": "group",
"values": ["100.127.255.192/26"],
"isReadonly": true,
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0,
"isDefaultGroupCopied": false
}]
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
},
"post": {
"tags": ["Network Services"],
"summary": "Create a firewall group.",
"operationId": "Groups_CreateGroup",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "groupDto",
"in": "body",
"description": "deviceId: id for the device to retrieve rules
name: Name of the firewall group
values: Array of network addresses
description: Description for the firewall group",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.CreateGroupSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Groups.GroupDto"
}
},
"examples": {
"application/json": [{
"id": 1,
"deviceId": 2,
"name": "ANY",
"description": "The CIDR 0.0.0.0/0 represents ANY Ip, range, or CIDR.",
"type": "any",
"values": ["0.0.0.0/0"],
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0,
"isDefaultGroupCopied": false
}, {
"id": 2,
"deviceId": 2,
"name": "SSL VPN (100-127-255-192--026)",
"description": "SSL VPN for CIDR",
"type": "group",
"values": ["100.127.255.192/26"],
"isReadonly": true,
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0,
"isDefaultGroupCopied": false
}]
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/groups/{id}": {
"get": {
"tags": ["Network Services"],
"summary": "Get details for a specific firewall group.",
"operationId": "Groups_GetGroup",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "id",
"in": "path",
"description": "id for the firewall group",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Groups.GroupDto"
}
},
"examples": {
"application/json": {
"id": 8,
"deviceId": 2,
"name": "Local IP",
"description": "",
"type": "group",
"values": ["192.158.1.1"],
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0,
"isDefaultGroupCopied": false
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"put": {
"tags": ["Network Services"],
"summary": "Update details for a specific firewall group.",
"operationId": "Groups_UpdateGroup",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "id",
"in": "path",
"description": "id for the firewall group",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "groupDto",
"in": "body",
"description": "deviceId: id for the device to retrieve rules
id: id for the firewall group
name: Name of the firewall group
description: Description for the firewall group
values: Array of network addresses",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.UpdateGroupByIdSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Groups.GroupDto"
}
},
"examples": {
"application/json": {
"id": 8,
"deviceId": 2,
"name": "Local IP",
"description": "",
"type": "group",
"values": ["192.158.1.1"],
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0,
"isDefaultGroupCopied": false
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "No Content"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Delete a firewall group.",
"operationId": "Groups_DeleteGroup",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "id",
"in": "path",
"description": "id of the firewall group to delete",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "Accepted"
},
"400": {
"description": "Validation Error"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/rule": {
"post": {
"tags": ["Network Services"],
"summary": "Creates an individual firewall rule for a given device.",
"operationId": "Firewall_CreateIndividualRule",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to create rule for",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "rule",
"in": "body",
"description": "rule entity
destinations:List of destination IPgroups(Should not have duplicate IPgroups in a rule)
sources:List of source IPgroups (Should not have duplicate IPgroups in a rule)
services: List of service groups
action:specify either allow or block
SortOrder: sort order of the rule.
IsEnabled:specify whether a rule needs to be enabled or disabled (true/false)",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.CreateRuleSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "No content"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/rule/{ruleId}": {
"get": {
"tags": ["Network Services"],
"operationId": "Firewall_GetFirewallRuleById",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "ruleId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Rules.RuleSet"
},
"examples": {
"application/json": {
"id": 1,
"deviceId": 2,
"accountId": 2,
"rules": [{
"id": 1,
"destinations": [{
"type": "any",
"id": 1,
"name": "ANY",
"joinedValues": null,
"values": [],
"isReadOnly": false
}],
"sources": [{
"type": "any",
"id": 1,
"name": "ANY",
"joinedValues": null,
"values": [],
"isReadOnly": false
}],
"services": [{
"id": 1,
"deviceId": 2,
"location": null,
"accountId": 2,
"name": "HTTP",
"description": null,
"values": [{
"port": 80,
"protocol": "tcp",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"ruleId": 0,
"status": 0,
"retryCount": 0,
"isRetry": false,
"joinedValues": "tcp/80, udp/21",
"concattedValues": ["tcp/80, udp/21"],
"isReadOnly": false,
"isDefaultGroupCopied": false
}],
"action": "allow",
"name": "VMA Web Traffic",
"description": null,
"sortOrder": 1,
"isEnabled": true,
"status": 0,
"retryCount": 0,
"providerRefId": 1067
}],
"batchId": "00000000-0000-0000-0000-000000000000",
"staged": true,
"lastModified": "2015-12-13T02:31:33.53",
"status": null,
"vcdOrgVdcId": 0
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"put": {
"tags": ["Network Services"],
"summary": "Update/Retry an individual firewall rule based on rule id for a given device.",
"operationId": "Firewall_UpdateIndividualRule",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id of the device to update rules",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "ruleId",
"in": "path",
"description": "rule id for which rule needs to be updated",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "rule",
"in": "body",
"description": "rule entity with modifications
FirewallRuleAction : Specify update to update the individual rule or retry to retry the firewall rule
destinations:List of destination IPgroups(Should not have duplicate IPgroups in a rule)
sources:List of source IPgroups (Should not have duplicate IPgroups in a rule)
services: List of service groups
action:specify either allow or block
SortOrder: sort order of the rule.
IsEnabled:specify whether rule is enabled or disabled",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.UpdateIndividualRuleSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "No content"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/rules": {
"get": {
"tags": ["Network Services"],
"summary": "Retrieve firewall rules for a orginaztion Vdc.",
"operationId": "Firewall_GetRuleSet",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Firewall.Models.Rules.RuleSet%5D"
},
"examples": {
"application/json": {
"id": 1,
"deviceId": 2,
"accountId": 2,
"rules": [{
"id": 1,
"destinations": [{
"type": "any",
"id": 1,
"name": "ANY",
"joinedValues": null,
"values": [],
"isReadOnly": false
}],
"sources": [{
"type": "any",
"id": 1,
"name": "ANY",
"joinedValues": null,
"values": [],
"isReadOnly": false
}],
"services": [{
"id": 1,
"deviceId": 2,
"location": null,
"accountId": 2,
"name": "HTTP",
"description": null,
"values": [{
"port": 80,
"protocol": "tcp",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"ruleId": 0,
"status": 0,
"retryCount": 0,
"isRetry": false,
"joinedValues": "tcp/80, udp/21",
"concattedValues": ["tcp/80, udp/21"],
"isReadOnly": false,
"isDefaultGroupCopied": false
}],
"action": "allow",
"name": "VMA Web Traffic",
"description": null,
"sortOrder": 1,
"isEnabled": true,
"status": 0,
"retryCount": 0,
"providerRefId": 1067
}],
"batchId": "00000000-0000-0000-0000-000000000000",
"staged": true,
"lastModified": "2015-12-13T02:31:33.53",
"status": null,
"vcdOrgVdcId": 0
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/rules/export": {
"get": {
"tags": ["Network Services"],
"summary": "Retrieve firewall rules for a orginaztion Vdc for csv export.",
"operationId": "Firewall_GetFirewallRuleCsvExport",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Firewall.Models.Rules.RuleSet%5D"
},
"examples": {
"application/json": {
"id": 1,
"deviceId": 2,
"accountId": 2,
"rules": [{
"id": 1,
"destinations": [{
"type": "any",
"id": 1,
"name": "ANY",
"joinedValues": null,
"values": [],
"isReadOnly": false
}],
"sources": [{
"type": "any",
"id": 1,
"name": "ANY",
"joinedValues": null,
"values": [],
"isReadOnly": false
}],
"services": [{
"id": 1,
"deviceId": 2,
"location": null,
"accountId": 2,
"name": "HTTP",
"description": null,
"values": [{
"port": 80,
"protocol": "tcp",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"ruleId": 0,
"status": 0,
"retryCount": 0,
"isRetry": false,
"joinedValues": "tcp/80, udp/21",
"concattedValues": ["tcp/80, udp/21"],
"isReadOnly": false,
"isDefaultGroupCopied": false
}],
"action": "allow",
"name": "VMA Web Traffic",
"description": null,
"sortOrder": 1,
"isEnabled": true,
"status": 0,
"retryCount": 0,
"providerRefId": 1067
}],
"batchId": "00000000-0000-0000-0000-000000000000",
"staged": true,
"lastModified": "2015-12-13T02:31:33.53",
"status": null,
"vcdOrgVdcId": 0
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/services": {
"get": {
"tags": ["Network Services"],
"summary": "Get information about firewall services in your account. These services define the ports and protocols to be used as service groups in firewall rules, to determine the type of traffic being allowed or blocked.",
"operationId": "Services_GetServices",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to retrieve rules",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": [{
"id": 4,
"deviceId": 2,
"location": "DFW01",
"accountId": 0,
"name": "HTTP",
"description": "",
"values": [{
"port": 80,
"protocol": "TCP",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"ruleId": 0,
"status": 0,
"retryCount": 0,
"isRetry": false,
"joinedValues": "tcp/80,udp/21",
"concattedValues": ["tcp/80", "udp/21"],
"isReadOnly": false,
"isDefaultGroupCopied": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"post": {
"tags": ["Network Services"],
"summary": "Create firewall service groups.",
"description": "Protocol must be entered in lower-case letters",
"operationId": "Services_CreateService",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to under which service needs to be created",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "serviceDto",
"in": "body",
"description": "name: Name for the service group
\r\n values: Array of ServiceValue objects
\r\n description: Description of the service group
\r\n location: Name of the location",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.CreateServiceSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceCreatedDto"
}
},
"examples": {
"application/json": {
"id": 5,
"deviceId": 2,
"location": "DFW01",
"accountId": 0,
"name": "TCP HTTP",
"description": "",
"values": [{
"port": 80,
"protocol": "TCP",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"ruleId": 0,
"status": 0,
"retryCount": 0,
"isRetry": false,
"joinedValues": "tcp/80,udp/21",
"concattedValues": ["tcp/80", "udp/21"],
"isReadOnly": false,
"isDefaultGroupCopied": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/firewall/{ovdcId}/services/{serviceGroupId}": {
"get": {
"tags": ["Network Services"],
"summary": "Get details about a specific firewall service group.",
"operationId": "Services_GetService",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "Device ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "serviceGroupId",
"in": "path",
"description": "Firewall Service Group ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": [{
"id": 4,
"deviceId": 2,
"location": "DFW01",
"accountId": 0,
"name": "HTTP",
"description": null,
"values": [{
"port": 80,
"protocol": "TCP",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"ruleId": 0,
"status": 0,
"retryCount": 0,
"isRetry": false,
"joinedValues": "tcp/80,udp/21",
"concattedValues": ["tcp/80", "udp/21"],
"isReadOnly": false,
"isDefaultGroupCopied": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Network Services"],
"summary": "Update the details for a firewall service group.",
"operationId": "Services_UpdateService",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to update service for",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "serviceGroupId",
"in": "path",
"description": "id of the service group",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "serviceDto",
"in": "body",
"description": "id: Service Group ID (not used)
\r\n deviceId: id for the device to update rules (not used)
\r\n location: Name of the location
\r\n accountId: Account ID (not used)
\r\n name: The name of the service group
\r\n description: Description of the service group
\r\n values: Array of ServiceValue objects",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.UpdateServiceSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceUpdatedDto"
}
},
"examples": {
"application/json": {
"id": 4,
"deviceId": 2,
"location": "DFW01",
"name": "HTTP",
"description": "Use this for inbound HTTP traffic",
"values": [{
"port": 80,
"protocol": "tcp",
"subprotocol": null,
"isConsistent": false
}],
"vcdOrgVdcId": 0,
"status": 0,
"retryCount": 0
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Delete a firewall service group.",
"operationId": "Services_DeleteService",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ovdcId",
"in": "path",
"description": "id for the device to delete services for",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "serviceGroupId",
"in": "path",
"description": "id of the service group",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/firewall/rules/{ruleId}": {
"put": {
"tags": ["Network Services"],
"summary": "Enables/Disables a firewall rule.",
"operationId": "Firewall_EnableDisableFirewallRule",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ruleId",
"in": "path",
"description": "Unique firewall ruleId",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "disabled",
"in": "query",
"description": "Boolean value indicating if rule needs to be disabled or enabled as a query string parameter",
"required": true,
"type": "boolean"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "no content"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal ServerError"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Deletes a firewall rule with specified ruleid.",
"operationId": "Firewall_DeleteRule",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ruleId",
"in": "path",
"description": "firewall rule Id which needs to be deleted",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "No content"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/firewalls": {
"get": {
"tags": ["Network Services"],
"summary": "Get information about firewall devices in your account environments.",
"operationId": "Firewall_GetFirewalls",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.FirewallDeviceDto"
}
},
"examples": {
"application/json": [{
"id": 2,
"name": "DFW01-VC01",
"location": "DFW01",
"vcdOrgVdcId": 0
}]
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"404": {
"description": "No content"
}
},
"deprecated": false
}
},
"/health-monitoring/core/health/{vmId}": {
"get": {
"tags": ["Infrastructure"],
"operationId": "ServiceHealth_HealthStatus",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsResponse"
}
},
"examples": {
"application/json": {
"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
}]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/health-monitoring/core/health-status/{vmId}": {
"get": {
"tags": ["Infrastructure"],
"operationId": "ServiceHealth_HealthStatusPublic",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsPublicResponse"
}
},
"examples": {
"application/json": {
"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
}]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/ips": {
"get": {
"tags": ["Network Services"],
"summary": "Return a list of IP addresses allocated to the account and how they are assigned.",
"operationId": "Ip_GetIps",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vcdOrgVdcId",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}, {
"name": "type",
"in": "query",
"description": "Enum of private4, public4",
"required": false,
"type": "string"
}, {
"name": "state",
"in": "query",
"description": "Enum of Routed, Reserved, Assigned",
"required": false,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Ipam.Data.Domain.IpDto"
}
},
"examples": {
"application/json": [{
"id": 515,
"location": "DFW01",
"zone": "DFW01-VC01",
"ip": "100.64.0.9",
"state": "Reserved",
"type": "private4",
"assignedTo": null,
"vcdOrgVdcId": 0,
"isRecovery": false
}, {
"id": 518,
"location": "DFW01 ",
"zone": "DFW01-VC01",
"ip": "100.64.0.10",
"state": "Assigned",
"type": "private4",
"assignedTo": {
"id": 1,
"type": "vm",
"name": "Smoke-Test-A1",
"assignmentType": "primary"
},
"vcdOrgVdcId": 0,
"isRecovery": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"post": {
"tags": ["Network Services"],
"summary": "Assigns an IP to a VM.",
"operationId": "Ip_AssignPrivateIpToVm",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ipAssignmentRequest",
"in": "body",
"description": "vmId: The VM id to which the IP is assigned
id: id of the IP",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.AssignPrivateIpToVmSampleRequest"
}
}],
"responses": {
"200": {
"description": "The IpAddress 100.64.0.10 has been assigned to Vm Smoke-Test-A1"
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Un-assign an IP from a virtual machine.",
"operationId": "Ip_UnAssignIpFromVm",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "ipAssignmentRequest",
"in": "body",
"description": "vmId: The VM id to which the IP is assigned
id: id of the IP",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.UnAssignIpFromVmSampleRequest"
}
}],
"responses": {
"200": {
"description": "The IpAddress 100.64.0.10 has been Unassigned"
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/ips/publicIps/quantity/{quantity}": {
"post": {
"tags": ["Network Services"],
"summary": "Allocate more public IPs to your Account for a location.",
"operationId": "Ip_AssignExtDnatToAccount",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "assignExtDnatRequest",
"in": "body",
"description": "quantity: Number of IPs
locationId: id of the location from which you would like the IPs assigned",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Ipam.Data.Domain.AssignExtDnatRequest"
}
}, {
"name": "quantity",
"in": "path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Common.Data.Domain.Nat.IpAddressModel"
}
},
"examples": {
"application/json": [{
"id": 1,
"ipAddress": "10.254.11.1",
"subnetId": 15405,
"ipStateId": 3,
"location": "DFW01",
"type": null,
"cancelOrgRequestedSagaId": null,
"ipState": 3
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/l2l": {
"get": {
"tags": ["Network Services"],
"summary": "Return a list of L2L (IPSec) tunnels.",
"operationId": "L2L_GetL2LList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.L2LConfigurationDto"
}
},
"examples": {
"application/json": [{
"id": 4,
"edgeId": 4,
"edgeIp": "146.88.118.5",
"location": "DFW01",
"zone": "DFW01T01-VC03",
"lastModified": "2015-01-06T22:18:19.1",
"sites": [{
"id": 24,
"name": "ME",
"localIp": "146.88.118.5",
"peerIp": "1.2.3.4",
"isEnabled": true,
"notes": null,
"tags": []
}],
"tenantCidr": "100.64.0.64/26",
"vcdOrgVdcId": 0,
"vcdOrgId": 0,
"hasGen34": false,
"isNsxT": false
}, {
"id": 1222,
"edgeId": 1240,
"edgeIp": "146.88.122.13",
"location": "PHX01",
"zone": "PHX01T01-VC03",
"lastModified": "2015-01-06T07:01:19.693",
"sites": [],
"tenantCidr": "100.64.218.0/24",
"vcdOrgVdcId": 0,
"vcdOrgId": 0,
"hasGen34": false,
"isNsxT": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"post": {
"tags": ["Network Services"],
"summary": "Create a new L2L tunnel.",
"operationId": "L2L_CreateL2L",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "l2LDto",
"in": "body",
"description": "name: Name of tunnel
\r\n psk: Pre-shared key
\r\n dhGroup: Diffie-Hellman group. (dh2 , dh5)
\r\n isEnabled: Flag to enable or disable
\r\n enablePfs: Enable perfect forward secrecy
\r\n localSubnets: Local subnets to tunnel
\r\n peerSubnets: Peer subnets to tunnel
\r\n authentication: Type of authentication (psk)
\r\n encryption: Type of encryption to use (aes256,aes128,3des)
\r\n localIp: Local Peer IP address
\r\n peerId: Remote peer address
",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.CreateL2LSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"location": "DFW01",
"zone": "DFW01T01-VC03",
"lastModified": "2015-01-06T23:06:09.893",
"peerId": "1.2.3.4",
"encryption": "3des",
"enablePfs": true,
"dhGroup": "dh2",
"localSubnets": ["100.64.0.64/32"],
"peerSubnets": ["10.1.1.0/24"],
"psk": null,
"authentication": "psk",
"configurationId": 4,
"vcdOrgVdcId": 0,
"ikeVersion": null,
"digestAlgorithm": null,
"tunnelEncryption": null,
"tunnelDigestAlgorithm": null,
"tunnelDHGroup": null,
"id": 24,
"name": "ME",
"localIp": "146.88.118.5",
"peerIp": "1.2.3.4",
"isEnabled": true,
"notes": null,
"tags": []
}
}
},
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/l2l/{id}": {
"get": {
"tags": ["Network Services"],
"summary": "Get L2L tunnel by id.",
"operationId": "L2L_GetL2L",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the l2l tunnel",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"location": "DFW01",
"zone": "DFW01T01-VC03",
"lastModified": "0001-01-01T00:00:00",
"peerId": "1.2.3.4",
"encryption": "3des",
"enablePfs": true,
"dhGroup": "dh2",
"localSubnets": ["100.64.0.64/32"],
"peerSubnets": ["10.1.1.0/24"],
"psk": "e$KIG%&5k7K0S%rx",
"authentication": "psk",
"configurationId": 4,
"vcdOrgVdcId": 0,
"ikeVersion": null,
"digestAlgorithm": null,
"tunnelEncryption": null,
"tunnelDigestAlgorithm": null,
"tunnelDHGroup": null,
"id": 24,
"name": "ME",
"localIp": "146.88.118.5",
"peerIp": "1.2.3.4",
"isEnabled": true,
"notes": null,
"tags": []
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Delete a specific L2L tunnel.",
"operationId": "L2L_DeleteL2L",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the l2l tunnel",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.L2LSiteDto"
}
},
"examples": {
"application/json": {
"location": "DFW01",
"zone": "DFW01T01-VC03",
"lastModified": "2015-01-06T23:06:09.893",
"peerId": "1.2.3.4",
"encryption": "3des",
"enablePfs": true,
"dhGroup": "dh2",
"localSubnets": ["100.64.0.64/32"],
"peerSubnets": ["10.1.1.0/24"],
"psk": null,
"authentication": "psk",
"configurationId": 4,
"vcdOrgVdcId": 0,
"ikeVersion": null,
"digestAlgorithm": null,
"tunnelEncryption": null,
"tunnelDigestAlgorithm": null,
"tunnelDHGroup": null,
"id": 24,
"name": "ME",
"localIp": "146.88.118.5",
"peerIp": "1.2.3.4",
"isEnabled": true,
"notes": null,
"tags": []
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/l2l/{id}/esglimit/check": {
"get": {
"tags": ["Network Services"],
"operationId": "L2L_CheckEsgLimit",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/locations": {
"get": {
"tags": ["Infrastructure"],
"summary": "Return a set of available locations for provisioning new servers.",
"operationId": "Location_Get",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "requireZone",
"in": "query",
"required": false,
"type": "boolean"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Environment.LocationDto"
}
},
"examples": {
"application/json": [{
"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
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/nats": {
"get": {
"tags": ["Network Services"],
"summary": "Retrieve a list of NATs that are associated to your account.",
"operationId": "Nat_GetNatRules",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "locationName",
"in": "query",
"description": "The datacenter",
"required": false,
"type": "string"
}, {
"name": "zone",
"in": "query",
"description": "The zone in the datacenter",
"required": false,
"type": "string"
}, {
"name": "type",
"in": "query",
"description": "The type of nat",
"required": false,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Common.Events.Compute.Environment.Catalogs.NatRuleRefactoredDto"
}
},
"examples": {
"application/json": {
"location": "dfw01",
"zone": "dfw01 - vc01",
"destinationIpId": 120,
"type": "dnat",
"sourceIpIds": [121, 134]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Network Services"],
"summary": "Add/Delete NATs associated to a virtual machine.",
"operationId": "Nat_UpdateNatRule",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "updateNatRequest",
"in": "body",
"description": "VmId: id for the virtual machine that owns the TranslatedIp
\r\n TranslatedIp: The private IP address of the virtual machine
\r\n OriginalIps: An array of public IP addresses to remove
\r\n VcdOrgVdcId: id of the Virtual Datacenter",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.UpdateNatSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"vmId": 2,
"translatedIp": "100.10.10.1",
"originalIps": ["192.158.1.1"],
"id": 1
}
}
},
"400": {
"description": "Invalid Request"
}
},
"deprecated": false
},
"post": {
"tags": ["Network Services"],
"summary": "Create NATs associated to a virtual machine.",
"operationId": "Nat_AddNatRule",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "natRule",
"in": "body",
"description": "VmId: id for the virtual machine that owns the TranslatedIp
\r\n TranslatedIp: The private IP address of the virtual machine
\r\n OriginalIps: An array of public IP addresses to remove
\r\n Id: id of the Edge Gateway",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.NatSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"url": null,
"locationName": null,
"action": null,
"vmId": 2,
"translatedIp": "100.10.10.1",
"originalIps": ["192.158.1.1"],
"id": 1,
"vnic": 0
}
}
},
"400": {
"description": "Invalid Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Delete NATs associated to a virtual machine.",
"operationId": "Nat_DeleteNatRule",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "deleteNatRequest",
"in": "body",
"description": "VmId: id for the virtual machine that owns the TranslatedIp
\r\n TranslatedIp: The private IP address of the virtual machine
\r\n OriginalIps: An array of public IP addresses to remove
\r\n id: id of the Edge Gateway",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.NatSampleRequest"
}
}],
"responses": {
"200": {
"description": "Accepted"
},
"400": {
"description": "Invalid Request"
}
},
"deprecated": false
}
},
"/nats/vm/{vmId}": {
"get": {
"tags": ["Network Services"],
"summary": "Retrieve a list of NATs that are associated to a virtual machine.",
"operationId": "Nat_GetNatRulesByVmId",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "id of the virtual machine",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Common.Events.Compute.Environment.Catalogs.VmNatRuleDto"
}
},
"examples": {
"application/json": {
"vmIp": "10.10.10.10",
"publicIps": []
}
}
},
"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",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Data.Domain.Order"
}
},
"examples": {
"application/json": [{
"orderId": 101,
"accountId": 2,
"appId": null,
"dateOrdered": "2015-01-01T00:00:00",
"status": "Provisioned",
"jsonData": "{ }",
"secret": null,
"createdBy": "user@example.com"
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/orders/{id}": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieve a specific order for your account.",
"operationId": "Orders_GetOrderAsync",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of the Order",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Data.Domain.Order"
}
},
"examples": {
"application/json": {
"orderId": 101,
"accountId": 2,
"appId": null,
"dateOrdered": "2015-01-01T00:00:00",
"status": "Provisioned",
"jsonData": "{ }",
"secret": null,
"createdBy": "user@example.com"
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/orders/{osname}/wsus": {
"get": {
"tags": ["Infrastructure"],
"summary": "Retrieve the Wsus details for your ordered vm.",
"operationId": "Orders_GetWsusDetails",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "osname",
"in": "path",
"description": "OS Name of the vm Ordered",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Data.Domain.Order"
}
},
"examples": {
"application/json": {
"orderId": 101,
"accountId": 2,
"appId": null,
"dateOrdered": "2015-01-01T00:00:00",
"status": "Provisioned",
"jsonData": "{ }",
"secret": null,
"createdBy": "user@example.com"
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/orders/subscriptions": {
"post": {
"tags": ["Infrastructure"],
"summary": "Submit a subscription order.",
"operationId": "Orders_PostSubscriptionOrderAsync",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "order",
"in": "body",
"description": "location: The data center where the requested product will be used
\r\n sku: The product identifier for the requested product
\r\n Quantity: The quantity of product to order",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Orders.ApiExamples.Models.PostSubscriptionOrderAsyncSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.OrderDto"
}
},
"examples": {
"application/json": {
"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
}]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/orders/vms": {
"post": {
"tags": ["Infrastructure"],
"summary": "Create a virtual machine (VM) order.",
"operationId": "Orders_PostVmOrderAsync",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "order",
"in": "body",
"description": "name: Name of the virtual machine
\r\n location: The data center for the virtual machine
\r\n appId: id of the workload for the virtual machine
\r\n appName: Name of a new workload that will contain the virtual machine
\r\n tierId: id of the tier for the virtual machine
\r\n tierName: Name of a new tier that will contain the virtual machine
\r\n storage: Array of additional disks for the virtual machine
\r\n sku: The product identifier for the virtual machine
\r\n secret: The password to the virtual machine
\r\n (This password must contain at least one upper-case letter, one\r\n lower-case letter, a number, and special character. Additionally,\r\n this password must be at least 16 characters in legnth.)
\r\n quantity: The quantity of virtual machines to order (has to be 1)
",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Orders.ApiExamples.Models.PostVmOrderAsyncSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.OrderDto"
}
},
"examples": {
"application/json": {
"id": 33,
"accountId": 2,
"status": "submitted",
"dateCreated": "2015-01-07T02:21:00+00:00",
"vms": [{
"trackingId": "00000000-0000-0000-0000-000000000000",
"name": "NewVirtualMachine",
"location": "dfw01",
"zone": null,
"appId": -1,
"appName": "NewWorkload",
"tierId": -1,
"tierName": "NewTier",
"storage": [{
"size": 30,
"sku": "SAN-001",
"quantity": 0,
"accountId": 0
}],
"software": [{
"type": "os",
"parameters": [],
"sku": "CentOS 6",
"quantity": 0,
"accountId": 0
}],
"secret": null,
"templateId": null,
"vmProtectionPolicyId": null,
"sku": "A1-101",
"quantity": 1,
"accountId": 0
}]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/ssl-certificates": {
"get": {
"tags": ["Network Services"],
"summary": "Returns a list of users with their SSL VPN access to various environments.",
"operationId": "SslCertificates_GetSslCertificates",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Network.Models.SslCertificateDto%5D"
},
"examples": {
"application/json": {
"total": 3,
"page": 0,
"items": [{
"id": 0,
"cname": "ssl1",
"sku": null,
"certificateType": null,
"orderDate": "2025-12-14T16:25:57.3824929Z",
"expiryDate": "2026-03-14T16:25:57.3824929Z",
"uniqueProductIdentifier": null,
"accountId": 2,
"accountName": "test",
"tickets": null,
"status": null
}, {
"id": 0,
"cname": "ssl1",
"sku": null,
"certificateType": null,
"orderDate": "2025-11-14T16:25:57.3824929Z",
"expiryDate": "2026-03-24T16:25:57.3824929Z",
"uniqueProductIdentifier": null,
"accountId": 4,
"accountName": "test5",
"tickets": null,
"status": null
}, {
"id": 0,
"cname": "ssl3",
"sku": null,
"certificateType": null,
"orderDate": "2026-01-03T16:25:57.3824929Z",
"expiryDate": "2026-02-22T16:25:57.3824929Z",
"uniqueProductIdentifier": null,
"accountId": 1,
"accountName": "test1",
"tickets": null,
"status": null
}]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/ssl-certificates/{id}": {
"put": {
"tags": ["Network Services"],
"summary": "Update SSL-Certificate",
"operationId": "SslCertificates_UpdateSslCertificate",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.UpdateSslCertificateRequestDto"
}
}, {
"name": "id",
"in": "path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslCertificateDto"
},
"examples": {
"application/json": {
"id": 0,
"cname": "ssl1",
"sku": null,
"certificateType": null,
"orderDate": "2025-12-14T16:25:57.4249572Z",
"expiryDate": "2026-03-14T16:25:57.4249572Z",
"uniqueProductIdentifier": null,
"accountId": 2,
"accountName": "test",
"tickets": null,
"status": null
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"delete": {
"tags": ["Network Services"],
"summary": "Cancel SSL-Certificate",
"operationId": "SslCertificates_CancelSslCertificate",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.CancelSslCertificateRequestDto"
}
}, {
"name": "id",
"in": "path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslCertificateDto"
},
"examples": {
"application/json": {
"id": 0,
"cname": "ssl1",
"sku": null,
"certificateType": null,
"orderDate": "2025-12-14T16:25:57.4406429Z",
"expiryDate": "2026-03-14T16:25:57.4406429Z",
"uniqueProductIdentifier": null,
"accountId": 2,
"accountName": "test",
"tickets": null,
"status": null
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/sslvpn": {
"get": {
"tags": ["Network Services"],
"summary": "Returns a list of users with their SSL VPN access to various environments.",
"operationId": "SslVpn_GetSslVpnList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslVpnUserDto"
}
},
"examples": {
"application/json": [{
"id": 3,
"location": "DFW01",
"zone": "dfw01-vc01",
"users": [{
"id": 5,
"firstName": "Test",
"lastName": "Account",
"email": "user@example.com",
"isSslVpnEnabled": true
}],
"vcdOrgVdcId": 0
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/sslvpn/client-config": {
"get": {
"tags": ["Network Services"],
"operationId": "SslVpn_GetSslVpnConfigDetails",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslVpnConfigDetail"
},
"examples": {
"application/json": {
"sslVpnConnectionDetails": [{
"location": null,
"host": "192-168-002-125.test.testdomain.co",
"port": 0
}],
"sslVpnClientVersions": [{
"osName": "Linux",
"version": "6.42.0.64",
"clientDownloadUrl": "https://test.com/sslvpn/linux_client_6_4_6400.tgz"
}]
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/sslvpn/enable": {
"post": {
"tags": ["Network Services"],
"summary": "Enable a user for SSL VPN access to one or more environments.",
"operationId": "SslVpn_EnableSslVpn",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "userId: id of user to enable or disable
\r\n locations: Collection of Zones on which to enable userId
\r\n enable: Enable or Disable user in locations bool required",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.EnableSslVpnSampleRequest"
}
}],
"responses": {
"200": {
"description": ""
},
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/sslvpn/members": {
"get": {
"tags": ["Network Services"],
"summary": "Returns a list of users with their SSL VPN access to various environments.",
"operationId": "SslVpn_GetSslVpnMembers",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslVpnMemberDto"
}
},
"examples": {
"application/json": [{
"id": 3,
"location": "DFW01",
"zone": "dfw01-vc01",
"users": [{
"id": 5,
"firstName": "Test",
"lastName": "Account",
"email": "user@example.com",
"isSslVpnEnabled": true
}],
"vcdOrgVdcId": 0
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/stats/vms/{vmId}": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get statistics on your VM.",
"operationId": "Stats_GetAllUtilizationStats",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "id of the VM",
"required": true,
"type": "string"
}, {
"name": "interval",
"in": "query",
"description": "Interval in which to display stats",
"required": false,
"type": "string"
}, {
"name": "endDate",
"in": "query",
"description": "End Time in which to pull stats",
"required": false,
"type": "string",
"format": "date-time"
}, {
"name": "startDate",
"in": "query",
"description": "Start Time in which to pull stats",
"required": false,
"type": "string",
"format": "date-time"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmStatsDto"
}
},
"examples": {
"application/json": {
"vmId": "1",
"cpu": [{
"t": "2015-03-05T21:00:00",
"v": 0,
"s": "cpu"
}],
"memory": [{
"t": "2015-03-05T21:00:00",
"v": 0,
"s": "cpu"
}],
"networkIn": [{
"t": "2015-03-05T21:00:00",
"v": 0,
"s": "cpu"
}],
"networkOut": null
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/stats/vms/{vmId}/metrics": {
"get": {
"tags": ["Infrastructure"],
"operationId": "Stats_GetAllStatusForOneVm",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "interval",
"in": "query",
"description": "Interval in which to display stats",
"required": false,
"type": "string"
}, {
"name": "endDate",
"in": "query",
"description": "End Time in which to pull stats",
"required": false,
"type": "string",
"format": "date-time"
}, {
"name": "startDate",
"in": "query",
"description": "Start Time in which to pull stats",
"required": false,
"type": "string",
"format": "date-time"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmAllStatsDto"
}
},
"examples": {
"application/json": {
"vmId": "1",
"vMstatPoints": {
"cpU: Usage % - Total": [{
"t": "2025-01-01T21:00:00",
"v": 40,
"s": "CPU: Usage % - Total"
}],
"memory: RAM % usage": [{
"t": "2025-01-01T21:00:00",
"v": 33.56,
"s": "Memory: RAM % usage"
}],
"disk: disk % used - /dev/mapper/ubuntu--vg-ubuntu--lv mounted at /": [{
"t": "2025-01-01T21:00:00",
"v": 35,
"s": "Disk: disk % used - /dev/mapper/ubuntu--vg-ubuntu--lv mounted at /"
}],
"ssh port check - 100.69.230.10": [{
"t": "2025-01-01T21:00:00",
"v": 25,
"s": "SSH port check - 100.69.230.10"
}],
"ping - 100.69.230.10": [{
"t": "2025-01-01T21:00:00",
"v": 1.25,
"s": "Ping - 100.69.230.10"
}]
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/storage/summary": {
"get": {
"tags": ["Infrastructure"],
"summary": "Returns a list of VM's, the related storage summaries for each storage tier (SSD, FLUID, and RAW), and the location the storage is utilized.",
"operationId": "Storage_GetStorageSummaryByAccountId",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.StorageSummaryDto"
}
},
"examples": {
"application/json": {
"vms": [{
"id": 25,
"name": "JasonWindows3",
"location": "DFW01",
"ssd": 0,
"fluid": 0,
"raw": 0,
"total": 0
}, {
"id": 10484,
"name": "sp Ubuntu",
"location": "PHX01",
"ssd": 30720,
"fluid": 0,
"raw": 0,
"total": 30720
}],
"templates": []
}
}
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
}
},
"/vms": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get a list of virtual machines for the current account.",
"operationId": "Vm_GetVmList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.AccountVmDto"
}
},
"examples": {
"application/json": [{
"coreInstanceId": "06daafab-bffb-4f81-8cbf-532faad97037",
"dateCreated": null,
"providerRefId": null,
"provider": "Complete",
"hostName": null,
"externalAddress": null,
"isRegistered": null,
"dateRegistered": null,
"lastPing": null,
"needsReboot": null,
"customProvider": null,
"customLocation": null,
"instanceType": null,
"status": 0,
"isCore": true,
"externalVmIsDeleted": null,
"accountId": 98345,
"vmId": 21309821,
"workLoadId": 1232,
"workLoadName": "General Dynamics Web",
"location": "DFW01",
"operatingSystem": "CentOS 6.7",
"isArmor": true,
"ipAddress": "100.64.0.120",
"zone": "DFW01-CD01",
"name": "Website Public",
"cpu": 1,
"memory": 2048,
"storage": 81920,
"statusId": 4,
"deployed": true,
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"product": {
"sku": "A1-101",
"size": "A1",
"isExpired": false,
"storagePolicyClass": null,
"productCategory": null,
"productSubCategory": null
},
"tags": [],
"scheduledEvents": [],
"vmServices": null,
"multiVmVapp": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/{id}": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get details for a specific VM.",
"operationId": "Vm_GetVmDetail",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "VM ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.VmDetail"
}
},
"examples": {
"application/json": {
"hostType": "Virtual Machine",
"canUseFluidScale": false,
"disks": [{
"id": 1,
"capacity": 30720,
"name": "Disk 1",
"type": "SSD",
"scsiBusNo": 0,
"scsiUnitNo": 0
}],
"isDeleted": false,
"canReplicate": false,
"id": 1,
"coreInstanceId": "00000000-0000-0000-0000-000000000000",
"biosUuid": "00000000-0000-0000-0000-000000000000",
"name": "Website Public",
"provider": "4",
"location": "DFW01",
"zone": "DFW01-VC01",
"ipAddress": "",
"status": 4,
"appId": 1,
"appName": "General Dynamics Web",
"osId": null,
"os": "Ubuntu 14.04",
"deployed": true,
"cpu": 1,
"memory": 2048,
"storage": 30720,
"notes": null,
"vCenterId": 2,
"vCenterName": "DFW01-VC01",
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"coreDateRegistered": null,
"coreLastPing": null,
"latestCommunicationTimestamp": null,
"vmDateCreated": null,
"product": {
"sku": "A1-122",
"size": "A1",
"isExpired": false,
"storagePolicyClass": null,
"productCategory": null,
"productSubCategory": null
},
"vmServices": null,
"uuid": "urn:vcloud:vm:3aae18f5-8656-42b6-bd45-772bb3404c8e",
"isHealthy": null,
"health": 1,
"tags": ["Tag1"],
"scheduledEvents": [],
"advBackupStatus": false,
"advBackupSku": null,
"vmBackupInProgress": false,
"profileName": null,
"multiVmVapp": false,
"osProvider": null,
"currentOsName": null,
"currentOsId": 0,
"needsReboot": false,
"rebootMessage": null,
"dsmUrl": null,
"isWafProtected": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Infrastructure"],
"summary": "Update the name of a VM.",
"operationId": "Vm_UpdateVm",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "VM ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Compute.ApiExamples.Models.UpdateAppSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.VmDetail"
}
},
"examples": {
"application/json": {
"hostType": "Virtual Machine",
"canUseFluidScale": false,
"disks": [],
"isDeleted": false,
"canReplicate": false,
"id": 9,
"coreInstanceId": "06daafab-bffb-4f81-8cbf-532faad97037",
"biosUuid": "00000000-0000-0000-0000-000000000000",
"name": "VMW001",
"provider": "4",
"location": "DFW01",
"zone": "DFW01-VC01",
"ipAddress": "",
"status": 100,
"appId": 1,
"appName": "General Dynamics Web",
"osId": null,
"os": "Ubuntu 14.04",
"deployed": false,
"cpu": 1,
"memory": 2048,
"storage": 30720,
"notes": null,
"vCenterId": 2,
"vCenterName": "A-VC01",
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"coreDateRegistered": null,
"coreLastPing": null,
"latestCommunicationTimestamp": null,
"vmDateCreated": null,
"product": {
"sku": "A1-122",
"size": "A1",
"isExpired": false,
"storagePolicyClass": null,
"productCategory": null,
"productSubCategory": null
},
"vmServices": null,
"uuid": "urn:firehost:b5e1892b-bf4d-4209-b513-83c04f187ca3",
"isHealthy": null,
"health": 0,
"tags": ["Tag1"],
"scheduledEvents": [],
"advBackupStatus": false,
"advBackupSku": null,
"vmBackupInProgress": false,
"profileName": null,
"multiVmVapp": false,
"osProvider": null,
"currentOsName": null,
"currentOsId": 0,
"needsReboot": false,
"rebootMessage": null,
"dsmUrl": null,
"isWafProtected": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Infrastructure"],
"summary": "Delete a VM.",
"operationId": "Vm_DeleteVm",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "VM ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.DeleteVmRequest"
}
}],
"responses": {
"202": {
"description": "Accepted",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/{id}/adjustResources": {
"post": {
"tags": ["Infrastructure"],
"summary": "Update VM to a new fixed instance geometry in order to increase/decrease CPU and/or memory.",
"operationId": "Vm_AdjustVmResources",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "VM ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.AdjustVmResourcesRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/{id}/license": {
"get": {
"tags": ["Infrastructure"],
"operationId": "Vm_GetLicenseDetailsByVmId",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/vms/{id}/power/{powerAction}": {
"post": {
"tags": ["Infrastructure"],
"summary": "Perform a power action on a virtual machine.",
"operationId": "Vm_PowerActionVm",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of the VM on which to perform power action",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "powerAction",
"in": "path",
"description": "On, off, forceOff, reset, reboot, shutdown",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.VmDetail"
}
},
"examples": {
"application/json": {
"hostType": "Virtual Machine",
"canUseFluidScale": false,
"disks": [],
"isDeleted": false,
"canReplicate": false,
"id": 9,
"coreInstanceId": "00000000-0000-0000-0000-000000000000",
"biosUuid": "00000000-0000-0000-0000-000000000000",
"name": "New_Test_0100",
"provider": "4",
"location": "DFW01",
"zone": "DFW01-VC01",
"ipAddress": "",
"status": 8,
"appId": 1,
"appName": "General Dynamics Web",
"osId": null,
"os": "Ubuntu 14.04",
"deployed": false,
"cpu": 1,
"memory": 2048,
"storage": 30720,
"notes": null,
"vCenterId": 2,
"vCenterName": "DFW01-VC01",
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"coreDateRegistered": null,
"coreLastPing": null,
"latestCommunicationTimestamp": null,
"vmDateCreated": null,
"product": {
"sku": "A1-122",
"size": "A1",
"isExpired": false,
"storagePolicyClass": null,
"productCategory": null,
"productSubCategory": null
},
"vmServices": null,
"uuid": "urn:firehost:b5e1892b-bf4d-4209-b513-83c04f187ca3",
"isHealthy": null,
"health": 0,
"tags": [],
"scheduledEvents": [],
"advBackupStatus": false,
"advBackupSku": null,
"vmBackupInProgress": false,
"profileName": null,
"multiVmVapp": false,
"osProvider": null,
"currentOsName": null,
"currentOsId": 0,
"needsReboot": false,
"rebootMessage": null,
"dsmUrl": null,
"isWafProtected": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/{id}/processScheduledEvent": {
"post": {
"tags": ["Infrastructure"],
"summary": "Force processing a vm event scheduled in the future or already due, but incomplete",
"operationId": "Vm_ProcessScheduledEvent",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "VM ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/{vmId}/availableStorage": {
"get": {
"tags": ["Infrastructure"],
"summary": "Returns the list of available storage products that can be added to a VM.",
"operationId": "Storage_GetAvailableStorageByVm",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "id for the VM",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.StorageProduct"
}
},
"examples": {
"application/json": [{
"id": 1,
"name": "SSD (GB)",
"sku": "SAN-001",
"category": "Disk",
"description": "SSD-based storage",
"tier": "SSD",
"min": 10,
"max": 500,
"increment": 10,
"price": [{
"location": "DFW01",
"amount": 1.7
}, {
"location": "SIN01",
"amount": 2
}]
}, {
"id": 2,
"name": "RAW (GB)",
"sku": "SAN-003",
"category": "Disk",
"description": "RAW-based storage",
"tier": "RAW",
"min": 250,
"max": 2000,
"increment": 250,
"price": [{
"location": "DFW01",
"amount": 0.15
}, {
"location": "SIN01",
"amount": 0.18
}]
}, {
"id": 3,
"name": "Fluid (GB)",
"sku": "SAN-002",
"category": "Disk",
"description": "Fluid-based storage",
"tier": "Fluid",
"min": 50,
"max": 2000,
"increment": 50,
"price": [{
"location": "DFW01",
"amount": 0.75
}, {
"location": "SIN01",
"amount": 0.9
}]
}]
}
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
}
},
"/vms/{vmId}/disk": {
"post": {
"tags": ["Infrastructure"],
"summary": "Add a disk to a VM by id.",
"operationId": "Storage_AddDisk",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "id of the VM to add disk.",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "storage",
"in": "body",
"description": "SKU of the Storage tier to add; values are acquired from vms/{vmId}/availableStorage",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.StorageOrderDto"
}
}],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Missing or invalid authorization token."
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
}
},
"/vms/{vmId}/disk/{diskId}": {
"delete": {
"tags": ["Infrastructure"],
"summary": "Deletes the specified disk, by id, for the specified VM.",
"operationId": "Storage_DeleteDisk",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "diskId",
"in": "path",
"description": "id of the disk to delete, the id can be retrieved from /vms/{vmId}",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
}
},
"/vms/{vmId}/disk/{diskId}/advancedsettings": {
"put": {
"tags": ["Infrastructure"],
"summary": "Deletes the specified disk, by id, for the specified VM.",
"operationId": "Storage_UpdateDiskAdvancedSettings",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "vmId",
"in": "path",
"description": "id of the VM",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "diskId",
"in": "path",
"description": "id of the disk to update the advanced settings (SCSI), the id can be retrieved from /vms/{vmId}",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.StorageAdvancedSettingsUpdateRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "Request Accepted"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Missing or invalid authorization token."
},
"403": {
"description": "Permission Denied"
}
},
"deprecated": false
}
},
"/vms/autoAgePolicy": {
"get": {
"tags": ["Infrastructure"],
"operationId": "Vm_GetAccountAutoAgePolicy",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
},
"post": {
"tags": ["Infrastructure"],
"operationId": "Vm_UpsertAccountAgePolicy",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.AccountAutoAgePolicy"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/vms/core/{coreInstanceId}": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get details for an Anywhere VM",
"operationId": "Vm_GetVmCoreDetail",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "coreInstanceId",
"in": "path",
"description": "The Guid of the Core Instance to get",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.CoreVmDetail"
}
},
"examples": {
"application/json": {
"hostType": "Virtual Machine",
"providerRefId": "420D909B-8516-7A67-38BC-37F5FD94F79B",
"providerId": 0,
"agentVersion": "5.2.0",
"activationKey": "VJPG6-2J667-GP78W-J6C74-J992R",
"id": 0,
"coreInstanceId": "f6569645-d229-4ace-9a16-85de480c3ff7",
"biosUuid": "00000000-0000-0000-0000-000000000000",
"name": "New_Test_0100",
"provider": "Armor Anywhere",
"location": null,
"zone": null,
"ipAddress": "192.168.0.1",
"status": 0,
"appId": 0,
"appName": null,
"osId": null,
"os": "Ubuntu 14.04",
"deployed": false,
"cpu": 0,
"memory": 0,
"storage": 0,
"notes": null,
"vCenterId": 0,
"vCenterName": null,
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"coreDateRegistered": "2017-05-31T21:12:40.343",
"coreLastPing": "2017-06-05T21:55:19.85",
"latestCommunicationTimestamp": null,
"vmDateCreated": null,
"product": null,
"vmServices": null,
"uuid": null,
"isHealthy": null,
"health": 3,
"tags": [],
"scheduledEvents": null,
"advBackupStatus": false,
"advBackupSku": null,
"vmBackupInProgress": false,
"profileName": null,
"multiVmVapp": false,
"osProvider": null,
"currentOsName": null,
"currentOsId": 0,
"needsReboot": false,
"rebootMessage": null,
"dsmUrl": null,
"isWafProtected": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Infrastructure"],
"summary": "Delete a Core VM.",
"operationId": "Vm_DeleteCore",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "coreInstanceId",
"in": "path",
"description": "The Guid of the Core Instance to delete",
"required": true,
"type": "string"
}, {
"name": "deleteTags",
"in": "query",
"description": "Bool specifying if locked tags should be deleted",
"required": false,
"type": "boolean"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
},
"examples": {
"application/json": "Removing core vm 06daafab-bffb-4f81-8cbf-532faad97037"
}
},
"400": {
"description": "Invalid request."
}
},
"deprecated": false
}
},
"/vms/core/{coreInstanceId}/profile": {
"put": {
"tags": ["Infrastructure"],
"summary": "Assign a profle to the Vm",
"operationId": "Vm_AssignCoreInstanceProfileByName",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "coreInstanceId",
"in": "path",
"required": true,
"type": "string"
}, {
"name": "profileRequest",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Perimeter.Data.Domain.Profile.ProfileRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
},
"examples": {
"application/json": "Log Collector"
}
},
"400": {
"description": "Invalid profile name."
}
},
"deprecated": false
}
},
"/vms/hybridVmList": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get a list of virtual machines for the current account.",
"operationId": "Vm_GetVmListWithCloudConnections",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "includeCloudConnections",
"in": "query",
"required": false,
"type": "boolean"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.AccountVmWithCloudConnectionsDto"
}
},
"examples": {
"application/json": [{
"coreInstanceId": "06daafab-bffb-4f81-8cbf-532faad97037",
"dateCreated": null,
"providerRefId": null,
"provider": "Complete",
"hostName": null,
"hostType": "Virtual Machine",
"externalAddress": null,
"isRegistered": null,
"dateRegistered": null,
"lastPing": null,
"latestCommunicationTimestamp": null,
"needsReboot": null,
"customProvider": null,
"customLocation": null,
"instanceType": null,
"status": 0,
"isCore": true,
"externalVmIsDeleted": null,
"accountId": 98345,
"vmId": 21309821,
"workLoadId": 1232,
"workLoadName": "General Dynamics Web",
"location": "DFW01",
"operatingSystem": "CentOS 6.7",
"isArmor": true,
"ipAddress": "100.64.0.120",
"zone": "DFW01-CD01",
"name": "Website Public",
"cpu": 1,
"memory": 2048,
"storage": 81920,
"statusId": 4,
"deployed": true,
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"product": {
"sku": "A1-101",
"size": "A1",
"isExpired": false,
"storagePolicyClass": null,
"productCategory": null,
"productSubCategory": null
},
"tags": [],
"scheduledEvents": [],
"vmServices": null,
"awsAmi": "ami-ef7dcf8f",
"awsSecurityGroups": "test-security-group",
"awsKeyPair": "FH-BFleming",
"dateCreatedFrom": "AWS Launch Date",
"region": "us-east-1",
"isHealthy": null,
"state": "Not Available",
"stateDescription": "Not Available",
"healthStatuses": null,
"advBackupStatus": false,
"advBackupSku": null,
"vmBackupInProgress": false,
"profileName": null,
"multiVmVapp": false,
"osProvider": null,
"currentOsName": null,
"currentOsId": 0,
"rebootMessage": null,
"isWafProtected": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/os-endoflife": {
"get": {
"tags": ["Infrastructure"],
"operationId": "Vm_GetVmOSEndOfLife",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/vms/simpleVmList": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get a list of virtual machines for the current account.",
"operationId": "Vm_GetAllVmList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.AccountSimpleVmDto"
}
},
"examples": {
"application/json": [{
"coreInstanceId": "06daafab-bffb-4f81-8cbf-532faad97037",
"vmId": 21309821,
"hostName": null
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/vms/unprotectedec2instance/{id}": {
"get": {
"tags": ["Infrastructure"],
"summary": "Get un protected ec2 instance details by instance id",
"operationId": "Vm_GetUnprotectedEc2InstanceDetailById",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "The Guid of the Core Instance to get",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.CoreVmDetail"
}
},
"examples": {
"application/json": {
"hostType": "Virtual Machine",
"providerRefId": "420D909B-8516-7A67-38BC-37F5FD94F79B",
"providerId": 0,
"agentVersion": "5.2.0",
"activationKey": "VJPG6-2J667-GP78W-J6C74-J992R",
"id": 0,
"coreInstanceId": "f6569645-d229-4ace-9a16-85de480c3ff7",
"biosUuid": "00000000-0000-0000-0000-000000000000",
"name": "New_Test_0100",
"provider": "Armor Anywhere",
"location": null,
"zone": null,
"ipAddress": "192.168.0.1",
"status": 0,
"appId": 0,
"appName": null,
"osId": null,
"os": "Ubuntu 14.04",
"deployed": false,
"cpu": 0,
"memory": 0,
"storage": 0,
"notes": null,
"vCenterId": 0,
"vCenterName": null,
"vcdOrgVdcId": 0,
"isRecoveryVm": false,
"coreDateRegistered": "2017-05-31T21:12:40.343",
"coreLastPing": "2017-06-05T21:55:19.85",
"latestCommunicationTimestamp": null,
"vmDateCreated": null,
"product": null,
"vmServices": null,
"uuid": null,
"isHealthy": null,
"health": 3,
"tags": [],
"scheduledEvents": null,
"advBackupStatus": false,
"advBackupSku": null,
"vmBackupInProgress": false,
"profileName": null,
"multiVmVapp": false,
"osProvider": null,
"currentOsName": null,
"currentOsId": 0,
"needsReboot": false,
"rebootMessage": null,
"dsmUrl": null,
"isWafProtected": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
}
},
"definitions": {
"System.Object": {
"type": "object",
"properties": {}
},
"FireHost.Services.Http.Accounts.Models.GetUsageResponse": {
"description": "Model for Usage Data",
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"description": "Account Id",
"type": "integer"
},
"sku": {
"description": "Sku",
"type": "string"
},
"vmId": {
"format": "int32",
"description": "VmId",
"type": "integer"
},
"quantity": {
"format": "double",
"description": "Quantity Used",
"type": "number"
},
"usageDate": {
"description": "Date of Usage",
"type": "string"
}
}
},
"FireHost.Services.Http.Billing.Models.SubscriptionResponse": {
"type": "object",
"properties": {
"uniqueProductIdentifier": {
"type": "string"
},
"productName": {
"type": "string"
},
"productCategory": {
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"sku": {
"type": "string"
},
"price": {
"format": "double",
"type": "number"
},
"totalPrice": {
"format": "double",
"type": "number"
},
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"contractEffectiveDate": {
"format": "date-time",
"type": "string"
},
"pendingCancellation": {
"type": "boolean"
},
"ticketKey": {
"type": "string"
}
}
},
"FireHost.Services.Http.Billing.ApiExamples.Models.CancelSubscriptionSampleRequest": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"readOnly": true
},
"uniqueProductIdentifier": {
"type": "string",
"readOnly": true
}
},
"example": {
"sku": "APP-MONITORING-PRO",
"uniqueProductIdentifier": "e1158c05-5090-4083-a8e1-d56bed8ee4cc"
}
},
"FireHost.Services.Meta.ApiExamples.Models.AddTagSampleRequest": {
"type": "object",
"properties": {
"messages": {
"type": "string",
"readOnly": true
}
},
"example": {
"messages": "tag1"
}
},
"FireHost.Services.Meta.ApiExamples.Models.DeleteTagSampleRequest": {
"type": "object",
"properties": {
"messages": {
"type": "string",
"readOnly": true
}
},
"example": {
"messages": "tag1"
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Accounts.Data.Persistence.ChildAccount]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.ChildAccount"
}
}
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.ChildAccount": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"deployedAgents": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Accounts.Models.ChildAccounts.ChildAccountSignupRequest": {
"description": "Request object for Child Account Signup",
"type": "object",
"properties": {
"firstName": {
"pattern": "^[a-zA-Z0-9àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ\\(\\)\\[\\]\\*^%$#@!:~`,.; \\-'&_+|\\\\?\\/]{1,100}$",
"type": "string"
},
"lastName": {
"pattern": "^[a-zA-Z0-9àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ\\(\\)\\[\\]\\*^%$#@!:~`,.; \\-'&_+|\\\\?\\/]{1,100}$",
"type": "string"
},
"companyName": {
"pattern": "^[a-zA-Z0-9àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ\\(\\)\\[\\]\\*^%$#@!:~`,.; \\-'&_+\\\\?\\/]{1,50}$",
"type": "string"
},
"title": {
"pattern": "^[a-zA-Z0-9àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ\\(\\)\\[\\]\\*^%$#@!:~`,.; \\-'&_+|\\\\?\\/]{1,160}$",
"type": "string"
},
"parentAccountId": {
"format": "int32",
"type": "integer"
},
"email": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"currency": {
"pattern": "^(USD|GBP)$",
"type": "string"
},
"relationshipEntity": {
"pattern": "^(INC|LTD)$",
"type": "string"
},
"productLine": {
"pattern": "^(Complete|Anywhere)$",
"type": "string"
},
"phone": {
"type": "string"
},
"website": {
"type": "string"
},
"channel": {
"pattern": "^(SMB|Enterprise|Government)$",
"type": "string"
},
"armorAnywhereLocation": {
"pattern": "^(Azure|AWS|Internal IT|CoLocation|Other)$",
"type": "string"
},
"armorAnywhereOtherLocation": {
"type": "string"
},
"autoAcceptUserInvite": {
"type": "boolean"
},
"correlationId": {
"type": "string",
"readOnly": true
}
},
"example": {
"firstName": "First",
"lastName": "Last",
"companyName": "Company Example",
"title": "Title",
"parentAccountId": 1234,
"email": "example@email.com",
"addressLine1": "Address Line 1",
"addressLine2": "Address Line 2",
"city": "City",
"state": "TX",
"postalCode": "12345",
"country": "US",
"currency": "USD",
"relationshipEntity": "INC",
"productLine": "Anywhere",
"phone": "123-123-1234",
"website": "https://example.com",
"channel": "SMB",
"armorAnywhereLocation": "Other",
"armorAnywhereOtherLocation": "example location",
"autoAcceptUserInvite": true,
"correlationId": "d4244c08-efcc-4283-b197-27ebff111b88"
}
},
"FireHost.Services.Common.HandleResult[System.Int32]": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"data": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.Models.ChildAccounts.MassGrantAccessRequest": {
"description": "Request object for Mass Access for Parent Account Users to Child Account",
"type": "object",
"properties": {
"parentAccountId": {
"format": "int32",
"description": "Id of the parent account",
"type": "integer"
},
"parentAccountRoleId": {
"format": "int32",
"description": "Role Id of the Parent account from which users should be added to the child account",
"type": "integer"
},
"childAccountId": {
"format": "int32",
"description": "Child account Id to which Parent account users should be added",
"type": "integer"
},
"childAccountRoleId": {
"format": "int32",
"description": "Child account Role Id to which the Parent account users should be added to",
"type": "integer"
}
}
},
"FireHost.Services.Http.Accounts.Data.Domain.AccountContacts": {
"type": "object",
"properties": {
"accountExecutive": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Data.Domain.SalesForceUser"
},
"accountStrategicManager": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Data.Domain.SalesForceUser"
}
}
},
"FireHost.Services.Http.Accounts.Data.Domain.SalesForceUser": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"name": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"title": {
"type": "string"
},
"email": {
"type": "string"
},
"homePhone": {
"type": "string"
},
"mobilePhone": {
"type": "string"
},
"street": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zipcode": {
"type": "string"
},
"country": {
"type": "string"
},
"salesforceId": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.AddUpdatePrimaryNotificationUserRequestSample": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"notificationTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"accountId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"userId": 3,
"notificationTypes": ["Account, Technical, Billing"],
"accountId": 2
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionsSummaryDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"connectorName": {
"type": "string"
},
"provider": {
"type": "string"
},
"connectionType": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string"
}
}
},
"FireHost.Services.Http.CloudConnections.Models.Requests.ServiceParams": {
"type": "object",
"properties": {
"parameters": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
}
}
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionsDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"externalId": {
"type": "string"
},
"provider": {
"type": "string"
},
"providerAccountId": {
"type": "string"
},
"providerAccessResource": {
"type": "string"
},
"total": {
"format": "int64",
"type": "integer"
},
"isEnabled_Beta": {
"type": "boolean"
},
"isEnabled_Ec2": {
"type": "boolean"
},
"isEnabled_Log": {
"type": "boolean"
},
"setupStatus": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionService"
}
}
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionService": {
"type": "object",
"properties": {
"accountConnectionId": {
"format": "int32",
"type": "integer"
},
"lastSuccessfulConnectionDate": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"subServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionSubServiceType"
}
},
"policy": {
"type": "string"
},
"imageName": {
"type": "string"
}
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionSubServiceType": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"subServiceName": {
"type": "string"
},
"imageName": {
"type": "string"
},
"policy": {
"type": "string"
}
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionDetailsDto": {
"type": "object",
"properties": {
"armorAwsAccountId": {
"type": "string",
"readOnly": true
},
"connectionName": {
"type": "string"
},
"description": {
"type": "string"
},
"externalId": {
"type": "string"
},
"providerAccessResource": {
"type": "string"
},
"accountConnectionId": {
"format": "int32",
"type": "integer"
},
"providerTypeName": {
"type": "string"
},
"serviceTypeName": {
"type": "string"
},
"awsBaseJsonPolicy": {
"type": "string",
"readOnly": true
},
"subServiceName": {
"type": "string"
}
},
"example": {
"id": 1,
"accountId": 0,
"name": "AWS(Development)",
"externalId": "01a5725d-ebd1-4a52-b444-f233ba952fca",
"provider": "AWS",
"providerAccountId": "345186984524",
"total": 1,
"isEnabled_Beta": false,
"isEnabled_Ec2": false,
"isEnabled_Log": false,
"setupStatus": "Completed",
"services": []
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionServiceTypesDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"subServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionSubServiceType"
}
},
"policy": {
"type": "string"
},
"imageName": {
"type": "string"
}
}
},
"FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionStatus": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"isEc2Enabled": {
"type": "boolean"
},
"isLogDepotEnabled": {
"type": "boolean"
},
"isBetaEnabled": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.PaymentMethod": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountBillingId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"paymentMethodId": {
"type": "string"
},
"paymentType": {
"type": "string"
},
"achRoutingNumber": {
"type": "string"
},
"achAccountMaskNumber": {
"type": "string"
},
"creditCardType": {
"type": "string"
},
"creditCardMaskNumber": {
"type": "string"
},
"creditCardExpirationMonth": {
"format": "int32",
"type": "integer"
},
"creditCardExpirationYear": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"status": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"isPrimary": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.SetDefaultPaymentMethodSampleRequest": {
"type": "object",
"properties": {
"isPrimary": {
"type": "boolean",
"readOnly": true
}
},
"example": {
"isPrimary": true
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.DeletePaymentMethodByIdSampleRequest": {
"type": "object",
"properties": {
"modifiedBy": {
"type": "string",
"readOnly": true
}
},
"example": {
"modifiedBy": "Name"
}
},
"FireHost.Services.Http.Accounts.Models.GetUserResponse": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phonePrimary": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Phone"
},
"timezone": {
"type": "string"
},
"culture": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"lastModified": {
"format": "date-time",
"type": "string"
},
"passwordLastSet": {
"format": "date-time",
"type": "string"
},
"mustChangePassword": {
"type": "boolean"
},
"lastLogin": {
"format": "date-time",
"type": "string"
},
"apiKeyCount": {
"format": "int32",
"description": "Gets or sets the Api Key Count",
"type": "integer"
},
"isPrimaryBillingNotificationUser": {
"type": "boolean"
},
"isPrimaryAccountNotificationUser": {
"type": "boolean"
},
"isPrimaryTechnicalNotificationUser": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Accounts.Data.Phone": {
"type": "object",
"properties": {
"countryCode": {
"format": "int32",
"type": "integer"
},
"countryIsoCode": {
"type": "string"
},
"number": {
"type": "string"
},
"phoneExt": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.CreateAccountUserSampleRequest": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"readOnly": true
},
"lastName": {
"type": "string",
"readOnly": true
},
"email": {
"type": "string",
"readOnly": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Internal.Data.Requests.Role"
},
"readOnly": true
}
},
"example": {
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@armor.com",
"roles": [{
"id": 1
}]
}
},
"FireHost.Infrastructure.Accounts.Internal.Data.Requests.Role": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Accounts.Models.CreateAccountResponse": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Accounts.Data.Persistence.AccountUserSimple]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.AccountUserSimple"
}
}
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.AccountUserSimple": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"isEnabled": {
"type": "boolean"
},
"title": {
"type": "string"
},
"lastModified": {
"format": "date-time",
"type": "string"
},
"lastLoginTime": {
"format": "date-time",
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"isEmployee": {
"type": "boolean"
},
"timeZoneId": {
"type": "string"
},
"culture": {
"type": "string"
},
"invitationAcceptedDate": {
"format": "date-time",
"type": "string"
},
"apiKeyCount": {
"format": "int32",
"type": "integer"
},
"status": {
"type": "string"
},
"total": {
"type": "string"
},
"isPrimaryBillingNotificationUser": {
"type": "boolean"
},
"isPrimaryAccountNotificationUser": {
"type": "boolean"
},
"isPrimaryTechnicalNotificationUser": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateUserSampleRequest": {
"type": "object",
"properties": {
"status": {
"type": "string",
"readOnly": true
},
"firstName": {
"type": "string",
"readOnly": true
},
"lastName": {
"type": "string",
"readOnly": true
},
"phonePrimary": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.SamplePhone",
"readOnly": true
}
},
"example": {
"status": "enabled",
"firstName": "John",
"lastName": "Smith",
"phonePrimary": {
"countryCode": 1,
"countryIsoCode": "US",
"number": "8880000000"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.SamplePhone": {
"type": "object",
"properties": {
"countryCode": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"countryIsoCode": {
"type": "string",
"readOnly": true
},
"number": {
"type": "string",
"readOnly": true
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.CreateUserNotificationPreferenceSampleRequest": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"accountId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"isSelfUpdate": {
"type": "boolean",
"readOnly": true
},
"notificationPreferences": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.UserNotificationPreferenceSample"
},
"readOnly": true
}
},
"example": {
"userId": 2903,
"accountId": 2,
"isSelfUpdate": true,
"notificationPreferences": [{
"notificationTypeId": 2,
"alert": true,
"sms": true,
"email": true
}]
}
},
"FireHost.Services.Common.Data.Domain.User.UserNotificationPreference": {
"type": "object",
"properties": {
"notificationTypeId": {
"format": "int32",
"type": "integer"
},
"notificationType": {
"type": "string"
},
"alert": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"email": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.UserNotificationPreferenceSample": {
"type": "object",
"properties": {
"notificationTypeId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"alert": {
"type": "boolean",
"readOnly": true
},
"sms": {
"type": "boolean",
"readOnly": true
},
"email": {
"type": "boolean",
"readOnly": true
}
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.UserNotificationPreferencesResponse": {
"type": "object",
"properties": {
"notificationPreferences": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Common.Data.Domain.User.UserNotificationPreference"
}
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateUserStatusSampleRequest": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"isEnabled": {
"type": "boolean",
"readOnly": true
},
"accountId": {
"format": "int32",
"type": "integer",
"readOnly": true
}
},
"example": {
"id": 8,
"isEnabled": true,
"accountId": 2
}
},
"FireHost.Services.Http.Accounts.Models.UpdateUserStatusResponse": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"isEnabled": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Billing.Models.InvoiceResponse": {
"type": "object",
"properties": {
"invoiceId": {
"type": "string"
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"format": "date-time",
"type": "string"
},
"invoiceDueDate": {
"format": "date-time",
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"status": {
"type": "string"
},
"remainingBalance": {
"format": "double",
"type": "number"
}
}
},
"FireHost.Services.Http.Billing.Models.InvoiceSummary": {
"type": "object",
"properties": {
"lineItems": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.InvoiceSummaryLineItem"
}
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"format": "date-time",
"type": "string"
},
"billingPeriodStartDate": {
"format": "date-time",
"type": "string"
},
"billingPeriodEndDate": {
"format": "date-time",
"type": "string"
},
"paymentStatus": {
"type": "string"
},
"subTotal": {
"format": "double",
"type": "number"
},
"lineItemDiscounts": {
"format": "double",
"type": "number"
},
"accountLevelDiscounts": {
"format": "double",
"type": "number"
},
"adjustments": {
"format": "double",
"type": "number"
},
"tax": {
"format": "double",
"type": "number"
},
"invoiceTotal": {
"format": "double",
"type": "number"
},
"billTo": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.InvoiceAddress"
},
"soldTo": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.InvoiceAddress"
},
"remitTo": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.InvoiceAddress"
},
"poNumber": {
"type": "string"
}
}
},
"FireHost.Services.Http.Billing.Models.InvoiceSummaryLineItem": {
"type": "object",
"properties": {
"productLine": {
"type": "string"
},
"category": {
"type": "string"
},
"subCategory": {
"type": "string"
},
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"itemTotal": {
"format": "double",
"type": "number"
}
}
},
"FireHost.Services.Http.Billing.Models.InvoiceAddress": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"vatNumber": {
"type": "string"
}
}
},
"FireHost.Services.Http.Billing.Models.Usage.AccountUsageResponse": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"serviceStartDate": {
"format": "date-time",
"type": "string"
},
"serviceEndDate": {
"format": "date-time",
"type": "string"
},
"usageDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.Usage.AccountUsageItemDetails"
}
}
}
},
"FireHost.Services.Http.Billing.Models.Usage.AccountUsageItemDetails": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"location": {
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"serviceStartDate": {
"format": "date-time",
"type": "string"
},
"serviceEndDate": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"productLine": {
"type": "string"
},
"category": {
"type": "string"
},
"subCategory": {
"type": "string"
},
"resource": {
"type": "string"
},
"uri": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"notes": {
"type": "string"
},
"unit": {
"type": "string"
},
"tier": {
"type": "string"
},
"workload": {
"type": "string"
}
}
},
"FireHost.Services.Http.Billing.Models.Usage.AccountUsageDetailsResponse": {
"type": "object",
"properties": {
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"usageData": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Billing.Models.UsageDetails"
}
}
}
},
"FireHost.Infrastructure.Billing.Models.UsageDetails": {
"type": "object",
"properties": {
"uom": {
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"productName": {
"type": "string"
},
"category": {
"type": "string"
},
"subHeading": {
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.Billing.Models.AccountListDto": {
"type": "object",
"properties": {
"months": {
"type": "array",
"items": {
"type": "string"
}
},
"accountDtos": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Billing.Models.SubAccountDto"
}
}
}
},
"FireHost.Infrastructure.Billing.Models.SubAccountDto": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Billing.Models.AccountHourlyUsageItem": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"coreUsageQty": {
"format": "int32",
"type": "integer"
},
"usageEndDate": {
"format": "date-time",
"type": "string"
},
"usageStartDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateChallengePhraseSampleRequest": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"challengePhrase": {
"type": "string",
"readOnly": true
},
"challengeAnswer": {
"type": "string",
"readOnly": true
}
},
"example": {
"userId": 0,
"challengePhrase": "what is your mother's maiden name?",
"challengeAnswer": "maiden"
}
},
"FireHost.Services.Http.Accounts.Models.GetPermissionsResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.PermissionDto"
}
}
}
},
"FireHost.Services.Http.Accounts.Models.PermissionDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"system": {
"type": "string"
},
"resource": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.PermissionEndpoint"
}
},
"description": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.Models.PermissionEndpoint": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"route": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.Models.GetAccountRolePermissionsResponse": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"modified": {
"format": "date-time",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetRoleUser"
}
},
"permissions": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"default": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Accounts.Models.GetRoleUser": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"added": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"roleId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.CreateRoleSampleRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"permissions": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"readOnly": true
}
},
"example": {
"name": "Role 1",
"permissions": [1, 2, 3]
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateRoleSampleRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"permissions": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"readOnly": true
}
},
"example": {
"name": "Admin",
"permissions": [1, 2]
}
},
"FireHost.Infrastructure.RBAC.Data.Domain.RoleUser": {
"type": "object",
"properties": {
"roleId": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"isEnabled": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Billing.Data.Persistence.ProductList": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"category": {
"type": "string"
},
"currency": {
"type": "string"
},
"salesforceId": {
"type": "string"
}
}
},
"FireHost.Services.Http.Billing.Models.ProductListItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sku": {
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"typeCode": {
"type": "string"
},
"storagePolicyClass": {
"type": "string"
},
"chargeType": {
"type": "string"
},
"price": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.ProductItemLocationPrice"
}
},
"priceType": {
"type": "string"
},
"instanceSeries": {
"type": "string"
},
"cpu": {
"format": "int32",
"type": "integer"
},
"memory": {
"format": "int32",
"type": "integer"
},
"baseDiskSize": {
"format": "int32",
"type": "integer"
},
"baseDiskTier": {
"type": "string"
},
"operatingSystem": {
"type": "string"
},
"tier": {
"type": "string"
},
"min": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"increment": {
"format": "int32",
"type": "integer"
},
"billingOnly": {
"type": "boolean"
},
"hasRules": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Billing.Models.ProductItemLocationPrice": {
"type": "object",
"properties": {
"location": {
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"units": {
"format": "double",
"type": "number"
}
}
},
"FireHost.Services.Meta.ApiExamples.Models.UpdateNoteSampleRequest": {
"type": "object",
"properties": {
"messages": {
"type": "string",
"readOnly": true
}
},
"example": {
"messages": "This is a note!"
}
},
"FireHost.Services.Http.Meta.ApiExamples.Models.DeleteNoteSampleRequest": {
"type": "object",
"properties": {},
"example": {}
},
"FireHost.Services.Http.Accounts.Models.UserAccountDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"currency": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"parent": {
"format": "int32",
"type": "integer"
},
"products": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"accountType": {
"description": "Type of Account",
"type": "string"
},
"isSynced": {
"description": "To Check Whether Account Is Qualys Account",
"type": "boolean"
},
"isFreeTrial": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateAccountSampleRequest": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"readOnly": true
},
"addressLine2": {
"type": "string",
"readOnly": true
},
"city": {
"type": "string",
"readOnly": true
},
"state": {
"type": "string",
"readOnly": true
},
"postalCode": {
"type": "string",
"readOnly": true
},
"country": {
"type": "string",
"readOnly": true
}
},
"example": {
"addressLine1": "123 street",
"addressLine2": "ste 500",
"city": "City",
"state": "TX",
"postalCode": "75000",
"country": "US"
}
},
"FireHost.Services.Http.Accounts.Models.AccountDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"accountId": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"accountSignupType": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.Models.GetRolesResponse": {
"description": "Role Details",
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"isdefault": {
"type": "boolean"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.History.Models.AccountHistoryListResponseDto]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.History.Models.AccountHistoryListResponseDto"
}
}
}
},
"FireHost.Infrastructure.History.Models.AccountHistoryListResponseDto": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"type": {
"type": "string"
},
"date": {
"format": "date-time",
"type": "string"
},
"user": {
"type": "string"
},
"userId": {
"format": "int32",
"type": "integer"
},
"activity": {
"type": "string"
},
"details": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"isInternal": {
"type": "boolean"
},
"isArmor": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Accounts.Models.Requests.UpdateAccountPrimaryBillingContactRequest": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"accountId": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
},
"FireHost.Services.Rubrik.Response.BrowseFilesetFilesResponseDto": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Rubrik.Response.FileInfo"
}
},
"osGroup": {
"type": "string"
},
"hostName": {
"type": "string"
}
}
},
"FireHost.Services.Rubrik.Response.FileInfo": {
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"path": {
"type": "string"
},
"lastModified": {
"format": "date-time",
"type": "string"
},
"size": {
"format": "double",
"type": "number"
},
"fileMode": {
"type": "string"
},
"statusMessage": {
"type": "string"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RestoreFilesetRequestSample": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Config"
}
},
"example": {
"config": {
"sourceDir": "\\example_path",
"destinationDir": "\\example_path",
"ignoreErrors": false
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.Config": {
"type": "object",
"properties": {
"sourceDir": {
"type": "string"
},
"destinationDir": {
"type": "string"
},
"ignoreErrors": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.VmHistoricalUsageRequestSample": {
"type": "object",
"properties": {
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"vmProtectionType": {
"format": "int32",
"type": "integer"
},
"vmList": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"example": {
"startDate": "2026-01-14T16:25:51.8723753+00:00",
"endDate": "2026-02-12T16:25:51.8723753+00:00",
"vmProtectionType": 0,
"vmList": [1, 2, 3]
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.VmHistoricalPhysicalStorageUsageDto": {
"type": "object",
"properties": {
"createdDate": {
"format": "date-time",
"type": "string"
},
"physicalStorage": {
"format": "int64",
"type": "integer"
},
"historicalIngestedStorage": {
"format": "int64",
"type": "integer"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.GetVmsHistoricalOverviewRequestSample": {
"type": "object",
"properties": {
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
}
},
"example": {
"startDate": "2026-01-14T16:25:51.9361054+00:00",
"endDate": "2026-02-12T16:25:51.9361054+00:00"
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.VmHistoricalOverviewDto": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"vmName": {
"type": "string"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.AdvancedBackup.Models.PoliciesListDto]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.PoliciesListDto"
}
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.PoliciesListDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"frequencies": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Frequencies"
}
},
"assets": {
"format": "int32",
"type": "integer"
},
"isInternal": {
"type": "boolean"
},
"location": {
"type": "string"
},
"slaDomainTypeId": {
"format": "int32",
"type": "integer"
},
"slaDomainTypeName": {
"type": "string"
},
"isReplicationEnabled": {
"type": "boolean"
},
"offsiteRetention": {
"format": "int32",
"type": "integer"
},
"isActive": {
"format": "int32",
"type": "integer"
},
"isCustomerDefault": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.Frequencies": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"frequency": {
"format": "int32",
"type": "integer"
},
"retention": {
"format": "int32",
"type": "integer"
},
"timeUnit": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.BackupPolicyRequestSample": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"frequencies": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Frequencies"
}
},
"firstFullAllowedBackupWindows": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FirstFullAllowedBackupWindows"
}
},
"isInternal": {
"type": "boolean"
},
"slaDomainTypeId": {
"format": "int32",
"type": "integer"
},
"isReplicationEnabled": {
"type": "boolean"
},
"replicationClusterId": {
"type": "string"
},
"retentionLimit": {
"format": "int64",
"type": "integer"
},
"isCustomerDefault": {
"type": "boolean"
}
},
"example": {
"name": "sample Name",
"frequencies": [{
"id": 0,
"frequency": 10,
"retention": 10,
"timeUnit": "Hourly",
"createdDate": "0001-01-01T00:00:00"
}],
"firstFullAllowedBackupWindows": [{
"startTimeAttributes": {
"id": 0,
"minutes": 2,
"hour": 2,
"dayOfWeek": 2
},
"durationInHours": 2,
"isFirstFullBackupWindow": false,
"createdDate": "0001-01-01T00:00:00"
}],
"isInternal": false,
"slaDomainTypeId": 1,
"isReplicationEnabled": false,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"retentionLimit": 32,
"isCustomerDefault": false
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.FirstFullAllowedBackupWindows": {
"type": "object",
"properties": {
"startTimeAttributes": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.StartTimeAttributes"
},
"durationInHours": {
"format": "int32",
"type": "integer"
},
"isFirstFullBackupWindow": {
"type": "boolean"
},
"createdDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.AllowedBackupWindows": {
"type": "object",
"properties": {
"startTimeAttributes": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.StartTimeAttributes"
},
"durationInHours": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.StartTimeAttributes": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"minutes": {
"format": "int32",
"type": "integer"
},
"hour": {
"format": "int32",
"type": "integer"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.AdvancedBackup.Models.BackupPolicyRequestDto]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": ""
}
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.BackupPolicyResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"totalDbs": {
"format": "int32",
"type": "integer"
},
"totalFilesets": {
"format": "int32",
"type": "integer"
},
"totalVms": {
"format": "int32",
"type": "integer"
},
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"isInternal": {
"type": "boolean"
},
"primaryClusterId": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"etag": {
"type": "string"
},
"etagString": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"rubrikName": {
"type": "string"
},
"frequencies": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Frequencies"
}
},
"backupWindows": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.BackupWindows"
}
},
"allowedBackupWindows": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.BackupWindows"
}
},
"locationId": {
"format": "int32",
"type": "integer"
},
"podId": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "int32",
"type": "integer"
},
"totalSlaInUse": {
"format": "int32",
"type": "integer"
},
"slaDomainTypeId": {
"format": "int32",
"type": "integer"
},
"slaDomainTypeName": {
"type": "string"
},
"typeCode": {
"format": "int32",
"type": "integer"
},
"isAssignedToMultipleAccount": {
"type": "boolean"
},
"mappedAccountId": {
"format": "int32",
"type": "integer"
},
"isReplicationEnabled": {
"type": "boolean"
},
"replicationClusterId": {
"type": "string"
},
"retentionLimit": {
"format": "int64",
"type": "integer"
},
"isCustomerDefault": {
"type": "boolean"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.BackupWindows": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"minutes": {
"format": "int32",
"type": "integer"
},
"hour": {
"format": "int32",
"type": "integer"
},
"dayOfWeek": {
"format": "int32",
"type": "integer"
},
"durationInHours": {
"format": "int32",
"type": "integer"
},
"isFirstFullBackupWindow": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.BackupPolicyRequestDtoSample": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"frequencies": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Frequencies"
}
},
"firstFullAllowedBackupWindows": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FirstFullAllowedBackupWindows"
}
},
"allowedBackupWindows": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.AllowedBackupWindows"
}
},
"locationId": {
"format": "int32",
"type": "integer"
},
"isInternal": {
"type": "boolean"
},
"etag": {
"type": "string"
},
"rubrikId": {
"type": "string"
},
"slaDomainTypeId": {
"format": "int32",
"type": "integer"
},
"isReplicationEnabled": {
"type": "boolean"
},
"replicationClusterId": {
"type": "string"
},
"retentionLimit": {
"format": "int64",
"type": "integer"
},
"isCustomerDefault": {
"type": "boolean"
}
},
"example": {
"name": "sample Name",
"frequencies": [{
"id": 0,
"frequency": 10,
"retention": 10,
"timeUnit": "Hourly",
"createdDate": "0001-01-01T00:00:00"
}],
"firstFullAllowedBackupWindows": [{
"startTimeAttributes": {
"id": 0,
"minutes": 2,
"hour": 2,
"dayOfWeek": 2
},
"durationInHours": 2,
"isFirstFullBackupWindow": false,
"createdDate": "0001-01-01T00:00:00"
}],
"allowedBackupWindows": [],
"locationId": 1,
"isInternal": false,
"etag": "0x000000000000000",
"rubrikId": "00000000-0000-0000-0000-000000000000",
"slaDomainTypeId": 1,
"isReplicationEnabled": false,
"replicationClusterId": "00000000-0000-0000-0000-000000000000",
"retentionLimit": 10,
"isCustomerDefault": false
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.SnapshotRequestSample": {
"type": "object",
"properties": {
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
}
},
"example": {
"startDate": "2026-02-12T16:25:52.2712739Z",
"endDate": "2026-02-12T16:25:52.2712739Z"
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.SnapShotDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"snapshotId": {
"type": "string"
},
"vmName": {
"type": "string"
},
"slaName": {
"type": "string"
},
"snapshotDate": {
"format": "date-time",
"type": "string"
},
"snapshotExpiryDate": {
"format": "date-time",
"type": "string"
},
"isOnDemandSnapshot": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"slaDomainId": {
"type": "string"
},
"isCorrupted": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RestoreVmSnapshotRequestSample": {
"type": "object",
"properties": {
"snapshotId": {
"type": "string"
}
},
"example": {
"snapshotId": "00000000-0000-0000-0000-000000000000"
}
},
"FireHost.Infrastructure.AdvancedBackup.Data.Domain.VmRubrikDetailDto": {
"type": "object",
"properties": {
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"isEnabled": {
"type": "boolean"
},
"lastBackupDate": {
"format": "date-time",
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"userName": {
"type": "string"
},
"applianceUrl": {
"type": "string"
},
"applianceCredentialId": {
"type": "string"
},
"rubrikVmId": {
"type": "string"
},
"clusterUuId": {
"type": "string"
},
"location": {
"type": "string"
},
"isAgentRegistered": {
"type": "boolean"
},
"vsphereVmName": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.SnapshotRestoreActionRequestSample": {
"type": "object",
"properties": {
"sagaId": {
"type": "string"
},
"customerCommitted": {
"type": "boolean"
},
"snapShotId": {
"type": "string"
},
"statusDescription": {
"type": "string"
}
},
"example": {
"sagaId": "00000000-0000-0000-0000-000000000000",
"customerCommitted": true,
"snapShotId": "00000000-0000-0000-0000-000000000000",
"statusDescription": "sample description"
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.ExternalSlaDomainDto": {
"type": "object",
"properties": {
"rubrikSlaDomainId": {
"format": "int32",
"type": "integer"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"timeunit": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"slaDomainTypeId": {
"format": "int32",
"type": "integer"
},
"slaDomainTypeName": {
"type": "string"
},
"frequencies": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Frequencies"
}
},
"isCustomerDefault": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.ProtectedVmDetailDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"podId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"rubrikSlaDomainId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.UpdateVmPolicyRequestSample": {
"type": "object",
"properties": {
"slaDomainId": {
"format": "int32",
"type": "integer"
},
"vmId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"slaDomainId": 1,
"vmId": 1
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.UnprotectedVmsDetailDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"memory": {
"format": "int32",
"type": "integer"
},
"storage": {
"format": "int32",
"type": "integer"
},
"podId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"disks": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Common.Events.AdvancedBackup.VmDiskDto"
}
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Services.Common.Events.AdvancedBackup.VmDiskDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"storageId": {
"format": "int32",
"type": "integer"
},
"diskName": {
"type": "string"
},
"vcdDiskName": {
"type": "string"
},
"deviceKey": {
"format": "int32",
"type": "integer"
},
"size": {
"format": "int32",
"type": "integer"
},
"isIncluded": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.UnprotectedVmsRequestSample": {
"type": "object",
"properties": {
"locationId": {
"format": "int32",
"type": "integer"
},
"slaDomainId": {
"format": "int32",
"type": "integer"
},
"vmIds": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"example": {
"locationId": 1,
"slaDomainId": 1,
"vmIds": [1, 2, 3]
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.UnprotectedVmRequestDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"disks": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.UnprotectedVmDiskRequestDto"
}
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.UnprotectedVmDiskRequestDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"vcdDiskName": {
"type": "string"
},
"isIncluded": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.DefaultPolicyDto": {
"type": "object",
"properties": {
"policyId": {
"format": "int32",
"type": "integer"
},
"policyName": {
"type": "string"
},
"frequency": {
"format": "int32",
"type": "integer"
},
"retention": {
"format": "int32",
"type": "integer"
},
"timeUnit": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"podId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.RubrikApplianceListDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"description": {
"type": "string"
},
"version": {
"type": "string"
},
"podId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"replicationPodId": {
"format": "int32",
"type": "integer"
},
"replicationLocationData": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.ReplicationLocationDto"
}
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.ReplicationLocationDto": {
"type": "object",
"properties": {
"replicationLocation": {
"type": "string"
},
"replicationLocationId": {
"format": "int32",
"type": "integer"
},
"replicationClusterId": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Data.Domain.RubrikSlaDomainType": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"FireHost.Services.Rubrik.Response.BrowseFilesResponseDto": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Rubrik.Response.FileInfo"
}
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RestoreVmFileSample": {
"type": "object",
"properties": {
"sourcePath": {
"type": "string"
},
"destinationPath": {
"type": "string"
}
},
"example": {
"sourcePath": "\\example_path",
"destinationPath": "\\example_path"
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.ActivityLogDto": {
"type": "object",
"properties": {
"taskId": {
"type": "string"
},
"event": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"snapshotDate": {
"format": "date-time",
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"isPublic": {
"type": "boolean"
},
"userId": {
"format": "int32",
"type": "integer"
},
"startTime": {
"format": "date-time",
"type": "string"
},
"endTime": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.RegisterAgentRequestDto": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.DefaultPolicyForAccountDto": {
"type": "object",
"properties": {
"isDefaultExist": {
"type": "boolean"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"podId": {
"format": "int32",
"type": "integer"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.UpdateBackupVmStorageDetailsRequestSample": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"disks": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.ProtectedVmDiskRequestDto"
}
}
},
"example": {
"vmId": 1,
"disks": [{
"diskId": 1,
"name": "Disk 1",
"nameId": "Hard disk 1",
"isBackupEnabled": true,
"size": 0,
"isRubrikDiscovered": false
}, {
"diskId": 2,
"name": "Disk 2",
"nameId": "Hard disk 2",
"isBackupEnabled": false,
"size": 0,
"isRubrikDiscovered": false
}]
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.ProtectedVmDiskRequestDto": {
"type": "object",
"properties": {
"diskId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"nameId": {
"type": "string"
},
"isBackupEnabled": {
"type": "boolean"
},
"size": {
"format": "int32",
"type": "integer"
},
"isRubrikDiscovered": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"agentId": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"vmName": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"location": {
"type": "string"
},
"osName": {
"type": "string"
},
"status": {
"type": "string"
},
"fileSetsCsv": {
"type": "string"
},
"policiesCsv": {
"type": "string"
},
"localStorageCsv": {
"type": "string"
},
"fileSets": {
"type": "array",
"items": {
"type": "string"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.Policy"
}
},
"totalStorage": {
"format": "double",
"type": "number"
},
"applianceUrl": {
"type": "string"
},
"applianceCredentialId": {
"type": "string"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"primaryClusterId": {
"type": "string"
},
"osId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"userId": {
"type": "string"
},
"localUsageCsv": {
"type": "string"
},
"localUsage": {
"format": "int64",
"type": "integer"
},
"localArchiveUsage": {
"format": "int64",
"type": "integer"
},
"replicationArchiveUsage": {
"format": "int64",
"type": "integer"
},
"replicationUsageCsv": {
"type": "string"
},
"replicationUsage": {
"format": "int64",
"type": "integer"
},
"storageUsed": {
"format": "int64",
"type": "integer",
"readOnly": true
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.Policy": {
"type": "object",
"properties": {
"policyId": {
"format": "int32",
"type": "integer"
},
"policyName": {
"type": "string"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.AddRubrikHostRequestSample": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"vmId": 1
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.FilesetTemplateRequestDetailstSample": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"doNotExclude": {
"type": "array",
"items": {
"type": "string"
}
},
"operatingSystemType": {
"type": "string"
},
"etag": {
"type": "string"
},
"rubrikId": {
"type": "string"
}
},
"example": {
"name": "sample name",
"locationId": 1,
"include": ["/usr/example"],
"exclude": ["/usr/example"],
"doNotExclude": ["/usr/example"],
"operatingSystemType": "Linux",
"etag": "0x000000000000",
"rubrikId": "00000000-0000-0000-0000-000000000000"
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.FileSetTemplateListDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"rubrikName": {
"type": "string"
},
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"isInternal": {
"type": "boolean"
},
"operatingSystemType": {
"type": "string"
},
"hostCount": {
"format": "int32",
"type": "integer"
},
"createdBy": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"location": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"include": {
"type": "string"
},
"exclude": {
"type": "string"
},
"doNotExclude": {
"type": "string"
},
"userId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.FilesetTemplateResponseDetailsDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"rubrikName": {
"type": "string"
},
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"primaryClusterId": {
"type": "string"
},
"isInternal": {
"type": "boolean"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"filesetTemplateShareType": {
"type": "string"
},
"operatingSystemType": {
"type": "string"
},
"hostCount": {
"format": "int32",
"type": "integer"
},
"allowBackupNetworkMounts": {
"type": "boolean"
},
"allowBackupHiddenFoldersInNetworkMounts": {
"type": "boolean"
},
"preBackupScript": {
"type": "string"
},
"postBackupScript": {
"type": "string"
},
"backupScriptTimeout": {
"format": "int32",
"type": "integer"
},
"backupScriptErrorHandling": {
"type": "string"
},
"isArchived": {
"type": "boolean"
},
"shareCount": {
"format": "int32",
"type": "integer"
},
"useWindowsVss": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"etag": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude": {
"type": "array",
"items": {
"type": "string"
}
},
"doNotExclude": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.VmDetailDto": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"vmName": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"location": {
"type": "string"
},
"osFamily": {
"type": "string"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.CreateFileSetRequestSample": {
"type": "object",
"properties": {
"hostName": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"fileSets": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.AdvancedBackup.Models.FileSetDto"
}
}
},
"example": {
"hostName": "sample host name",
"vmId": 1,
"fileSets": [{
"hostId": 0,
"configureSlaDomainId": 1,
"effectiveSlaDomainId": 0,
"fileSetTemplateId": 1,
"accountId": 0,
"rubrikApplianceId": 0,
"localStorage": 0,
"archiveStorage": 0,
"localUsage": 0,
"replicationUsage": 0,
"replicationArchiveUsage": 0,
"id": 0,
"createdDate": "0001-01-01T00:00:00"
}]
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.FileSetDto": {
"type": "object",
"properties": {
"hostId": {
"format": "int32",
"type": "integer"
},
"rubrikConfiguredSlaDomainId": {
"type": "string"
},
"rubrikFileSetTemplateId": {
"type": "string"
},
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"name": {
"type": "string"
},
"rubrikHostId": {
"type": "string"
},
"configureSlaDomainId": {
"format": "int32",
"type": "integer"
},
"effectiveSlaDomainId": {
"format": "int32",
"type": "integer"
},
"fileSetTemplateId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"localStorage": {
"format": "int64",
"type": "integer"
},
"archiveStorage": {
"format": "int64",
"type": "integer"
},
"vmName": {
"type": "string"
},
"location": {
"type": "string"
},
"osFamily": {
"type": "string"
},
"localUsage": {
"format": "int64",
"type": "integer"
},
"replicationUsage": {
"format": "int64",
"type": "integer"
},
"replicationArchiveUsage": {
"format": "int64",
"type": "integer"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.FilesetsListDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"configuredSlaDomainId": {
"format": "int32",
"type": "integer"
},
"effectiveSlaDomainId": {
"format": "int32",
"type": "integer"
},
"fileSetTemplateId": {
"format": "int32",
"type": "integer"
},
"storageUsed": {
"format": "double",
"type": "number"
},
"policyId": {
"format": "int32",
"type": "integer"
},
"policyName": {
"type": "string"
},
"hostId": {
"format": "int32",
"type": "integer"
},
"vmName": {
"type": "string"
},
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"location": {
"type": "string"
},
"osFamily": {
"type": "string"
},
"localUsage": {
"format": "int64",
"type": "integer"
},
"archiveUsage": {
"format": "int64",
"type": "integer"
},
"replicationUsage": {
"format": "int64",
"type": "integer"
},
"replicationArchiveUsage": {
"format": "int64",
"type": "integer"
},
"totalStorageUsed": {
"format": "int64",
"type": "integer",
"readOnly": true
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.RemoveFilesetByIdRequestSample": {
"type": "object",
"properties": {
"fileSetId": {
"format": "int32",
"type": "integer"
},
"preserveSnapshots": {
"type": "boolean"
}
},
"example": {
"fileSetId": 1,
"preserveSnapshots": true
}
},
"FireHost.Infrastructure.AdvancedBackup.Data.Domain.FileSet": {
"type": "object",
"properties": {
"rubrikId": {
"type": "string"
},
"rubrikCloudId": {
"type": "string"
},
"name": {
"type": "string"
},
"rubrikHostId": {
"type": "string"
},
"configureSlaDomainId": {
"format": "int32",
"type": "integer"
},
"effectiveSlaDomainId": {
"format": "int32",
"type": "integer"
},
"fileSetTemplateId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"rubrikApplianceId": {
"format": "int32",
"type": "integer"
},
"localStorage": {
"format": "int64",
"type": "integer"
},
"archiveStorage": {
"format": "int64",
"type": "integer"
},
"hostId": {
"format": "int32",
"type": "integer"
},
"vmName": {
"type": "string"
},
"location": {
"type": "string"
},
"osFamily": {
"type": "string"
},
"localUsage": {
"format": "int64",
"type": "integer"
},
"replicationUsage": {
"format": "int64",
"type": "integer"
},
"replicationArchiveUsage": {
"format": "int64",
"type": "integer"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostOverviewDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"vmName": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"location": {
"type": "string"
},
"osName": {
"type": "string"
},
"status": {
"type": "string"
},
"filesets": {
"format": "int32",
"type": "integer"
},
"totalLocalUsage": {
"format": "int64",
"type": "integer"
},
"totalArchiveUsage": {
"format": "int64",
"type": "integer"
},
"osFamily": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"totalReplicationUsage": {
"format": "int64",
"type": "integer"
},
"totalReplicationArchiveUsage": {
"format": "int64",
"type": "integer"
},
"storageUsed": {
"format": "int64",
"type": "integer",
"readOnly": true
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.HostDetailsByIdRequestSample": {
"type": "object",
"properties": {
"startDate": {
"format": "date-time",
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
}
},
"example": {
"startDate": "2026-02-12T16:25:53.8155916Z",
"endDate": "2026-02-12T16:25:53.8155916Z"
}
},
"FireHost.Services.Common.Query.QueryOptions": {
"type": "object",
"properties": {
"request": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"rawValues": {
"$ref": "#/definitions/FireHost.Services.Common.Query.RawQueryOptions",
"readOnly": true
},
"filter": {
"$ref": "#/definitions/FireHost.Services.Common.Query.FilterOption",
"readOnly": true
},
"orderBy": {
"$ref": "#/definitions/FireHost.Services.Common.Query.OrderByOption",
"readOnly": true
},
"searchPhrase": {
"type": "string",
"readOnly": true
},
"paging": {
"$ref": "#/definitions/FireHost.Services.Common.Query.PagingOptions",
"readOnly": true
},
"validator": {
"$ref": "#/definitions/FireHost.Services.Common.Query.Validation.IQueryOptionValidator",
"readOnly": true
}
}
},
"FireHost.Services.Common.Query.RawQueryOptions": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"readOnly": true
},
"searchPhrase": {
"type": "string"
},
"orderBy": {
"type": "string",
"readOnly": true
},
"skip": {
"type": "string",
"readOnly": true
},
"top": {
"type": "string",
"readOnly": true
}
}
},
"FireHost.Services.Common.Query.FilterOption": {
"type": "object",
"properties": {
"expression": {
"type": "string",
"readOnly": true
},
"filters": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
}
}
}
},
"FireHost.Services.Common.Query.OrderByOption": {
"type": "object",
"properties": {
"expression": {
"type": "string",
"readOnly": true
},
"field": {
"type": "string"
},
"direction": {
"format": "int32",
"enum": [0, 1],
"type": "integer"
}
}
},
"FireHost.Services.Common.Query.PagingOptions": {
"type": "object",
"properties": {
"top": {
"format": "int32",
"type": "integer"
},
"skip": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Common.Query.Validation.IQueryOptionValidator": {
"type": "object",
"properties": {}
},
"FireHost.Infrastructure.AdvancedBackup.Models.RubrikHostSnapshotDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"rubrikSnapshotId": {
"type": "string"
},
"filesetName": {
"type": "string"
},
"snapshotDate": {
"format": "date-time",
"type": "string"
},
"filesetId": {
"format": "int32",
"type": "integer"
},
"rubrikFilesetId": {
"type": "string"
},
"fileCount": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.AdvancedBackup.ApiExample.Models.UpdateFileSetRequestSample": {
"type": "object",
"properties": {
"hostId": {
"format": "int32",
"type": "integer"
},
"fileSetId": {
"format": "int32",
"type": "integer"
},
"policyId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"hostId": 1,
"fileSetId": 1,
"policyId": 1
}
},
"FireHost.Services.Http.Auth.ApiExamples.Models.AuthorizeAsyncSampleRequest": {
"type": "object",
"properties": {
"username": {
"type": "string",
"readOnly": true
},
"password": {
"type": "string",
"readOnly": true
}
},
"example": {
"username": "admin@example.com",
"password": "password"
}
},
"FireHost.Services.Http.Auth.Models.OAuthAccessResponse": {
"type": "object",
"properties": {
"redirect_uri": {
"type": "string"
},
"code": {
"type": "string"
},
"success": {
"type": "boolean"
},
"validation_required": {
"type": "boolean"
},
"client_id": {
"type": "string"
}
}
},
"FireHost.Services.Http.Auth.ApiExamples.Models.TokenAsyncSampleRequest": {
"type": "object",
"properties": {
"grant_type": {
"type": "string"
},
"code": {
"type": "string",
"readOnly": true
}
},
"example": {
"grant_type": "authorization_code",
"code": "VGhpcyBpcyBzb21lIHRleHQgdG8gY29udmVydCB2aWEgQ3J5cHQu="
}
},
"FireHost.Services.Http.Auth.Models.OAuthTokenResponse": {
"description": "The OAuth token response.",
"type": "object",
"properties": {
"access_token": {
"description": "Gets or sets the access token used to assert access to and permissions within an application.",
"type": "string"
},
"id_token": {
"description": "Gets or sets the JWT token providing basic user identity.",
"type": "string"
},
"expires_in": {
"format": "int32",
"description": "Gets or sets the expiration of the included tokens (in seconds from now).",
"type": "integer"
},
"token_type": {
"description": "Gets the token type.",
"type": "string",
"readOnly": true
},
"refresh_token": {
"description": "Gets or sets the refresh token.",
"type": "string"
}
}
},
"FireHost.Services.Http.Auth.Models.OAuthTokenReissueRequest": {
"description": "The OAuth token reissue request.",
"type": "object",
"properties": {
"token": {
"description": "Gets or sets the token.",
"type": "string"
}
},
"example": {
"token": "2261bac252204c2ea93ed32ea1ffd3ab"
}
},
"FireHost.Services.Http.Accounts.Models.MeResponse": {
"type": "object",
"properties": {
"user": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.UserDto",
"readOnly": true
},
"accounts": {
"description": "accounts for current user",
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.UserAccountDto"
}
},
"departments": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.UserDepartmentDto"
},
"readOnly": true
},
"permissions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"readOnly": true
},
"features": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.FeatureFlag"
}
}
}
},
"FireHost.Services.Http.Accounts.Models.UserDto": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"username": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"links": {
"$ref": "#/definitions/System.Object"
},
"passwordExpiry": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.Models.UserDepartmentDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"account": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Accounts.Models.FeatureFlag": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"feature": {
"type": "string",
"readOnly": true
},
"productId": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
},
"FireHost.Infrastructure.Accounts.Data.UserIdResponse": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"isSubscriberKeyCreated": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.ServiceHealthStats": {
"type": "object",
"properties": {
"totalNeedsAttention": {
"format": "int32",
"type": "integer"
},
"totalOk": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.CoreAgentVersionResponse": {
"type": "object",
"properties": {
"goLiveDate": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "string"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.OverallHealthStats": {
"type": "object",
"properties": {
"needsAttentionCount": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"okCount": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"total": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"coreInstanceId": {
"type": "string"
},
"zone": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"healthDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.HealthMonitoring.Models.HealthDetail"
}
},
"calculatedNeedsAttentionCount": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.HealthDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"message": {
"type": "string"
},
"messageHoverText": {
"type": "string"
},
"duration": {
"format": "date-time",
"type": "string"
},
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"subAgentVersion": {
"type": "string"
},
"subAgentProductName": {
"type": "string"
},
"hideServices": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsResponse": {
"type": "object",
"properties": {
"healthDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.HealthMonitoring.Models.HealthDetail"
}
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.HealthStatusDetailsPublicResponse": {
"type": "object",
"properties": {
"healthDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.HealthMonitoring.Models.HealthDetailPublic"
}
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.HealthDetailPublic": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"message": {
"type": "string"
},
"messageHoverText": {
"type": "string"
},
"subAgentVersion": {
"type": "string"
},
"subAgentProductName": {
"type": "string"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.LogHealthDetails": {
"type": "object",
"properties": {
"lastLogSent": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.HealthMonitoring.Models.SubAgentVersion": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.AccountVmDto": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"providerRefId": {
"type": "string"
},
"provider": {
"type": "string"
},
"hostName": {
"type": "string"
},
"externalAddress": {
"type": "string"
},
"isRegistered": {
"type": "boolean"
},
"dateRegistered": {
"format": "date-time",
"type": "string"
},
"lastPing": {
"format": "date-time",
"type": "string"
},
"needsReboot": {
"type": "boolean"
},
"customProvider": {
"type": "string"
},
"customLocation": {
"type": "string"
},
"instanceType": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"isCore": {
"type": "boolean"
},
"externalVmIsDeleted": {
"type": "boolean"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"workLoadId": {
"format": "int32",
"type": "integer"
},
"workLoadName": {
"type": "string"
},
"location": {
"type": "string"
},
"operatingSystem": {
"type": "string"
},
"isArmor": {
"type": "boolean"
},
"ipAddress": {
"type": "string"
},
"zone": {
"type": "string"
},
"name": {
"type": "string"
},
"cpu": {
"format": "int32",
"type": "integer"
},
"memory": {
"format": "int32",
"type": "integer"
},
"storage": {
"format": "int32",
"type": "integer"
},
"statusId": {
"format": "int32",
"type": "integer"
},
"deployed": {
"type": "boolean"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isRecoveryVm": {
"type": "boolean"
},
"product": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.ProductDetail"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"scheduledEvents": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.TaskResponse"
}
},
"vmServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.VmService"
}
},
"multiVmVapp": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Compute.Models.ProductDetail": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"size": {
"type": "string"
},
"isExpired": {
"type": "boolean"
},
"storagePolicyClass": {
"type": "string"
},
"productCategory": {
"type": "string"
},
"productSubCategory": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.Requests.TaskResponse": {
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"entityId": {
"type": "string"
},
"action": {
"type": "string"
},
"taskDate": {
"format": "date-time",
"type": "string"
},
"maintenanceWindow": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Compute.Data.Domain.VmService": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"sku": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"id": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"createdBy": {
"type": "string"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.AccountSimpleVmDto": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"hostName": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.AccountVmWithCloudConnectionsDto": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"providerRefId": {
"type": "string"
},
"provider": {
"type": "string"
},
"hostName": {
"type": "string"
},
"hostType": {
"type": "string"
},
"externalAddress": {
"type": "string"
},
"isRegistered": {
"type": "boolean"
},
"dateRegistered": {
"format": "date-time",
"type": "string"
},
"lastPing": {
"format": "date-time",
"type": "string"
},
"latestCommunicationTimestamp": {
"format": "date-time",
"type": "string"
},
"needsReboot": {
"type": "boolean"
},
"customProvider": {
"type": "string"
},
"customLocation": {
"type": "string"
},
"instanceType": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"isCore": {
"type": "boolean"
},
"externalVmIsDeleted": {
"type": "boolean"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"workLoadId": {
"format": "int32",
"type": "integer"
},
"workLoadName": {
"type": "string"
},
"location": {
"type": "string"
},
"operatingSystem": {
"type": "string"
},
"isArmor": {
"type": "boolean"
},
"ipAddress": {
"type": "string"
},
"zone": {
"type": "string"
},
"name": {
"type": "string"
},
"cpu": {
"format": "int32",
"type": "integer"
},
"memory": {
"format": "int32",
"type": "integer"
},
"storage": {
"format": "int32",
"type": "integer"
},
"statusId": {
"format": "int32",
"type": "integer"
},
"deployed": {
"type": "boolean"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isRecoveryVm": {
"type": "boolean"
},
"product": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.ProductDetail"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"scheduledEvents": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.TaskResponse"
}
},
"vmServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.VmService"
}
},
"awsAmi": {
"type": "string"
},
"awsSecurityGroups": {
"type": "string"
},
"awsKeyPair": {
"type": "string"
},
"dateCreatedFrom": {
"type": "string"
},
"region": {
"type": "string"
},
"isHealthy": {
"type": "boolean"
},
"state": {
"type": "string",
"readOnly": true
},
"stateDescription": {
"type": "string",
"readOnly": true
},
"healthStatuses": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.VmHealthStatusDto"
}
},
"advBackupStatus": {
"type": "boolean"
},
"advBackupSku": {
"type": "string"
},
"vmBackupInProgress": {
"type": "boolean"
},
"profileName": {
"type": "string"
},
"multiVmVapp": {
"type": "boolean"
},
"osProvider": {
"type": "string"
},
"currentOsName": {
"type": "string"
},
"currentOsId": {
"format": "int32",
"type": "integer"
},
"rebootMessage": {
"type": "string"
},
"isWafProtected": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Compute.Models.VmHealthStatusDto": {
"type": "object",
"properties": {
"ruleFamily": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.VmDetail": {
"type": "object",
"properties": {
"hostType": {
"type": "string"
},
"canUseFluidScale": {
"type": "boolean"
},
"disks": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Disk"
}
},
"isDeleted": {
"type": "boolean"
},
"canReplicate": {
"type": "boolean"
},
"id": {
"format": "int32",
"type": "integer"
},
"coreInstanceId": {
"type": "string"
},
"biosUuid": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"appId": {
"format": "int32",
"type": "integer"
},
"appName": {
"type": "string"
},
"osId": {
"type": "string"
},
"os": {
"type": "string"
},
"deployed": {
"type": "boolean"
},
"cpu": {
"format": "int32",
"type": "integer"
},
"memory": {
"format": "int32",
"type": "integer"
},
"storage": {
"format": "int32",
"type": "integer"
},
"notes": {
"type": "string"
},
"vCenterId": {
"format": "int32",
"type": "integer"
},
"vCenterName": {
"type": "string"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isRecoveryVm": {
"type": "boolean"
},
"coreDateRegistered": {
"format": "date-time",
"type": "string"
},
"coreLastPing": {
"format": "date-time",
"type": "string"
},
"latestCommunicationTimestamp": {
"format": "date-time",
"type": "string"
},
"vmDateCreated": {
"format": "date-time",
"type": "string"
},
"product": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.ProductDetail"
},
"vmServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.VmService"
}
},
"uuid": {
"type": "string"
},
"isHealthy": {
"type": "boolean"
},
"health": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"scheduledEvents": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.TaskResponse"
}
},
"advBackupStatus": {
"type": "boolean"
},
"advBackupSku": {
"type": "string"
},
"vmBackupInProgress": {
"type": "boolean"
},
"profileName": {
"type": "string"
},
"multiVmVapp": {
"type": "boolean"
},
"osProvider": {
"type": "string"
},
"currentOsName": {
"type": "string"
},
"currentOsId": {
"format": "int32",
"type": "integer"
},
"needsReboot": {
"type": "boolean"
},
"rebootMessage": {
"type": "string"
},
"dsmUrl": {
"type": "string"
},
"isWafProtected": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Compute.Models.Disk": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"capacity": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"scsiBusNo": {
"format": "int32",
"type": "integer"
},
"scsiUnitNo": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Compute.ApiExamples.Models.UpdateAppSampleRequest": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
}
},
"example": {
"id": 1,
"name": "VMW Workload"
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.DeleteVmRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"userEmail": {
"type": "string"
},
"isActive": {
"type": "boolean"
}
},
"example": {
"accountId": 2,
"vmId": 6,
"userEmail": "test.dev@armor.com",
"isActive": true
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.AdjustVmResourcesRequest": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"user": {
"type": "string"
},
"sku": {
"type": "string"
}
},
"example": {
"vmId": 6,
"accountId": 2,
"user": "test.dev@armor.com",
"sku": "A1-122"
}
},
"FireHost.Infrastructure.Compute.Models.CoreVmDetail": {
"type": "object",
"properties": {
"hostType": {
"type": "string"
},
"providerRefId": {
"type": "string"
},
"providerId": {
"format": "int32",
"type": "integer"
},
"agentVersion": {
"type": "string"
},
"activationKey": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"coreInstanceId": {
"type": "string"
},
"biosUuid": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"appId": {
"format": "int32",
"type": "integer"
},
"appName": {
"type": "string"
},
"osId": {
"type": "string"
},
"os": {
"type": "string"
},
"deployed": {
"type": "boolean"
},
"cpu": {
"format": "int32",
"type": "integer"
},
"memory": {
"format": "int32",
"type": "integer"
},
"storage": {
"format": "int32",
"type": "integer"
},
"notes": {
"type": "string"
},
"vCenterId": {
"format": "int32",
"type": "integer"
},
"vCenterName": {
"type": "string"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isRecoveryVm": {
"type": "boolean"
},
"coreDateRegistered": {
"format": "date-time",
"type": "string"
},
"coreLastPing": {
"format": "date-time",
"type": "string"
},
"latestCommunicationTimestamp": {
"format": "date-time",
"type": "string"
},
"vmDateCreated": {
"format": "date-time",
"type": "string"
},
"product": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.ProductDetail"
},
"vmServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.VmService"
}
},
"uuid": {
"type": "string"
},
"isHealthy": {
"type": "boolean"
},
"health": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"scheduledEvents": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.TaskResponse"
}
},
"advBackupStatus": {
"type": "boolean"
},
"advBackupSku": {
"type": "string"
},
"vmBackupInProgress": {
"type": "boolean"
},
"profileName": {
"type": "string"
},
"multiVmVapp": {
"type": "boolean"
},
"osProvider": {
"type": "string"
},
"currentOsName": {
"type": "string"
},
"currentOsId": {
"format": "int32",
"type": "integer"
},
"needsReboot": {
"type": "boolean"
},
"rebootMessage": {
"type": "string"
},
"dsmUrl": {
"type": "string"
},
"isWafProtected": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Perimeter.Data.Domain.Profile.ProfileRequest": {
"type": "object",
"properties": {
"profileName": {
"type": "string"
}
},
"example": {
"profileName": "Log Collector"
}
},
"FireHost.Infrastructure.Compute.Data.Domain.AccountAutoAgePolicy": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"hoursGracePeriod": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Scheduling.Models.TaskResponse": {
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"entityId": {
"type": "string"
},
"action": {
"type": "string"
},
"taskDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Services.Http.Scheduling.Models.TaskRequest": {
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"entityId": {
"type": "string"
},
"action": {
"type": "string"
},
"extraInfo": {
"type": "string"
}
},
"example": {
"action": "delete"
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Scheduling.Data.Domain.FullTaskResponse]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Scheduling.Data.Domain.FullTaskResponse"
}
}
}
},
"FireHost.Infrastructure.Scheduling.Data.Domain.FullTaskResponse": {
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"entityId": {
"type": "string"
},
"action": {
"type": "string"
},
"taskDate": {
"format": "date-time",
"type": "string"
},
"vmName": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"accountName": {
"type": "string"
},
"type": {
"type": "string"
},
"summary": {
"type": "string"
},
"datetimeOfActivity": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.Orders.Data.Domain.Order": {
"type": "object",
"properties": {
"orderId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"appId": {
"format": "int32",
"type": "integer"
},
"dateOrdered": {
"format": "date-time",
"type": "string"
},
"status": {
"type": "string"
},
"jsonData": {
"type": "string"
},
"secret": {
"type": "string"
},
"createdBy": {
"type": "string"
}
}
},
"FireHost.Services.Http.Orders.ApiExamples.Models.PostVmOrderAsyncSampleRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"location": {
"type": "string",
"readOnly": true
},
"appId": {
"format": "int32",
"type": "integer"
},
"appName": {
"type": "string"
},
"tierId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tierName": {
"type": "string",
"readOnly": true
},
"storage": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.StorageOrderItem"
}
},
"secret": {
"type": "string",
"readOnly": true
},
"sku": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"vmProtectionPolicyId": {
"format": "int32",
"type": "integer",
"readOnly": true
}
},
"example": {
"name": "NewVirtualMachine",
"location": "dfw01",
"appId": -1,
"appName": "NewWorkload",
"tierId": -1,
"tierName": "NewTier",
"storage": [],
"secret": "kbwcEFufHBc$j#Z97HWMXdPCss",
"sku": "A1-101",
"quantity": 1,
"vmProtectionPolicyId": 1
}
},
"FireHost.Infrastructure.Orders.Models.StorageOrderItem": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer"
},
"mountPoint": {
"type": "string"
},
"fileSystem": {
"type": "string"
},
"size": {
"format": "int32",
"type": "integer"
},
"sku": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"model": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Orders.Models.SoftwareOrderItem": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.SoftwareInstallParameter"
}
},
"sku": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"model": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Orders.Models.SoftwareInstallParameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Orders.Models.OrderDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"status": {
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateCompleted": {
"format": "date-time",
"type": "string"
},
"vms": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.VmOrderItem"
}
},
"software": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.SoftwareOrderItem"
}
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.SubscriptionOrderItem"
}
}
}
},
"FireHost.Infrastructure.Orders.Models.VmOrderItem": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"appId": {
"format": "int32",
"type": "integer"
},
"appName": {
"type": "string"
},
"tierId": {
"format": "int32",
"type": "integer"
},
"tierName": {
"type": "string"
},
"storage": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.StorageOrderItem"
}
},
"software": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Orders.Models.SoftwareOrderItem"
}
},
"secret": {
"type": "string"
},
"templateId": {
"format": "int32",
"type": "integer"
},
"vmProtectionPolicyId": {
"format": "int32",
"type": "integer"
},
"sku": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"model": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Orders.Models.SubscriptionOrderItem": {
"type": "object",
"properties": {
"location": {
"type": "string"
},
"sku": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"model": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Orders.ApiExamples.Models.PostSubscriptionOrderAsyncSampleRequest": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"readOnly": true
},
"quantity": {
"format": "int32",
"type": "integer",
"readOnly": true
}
},
"example": {
"sku": "DB-SQL-EXPRESS-2012",
"quantity": 1
}
},
"FireHost.Infrastructure.Compute.Models.Application.ApplicationDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"deployed": {
"type": "boolean"
},
"tierCount": {
"format": "int32",
"type": "integer"
},
"vmCount": {
"format": "int32",
"type": "integer"
},
"totalCpu": {
"format": "int32",
"type": "integer"
},
"totalMemory": {
"format": "int32",
"type": "integer"
},
"totalStorage": {
"format": "int32",
"type": "integer"
},
"isRecoveryWorkload": {
"type": "boolean"
},
"notes": {
"type": "string"
},
"health": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"FireHost.Infrastructure.Compute.Models.Application.ApplicationDetail": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"deployed": {
"type": "boolean"
},
"tierCount": {
"format": "int32",
"type": "integer"
},
"vmCount": {
"format": "int32",
"type": "integer"
},
"totalCpu": {
"format": "int32",
"type": "integer"
},
"totalMemory": {
"format": "int32",
"type": "integer"
},
"totalStorage": {
"format": "int32",
"type": "integer"
},
"isRecoveryWorkload": {
"type": "boolean"
},
"tiers": {
"type": "array",
"items": {
"$ref": ""
}
},
"notes": {
"type": "string"
},
"health": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"FireHost.Services.Http.Compute.ApiExamples.Models.AddTierSampleRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
}
},
"example": {
"name": "New Tier 3"
}
},
"FireHost.Infrastructure.Compute.Models.VmDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"coreInstanceId": {
"type": "string"
},
"biosUuid": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"appId": {
"format": "int32",
"type": "integer"
},
"appName": {
"type": "string"
},
"osId": {
"type": "string"
},
"os": {
"type": "string"
},
"deployed": {
"type": "boolean"
},
"cpu": {
"format": "int32",
"type": "integer"
},
"memory": {
"format": "int32",
"type": "integer"
},
"storage": {
"format": "int32",
"type": "integer"
},
"notes": {
"type": "string"
},
"vCenterId": {
"format": "int32",
"type": "integer"
},
"vCenterName": {
"type": "string"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isRecoveryVm": {
"type": "boolean"
},
"coreDateRegistered": {
"format": "date-time",
"type": "string"
},
"coreLastPing": {
"format": "date-time",
"type": "string"
},
"latestCommunicationTimestamp": {
"format": "date-time",
"type": "string"
},
"vmDateCreated": {
"format": "date-time",
"type": "string"
},
"product": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.ProductDetail"
},
"vmServices": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.VmService"
}
},
"uuid": {
"type": "string"
},
"isHealthy": {
"type": "boolean"
},
"health": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"scheduledEvents": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.TaskResponse"
}
},
"advBackupStatus": {
"type": "boolean"
},
"advBackupSku": {
"type": "string"
},
"vmBackupInProgress": {
"type": "boolean"
},
"profileName": {
"type": "string"
},
"multiVmVapp": {
"type": "boolean"
},
"osProvider": {
"type": "string"
},
"currentOsName": {
"type": "string"
},
"currentOsId": {
"format": "int32",
"type": "integer"
},
"needsReboot": {
"type": "boolean"
},
"rebootMessage": {
"type": "string"
},
"dsmUrl": {
"type": "string"
},
"isWafProtected": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Compute.ApiExamples.Models.SampleAssignVmToWorkloadRequestDto": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"workloadId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"tierId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"accountId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"userName": {
"type": "string",
"readOnly": true
}
},
"example": {
"vmId": 1,
"workloadId": 2,
"tierId": 3,
"accountId": 4,
"userName": "example@armor.com"
}
},
"FireHost.Infrastructure.Compute.Models.Environment.LocationDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"name": {
"type": "string"
},
"zones": {
"type": "array",
"items": {
"type": "string"
}
},
"displayName": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.Stats.Requests.UtilizationStatsRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"interval": {
"type": "string"
},
"endDate": {
"format": "date-time",
"type": "string"
},
"startDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.Stats.VmStatsDto": {
"type": "object",
"properties": {
"vmId": {
"type": "string"
},
"cpu": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmStatPoint"
}
},
"memory": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmStatPoint"
}
},
"networkIn": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmStatPoint"
}
},
"networkOut": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmStatPoint"
}
}
}
},
"FireHost.Infrastructure.Compute.Models.Stats.VmStatPoint": {
"type": "object",
"properties": {
"t": {
"format": "date-time",
"type": "string"
},
"v": {
"format": "double",
"type": "number"
},
"s": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Compute.Models.Stats.VmAllStatsDto": {
"type": "object",
"properties": {
"vmId": {
"type": "string"
},
"vMstatPoints": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Stats.VmStatPoint"
}
}
}
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.StorageSummaryDto": {
"type": "object",
"properties": {
"vms": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.VmsStorageDto"
}
},
"templates": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.TemplateStorageSumDto"
}
}
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.VmsStorageDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"ssd": {
"format": "int32",
"type": "integer"
},
"fluid": {
"format": "int32",
"type": "integer"
},
"raw": {
"format": "int32",
"type": "integer"
},
"total": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.TemplateStorageSumDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"ssd": {
"format": "int32",
"type": "integer"
},
"fluid": {
"format": "int32",
"type": "integer"
},
"raw": {
"format": "int32",
"type": "integer"
},
"total": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Compute.Data.Domain.StorageProduct": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"sku": {
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"tier": {
"type": "string"
},
"min": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"increment": {
"format": "int32",
"type": "integer"
},
"price": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Data.Domain.ProductPrice"
}
}
}
},
"FireHost.Infrastructure.Compute.Data.Domain.ProductPrice": {
"type": "object",
"properties": {
"location": {
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
}
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.StorageOrderDto": {
"type": "object",
"properties": {
"storage": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.VmStorageDto"
}
},
"accountId": {
"format": "int32",
"type": "integer"
},
"accountName": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"storage": [{
"sku": "SAN-001",
"size": 10,
"isBackupEnabled": false
}]
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.VmStorageDto": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"size": {
"format": "int32",
"type": "integer"
},
"scsiBusNo": {
"format": "int32",
"type": "integer"
},
"scsiUnitNo": {
"format": "int32",
"type": "integer"
},
"isBackupEnabled": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Compute.ApiExamples.Models.AddDiskSampleRequest": {
"type": "object",
"properties": {
"storage": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.VmStorageDto"
},
"readOnly": true
}
}
},
"FireHost.Infrastructure.Compute.Models.Requests.VirtualMachines.Storage.StorageAdvancedSettingsUpdateRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"storageId": {
"format": "int32",
"type": "integer"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"scsiBusNo": {
"format": "int32",
"type": "integer"
},
"scsiUnitNo": {
"format": "int32",
"type": "integer"
}
},
"example": {
"accountId": 4,
"storageId": 5,
"vmId": 15,
"scsiBusNo": 1,
"scsiUnitNo": 3
}
},
"FireHost.Services.Http.Compute.ApiExamples.UpdateTierExampleRequest": {
"type": "object",
"properties": {},
"example": {
"name": "New Tier 1"
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.ApiKey": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"lastUsed": {
"format": "date-time",
"type": "string"
},
"keyStatus": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.CreateApiKeyRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"userId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"name": "New example API Key",
"userId": 1203
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.CreateApiKeyResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"FireHost.Services.Http.Accounts.Controllers.KeysController": {
"type": "object",
"properties": {
"configuration": {
"$ref": "#/definitions/System.Web.Http.HttpConfiguration"
},
"controllerContext": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpControllerContext"
},
"actionContext": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpActionContext"
},
"modelState": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Web.Http.ModelBinding.ModelState"
},
"readOnly": true
},
"request": {
"$ref": "#/definitions/System.Object"
},
"requestContext": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpRequestContext"
},
"url": {
"$ref": "#/definitions/System.Web.Http.Routing.UrlHelper"
},
"user": {
"$ref": "#/definitions/System.Security.Principal.IPrincipal"
}
}
},
"System.Web.Http.HttpConfiguration": {
"type": "object",
"properties": {
"initializer": {
"$ref": "#/definitions/System.Action%5BSystem.Web.Http.HttpConfiguration%5D"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Web.Http.Filters.FilterInfo"
},
"readOnly": true
},
"messageHandlers": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Net.Http.DelegatingHandler"
},
"readOnly": true
},
"routes": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Web.Http.Routing.IHttpRoute"
},
"readOnly": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"virtualPathRoot": {
"type": "string",
"readOnly": true
},
"dependencyResolver": {
"$ref": "#/definitions/System.Web.Http.Dependencies.IDependencyResolver"
},
"services": {
"$ref": "#/definitions/System.Web.Http.Controllers.ServicesContainer",
"readOnly": true
},
"parameterBindingRules": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Func%5BSystem.Web.Http.Controllers.HttpParameterDescriptor,System.Web.Http.Controllers.HttpParameterBinding%5D"
},
"readOnly": true
},
"includeErrorDetailPolicy": {
"format": "int32",
"enum": [0, 1, 2, 3],
"type": "integer"
},
"formatters": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Net.Http.Formatting.MediaTypeFormatter"
},
"readOnly": true
}
}
},
"System.Web.Http.Controllers.HttpControllerContext": {
"type": "object",
"properties": {
"configuration": {
"$ref": "#/definitions/System.Web.Http.HttpConfiguration"
},
"controllerDescriptor": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpControllerDescriptor"
},
"controller": {
"$ref": "#/definitions/System.Web.Http.Controllers.IHttpController"
},
"request": {
"$ref": "#/definitions/System.Object"
},
"requestContext": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpRequestContext"
},
"routeData": {
"$ref": "#/definitions/System.Web.Http.Routing.IHttpRouteData"
}
}
},
"System.Web.Http.Controllers.HttpActionContext": {
"type": "object",
"properties": {
"controllerContext": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpControllerContext"
},
"actionDescriptor": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpActionDescriptor"
},
"modelState": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Web.Http.ModelBinding.ModelState"
},
"readOnly": true
},
"actionArguments": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"response": {
"$ref": "#/definitions/System.Object"
},
"request": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"requestContext": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpRequestContext",
"readOnly": true
}
}
},
"System.Web.Http.ModelBinding.ModelState": {
"type": "object",
"properties": {
"value": {
"$ref": "#/definitions/System.Web.Http.ValueProviders.ValueProviderResult"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Web.Http.ModelBinding.ModelError"
},
"readOnly": true
}
}
},
"System.Web.Http.Controllers.HttpRequestContext": {
"type": "object",
"properties": {
"clientCertificate": {
"$ref": "#/definitions/System.Object"
},
"configuration": {
"$ref": "#/definitions/System.Web.Http.HttpConfiguration"
},
"includeErrorDetail": {
"type": "boolean"
},
"isLocal": {
"type": "boolean"
},
"principal": {
"$ref": "#/definitions/System.Security.Principal.IPrincipal"
},
"routeData": {
"$ref": "#/definitions/System.Web.Http.Routing.IHttpRouteData"
},
"url": {
"$ref": "#/definitions/System.Web.Http.Routing.UrlHelper"
},
"virtualPathRoot": {
"type": "string"
}
}
},
"System.Web.Http.Routing.UrlHelper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/definitions/System.Object"
}
}
},
"System.Security.Principal.IPrincipal": {
"type": "object",
"properties": {
"identity": {
"$ref": "#/definitions/System.Security.Principal.IIdentity",
"readOnly": true
}
}
},
"System.Action[System.Web.Http.HttpConfiguration]": {
"type": "object",
"properties": {
"method": {
"$ref": "#/definitions/System.Reflection.MethodInfo",
"readOnly": true
},
"target": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Web.Http.Filters.FilterInfo": {
"type": "object",
"properties": {
"instance": {
"$ref": "#/definitions/System.Web.Http.Filters.IFilter",
"readOnly": true
},
"scope": {
"format": "int32",
"enum": [0, 10, 20],
"type": "integer",
"readOnly": true
}
}
},
"System.Net.Http.DelegatingHandler": {
"type": "object",
"properties": {
"innerHandler": {
"$ref": "#/definitions/System.Net.Http.HttpMessageHandler"
}
}
},
"System.Web.Http.Routing.IHttpRoute": {
"type": "object",
"properties": {
"routeTemplate": {
"type": "string",
"readOnly": true
},
"defaults": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"constraints": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"dataTokens": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"handler": {
"$ref": "#/definitions/System.Net.Http.HttpMessageHandler",
"readOnly": true
}
}
},
"System.Web.Http.Dependencies.IDependencyResolver": {
"type": "object",
"properties": {}
},
"System.Web.Http.Controllers.ServicesContainer": {
"type": "object",
"properties": {}
},
"System.Func[System.Web.Http.Controllers.HttpParameterDescriptor,System.Web.Http.Controllers.HttpParameterBinding]": {
"type": "object",
"properties": {
"method": {
"$ref": "#/definitions/System.Reflection.MethodInfo",
"readOnly": true
},
"target": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Net.Http.Formatting.MediaTypeFormatter": {
"type": "object",
"properties": {
"supportedMediaTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Net.Http.Headers.MediaTypeHeaderValue"
},
"readOnly": true
},
"supportedEncodings": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Text.Encoding"
},
"readOnly": true
},
"mediaTypeMappings": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Net.Http.Formatting.MediaTypeMapping"
},
"readOnly": true
},
"requiredMemberSelector": {
"$ref": "#/definitions/System.Net.Http.Formatting.IRequiredMemberSelector"
}
}
},
"System.Web.Http.Controllers.HttpControllerDescriptor": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"configuration": {
"$ref": "#/definitions/System.Web.Http.HttpConfiguration"
},
"controllerName": {
"type": "string"
},
"controllerType": {
"type": "string"
}
}
},
"System.Web.Http.Controllers.IHttpController": {
"type": "object",
"properties": {}
},
"System.Web.Http.Routing.IHttpRouteData": {
"type": "object",
"properties": {
"route": {
"$ref": "#/definitions/System.Web.Http.Routing.IHttpRoute",
"readOnly": true
},
"values": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
}
}
},
"System.Web.Http.Controllers.HttpActionDescriptor": {
"type": "object",
"properties": {
"actionName": {
"type": "string",
"readOnly": true
},
"configuration": {
"$ref": "#/definitions/System.Web.Http.HttpConfiguration"
},
"actionBinding": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpActionBinding"
},
"controllerDescriptor": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpControllerDescriptor"
},
"returnType": {
"type": "string",
"readOnly": true
},
"resultConverter": {
"$ref": "#/definitions/System.Web.Http.Controllers.IActionResultConverter",
"readOnly": true
},
"supportedHttpMethods": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Net.Http.HttpMethod"
},
"readOnly": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
}
}
},
"System.Web.Http.ValueProviders.ValueProviderResult": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Web.Http.ModelBinding.ModelError": {
"type": "object",
"properties": {
"exception": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"System.Security.Principal.IIdentity": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"authenticationType": {
"type": "string",
"readOnly": true
},
"isAuthenticated": {
"type": "boolean",
"readOnly": true
}
}
},
"System.Reflection.MethodInfo": {
"type": "object",
"properties": {
"memberType": {
"format": "int32",
"enum": [1, 2, 4, 8, 16, 32, 64, 128, 191],
"type": "integer",
"readOnly": true
},
"returnType": {
"type": "string",
"readOnly": true
},
"returnParameter": {
"$ref": "#/definitions/System.Reflection.ParameterInfo",
"readOnly": true
},
"returnTypeCustomAttributes": {
"$ref": "#/definitions/System.Reflection.ICustomAttributeProvider",
"readOnly": true
},
"methodImplementationFlags": {
"format": "int32",
"enum": [0, 0, 1, 2, 3, 3, 4, 4, 8, 16, 32, 64, 128, 256, 1024, 4096, 65535],
"type": "integer",
"readOnly": true
},
"methodHandle": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"attributes": {
"format": "int32",
"enum": [0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 32, 64, 128, 256, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 53248],
"type": "integer",
"readOnly": true
},
"callingConvention": {
"format": "int32",
"enum": [1, 2, 3, 32, 64],
"type": "integer",
"readOnly": true
},
"isGenericMethodDefinition": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"isGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isPrivate": {
"type": "boolean",
"readOnly": true
},
"isFamily": {
"type": "boolean",
"readOnly": true
},
"isAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyAndAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyOrAssembly": {
"type": "boolean",
"readOnly": true
},
"isStatic": {
"type": "boolean",
"readOnly": true
},
"isFinal": {
"type": "boolean",
"readOnly": true
},
"isVirtual": {
"type": "boolean",
"readOnly": true
},
"isHideBySig": {
"type": "boolean",
"readOnly": true
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isConstructor": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"type": "string",
"readOnly": true
},
"reflectedType": {
"type": "string",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Reflection.CustomAttributeData"
},
"readOnly": true
},
"metadataToken": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"module": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Web.Http.Filters.IFilter": {
"type": "object",
"properties": {
"allowMultiple": {
"type": "boolean",
"readOnly": true
}
}
},
"System.Net.Http.HttpMessageHandler": {
"type": "object",
"properties": {}
},
"System.Net.Http.Headers.MediaTypeHeaderValue": {
"type": "object",
"properties": {
"charSet": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Net.Http.Headers.NameValueHeaderValue"
},
"readOnly": true
},
"mediaType": {
"type": "string"
}
}
},
"System.Text.Encoding": {
"type": "object",
"properties": {
"bodyName": {
"type": "string",
"readOnly": true
},
"encodingName": {
"type": "string",
"readOnly": true
},
"headerName": {
"type": "string",
"readOnly": true
},
"webName": {
"type": "string",
"readOnly": true
},
"windowsCodePage": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"isBrowserDisplay": {
"type": "boolean",
"readOnly": true
},
"isBrowserSave": {
"type": "boolean",
"readOnly": true
},
"isMailNewsDisplay": {
"type": "boolean",
"readOnly": true
},
"isMailNewsSave": {
"type": "boolean",
"readOnly": true
},
"isSingleByte": {
"type": "boolean",
"readOnly": true
},
"encoderFallback": {
"$ref": "#/definitions/System.Text.EncoderFallback"
},
"decoderFallback": {
"$ref": "#/definitions/System.Text.DecoderFallback"
},
"isReadOnly": {
"type": "boolean",
"readOnly": true
},
"codePage": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
},
"System.Net.Http.Formatting.MediaTypeMapping": {
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/definitions/System.Net.Http.Headers.MediaTypeHeaderValue",
"readOnly": true
}
}
},
"System.Net.Http.Formatting.IRequiredMemberSelector": {
"type": "object",
"properties": {}
},
"System.Web.Http.Controllers.HttpActionBinding": {
"type": "object",
"properties": {
"actionDescriptor": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpActionDescriptor"
},
"parameterBindings": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpParameterBinding"
}
}
}
},
"System.Web.Http.Controllers.IActionResultConverter": {
"type": "object",
"properties": {}
},
"System.Net.Http.HttpMethod": {
"type": "object",
"properties": {
"method": {
"type": "string",
"readOnly": true
}
}
},
"System.Reflection.ParameterInfo": {
"type": "object",
"properties": {
"parameterType": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"hasDefaultValue": {
"type": "boolean",
"readOnly": true
},
"defaultValue": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"rawDefaultValue": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"position": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"attributes": {
"format": "int32",
"enum": [0, 1, 2, 4, 8, 16, 4096, 8192, 16384, 32768, 61440],
"type": "integer",
"readOnly": true
},
"member": {
"$ref": "#/definitions/System.Reflection.MemberInfo",
"readOnly": true
},
"isIn": {
"type": "boolean",
"readOnly": true
},
"isOut": {
"type": "boolean",
"readOnly": true
},
"isLcid": {
"type": "boolean",
"readOnly": true
},
"isRetval": {
"type": "boolean",
"readOnly": true
},
"isOptional": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Reflection.CustomAttributeData"
},
"readOnly": true
}
}
},
"System.Reflection.ICustomAttributeProvider": {
"type": "object",
"properties": {}
},
"System.Reflection.CustomAttributeData": {
"type": "object",
"properties": {
"attributeType": {
"type": "string",
"readOnly": true
},
"constructor": {
"$ref": "#/definitions/System.Reflection.ConstructorInfo",
"readOnly": true
},
"constructorArguments": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Reflection.CustomAttributeTypedArgument"
},
"readOnly": true
},
"namedArguments": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Reflection.CustomAttributeNamedArgument"
},
"readOnly": true
}
}
},
"System.Net.Http.Headers.NameValueHeaderValue": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"value": {
"type": "string"
}
}
},
"System.Text.EncoderFallback": {
"type": "object",
"properties": {
"maxCharCount": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
},
"System.Text.DecoderFallback": {
"type": "object",
"properties": {
"maxCharCount": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
},
"System.Web.Http.Controllers.HttpParameterBinding": {
"type": "object",
"properties": {
"willReadBody": {
"type": "boolean",
"readOnly": true
},
"isValid": {
"type": "boolean",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
},
"descriptor": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpParameterDescriptor",
"readOnly": true
}
}
},
"System.Reflection.MemberInfo": {
"type": "object",
"properties": {
"memberType": {
"format": "int32",
"enum": [1, 2, 4, 8, 16, 32, 64, 128, 191],
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"type": "string",
"readOnly": true
},
"reflectedType": {
"type": "string",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Reflection.CustomAttributeData"
},
"readOnly": true
},
"metadataToken": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"module": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Reflection.ConstructorInfo": {
"type": "object",
"properties": {
"memberType": {
"format": "int32",
"enum": [1, 2, 4, 8, 16, 32, 64, 128, 191],
"type": "integer",
"readOnly": true
},
"methodImplementationFlags": {
"format": "int32",
"enum": [0, 0, 1, 2, 3, 3, 4, 4, 8, 16, 32, 64, 128, 256, 1024, 4096, 65535],
"type": "integer",
"readOnly": true
},
"methodHandle": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"attributes": {
"format": "int32",
"enum": [0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 32, 64, 128, 256, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 53248],
"type": "integer",
"readOnly": true
},
"callingConvention": {
"format": "int32",
"enum": [1, 2, 3, 32, 64],
"type": "integer",
"readOnly": true
},
"isGenericMethodDefinition": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"isGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isPrivate": {
"type": "boolean",
"readOnly": true
},
"isFamily": {
"type": "boolean",
"readOnly": true
},
"isAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyAndAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyOrAssembly": {
"type": "boolean",
"readOnly": true
},
"isStatic": {
"type": "boolean",
"readOnly": true
},
"isFinal": {
"type": "boolean",
"readOnly": true
},
"isVirtual": {
"type": "boolean",
"readOnly": true
},
"isHideBySig": {
"type": "boolean",
"readOnly": true
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isConstructor": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"type": "string",
"readOnly": true
},
"reflectedType": {
"type": "string",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/System.Reflection.CustomAttributeData"
},
"readOnly": true
},
"metadataToken": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"module": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Reflection.CustomAttributeTypedArgument": {
"type": "object",
"properties": {
"argumentType": {
"type": "string",
"readOnly": true
},
"value": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"System.Reflection.CustomAttributeNamedArgument": {
"type": "object",
"properties": {
"memberInfo": {
"$ref": "#/definitions/System.Reflection.MemberInfo",
"readOnly": true
},
"typedValue": {
"$ref": "#/definitions/System.Reflection.CustomAttributeTypedArgument",
"readOnly": true
},
"memberName": {
"type": "string",
"readOnly": true
},
"isField": {
"type": "boolean",
"readOnly": true
}
}
},
"System.Web.Http.Controllers.HttpParameterDescriptor": {
"type": "object",
"properties": {
"configuration": {
"$ref": "#/definitions/System.Web.Http.HttpConfiguration"
},
"actionDescriptor": {
"$ref": "#/definitions/System.Web.Http.Controllers.HttpActionDescriptor"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
},
"defaultValue": {
"$ref": "#/definitions/System.Object",
"readOnly": true
},
"parameterName": {
"type": "string",
"readOnly": true
},
"parameterType": {
"type": "string",
"readOnly": true
},
"prefix": {
"type": "string",
"readOnly": true
},
"isOptional": {
"type": "boolean",
"readOnly": true
},
"parameterBinderAttribute": {
"$ref": "#/definitions/System.Web.Http.ParameterBindingAttribute"
}
}
},
"System.Web.Http.ParameterBindingAttribute": {
"type": "object",
"properties": {
"typeId": {
"$ref": "#/definitions/System.Object",
"readOnly": true
}
}
},
"FireHost.Infrastructure.Accounts.Data.Persistence.UpdateApiKeyRequest": {
"type": "object",
"properties": {
"apiKeyId": {
"type": "string"
},
"prevApiKeyName": {
"type": "string"
},
"newApiKeyName": {
"type": "string"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Network.Models.SslCertificateDto]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslCertificateDto"
}
}
}
},
"FireHost.Infrastructure.Network.Models.SslCertificateDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"cname": {
"type": "string"
},
"sku": {
"type": "string"
},
"certificateType": {
"type": "string"
},
"orderDate": {
"format": "date-time",
"type": "string"
},
"expiryDate": {
"format": "date-time",
"type": "string"
},
"uniqueProductIdentifier": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"accountName": {
"type": "string"
},
"tickets": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Network.Models.UpdateSslCertificateRequestDto": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "int32",
"type": "integer"
},
"cname": {
"type": "string"
},
"expiry": {
"format": "date-time",
"type": "string"
},
"status": {
"type": "string"
},
"ticket": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Network.Models.CancelSslCertificateRequestDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"cname": {
"type": "string"
},
"expiryDate": {
"format": "date-time",
"type": "string"
},
"tickets": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Firewall.Models.Groups.GroupDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"readOnly": true
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"isReadonly": {
"type": "boolean"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"status": {
"format": "int32",
"type": "integer"
},
"retryCount": {
"format": "int32",
"type": "integer"
},
"isDefaultGroupCopied": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.CreateGroupSampleRequest": {
"type": "object",
"properties": {
"deviceId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
},
"example": {
"deviceId": 2,
"name": "HTTP",
"description": "",
"values": ["192.158.1.1"]
}
},
"FireHost.Services.Common.Data.Domain.Logs.ILogRequest": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"userName": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"apiRequest": {
"type": "string"
},
"operation": {
"type": "string"
},
"error": {
"$ref": "#/definitions/System.Object"
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.UpdateGroupByIdSampleRequest": {
"type": "object",
"properties": {
"deviceId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
},
"example": {
"deviceId": 2,
"id": 8,
"name": "Local IP",
"description": "",
"values": ["192.158.1.1"]
}
},
"FireHost.Infrastructure.Firewall.Models.FirewallDeviceDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Firewall.Models.Rules.RuleSet]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Rules.RuleSet"
}
}
}
},
"FireHost.Infrastructure.Firewall.Models.Rules.RuleSet": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Rules.Rule"
}
},
"staged": {
"type": "boolean"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isOverride": {
"type": "boolean"
},
"ipGroups": {
"type": "string"
},
"isRulePendingGlobal": {
"type": "boolean"
},
"isRuleErrorGlobal": {
"type": "boolean"
},
"totalRulesInRuleSet": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Firewall.Models.Rules.Rule": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Rules.RuleMember"
}
},
"sources": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Rules.RuleMember"
}
},
"services": {
"type": "array",
"items": {
"$ref": ""
}
},
"action": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"sortOrder": {
"format": "int32",
"type": "integer"
},
"providerRefId": {
"format": "int32",
"type": "integer"
},
"isEnabled": {
"type": "boolean"
},
"readonly": {
"type": "boolean"
},
"status": {
"format": "int32",
"enum": [1, 2, 3, 4, 5, 6],
"type": "integer"
},
"retryCount": {
"format": "int32",
"type": "integer"
},
"total": {
"format": "int32",
"type": "integer"
},
"isRetry": {
"type": "boolean"
},
"lastAction": {
"format": "int32",
"enum": [1, 2, 3, 4, 5, 6, 7, 8],
"type": "integer"
},
"isDeleted": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Firewall.Models.Rules.RuleMember": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"readOnly": true
},
"joinedValues": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"isReadOnly": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.CreateServiceSampleRequest": {
"type": "object",
"properties": {
"deviceId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"location": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceValueDto"
},
"readOnly": true
}
},
"example": {
"deviceId": 2,
"location": "DFW01",
"name": "TCP HTTP",
"description": "",
"values": [{
"port": 80,
"protocol": "tcp",
"isConsistent": false
}]
}
},
"FireHost.Infrastructure.Firewall.Models.Services.ServiceValueDto": {
"type": "object",
"properties": {
"port": {
"format": "int32",
"type": "integer"
},
"protocol": {
"type": "string"
},
"subprotocol": {
"type": "string"
},
"minimum": {
"format": "int32",
"type": "integer"
},
"maximum": {
"format": "int32",
"type": "integer"
},
"isConsistent": {
"type": "boolean"
}
}
},
"FireHost.Services.Common.HandleResult[FireHost.Infrastructure.Firewall.Models.Requests.EnabelDisableFirewallRuleRequest]": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"data": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Requests.EnabelDisableFirewallRuleRequest"
},
"message": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Firewall.Models.Requests.EnabelDisableFirewallRuleRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"ruleId": {
"format": "int32",
"type": "integer"
},
"disabled": {
"type": "boolean"
},
"ruleAction": {
"format": "int32",
"enum": [1, 2, 3, 4, 5, 6, 7, 8],
"type": "integer"
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.CreateRuleSampleRequest": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"rule": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallRule"
}
},
"example": {
"id": 2,
"deviceId": 3,
"rule": {
"id": 0,
"sources": [{
"id": 5,
"deviceId": 3,
"name": "Source 1",
"type": "group",
"ipGroups": "192.168.10.10",
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 5,
"retryCount": 0,
"joinedValues": "192.168.10.10",
"values": ["192.168.10.10"]
}],
"destinations": [{
"id": 3,
"deviceId": 3,
"name": "Destination 1",
"type": "group",
"ipGroups": "192.168.10.12",
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 5,
"retryCount": 0,
"joinedValues": "192.168.10.12",
"values": ["192.168.10.12"]
}],
"services": [{
"id": 2,
"deviceId": 3,
"location": "vsite-a",
"accountId": 2,
"name": "Service 2",
"values": [{
"port": 8888,
"protocol": "tcp",
"isConsistent": false
}, {
"port": 21,
"protocol": "udp",
"isConsistent": false
}]
}],
"action": "allow",
"name": "Test Rule",
"sortOrder": 12,
"isEnabled": true,
"providerRefId": 0,
"readonly": false,
"status": 0,
"firewallRuleAction": 0
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallRule": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallRuleMember"
}
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallRuleMember"
}
},
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallService"
}
},
"action": {
"type": "string"
},
"name": {
"type": "string"
},
"sortOrder": {
"format": "int32",
"type": "integer"
},
"isEnabled": {
"type": "boolean"
},
"providerRefId": {
"format": "int32",
"type": "integer"
},
"readonly": {
"type": "boolean"
},
"status": {
"format": "int32",
"type": "integer"
},
"firewallRuleAction": {
"format": "int32",
"enum": [1, 2, 3, 4, 5, 6, 7, 8],
"type": "integer"
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallRuleMember": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"ipGroups": {
"type": "string"
},
"isReadonly": {
"type": "boolean"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"status": {
"format": "int32",
"type": "integer"
},
"retryCount": {
"format": "int32",
"type": "integer"
},
"joinedValues": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallService": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceValueDto"
}
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.UpdateIndividualRuleSampleRequest": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"rule": {
"$ref": "#/definitions/FireHost.Services.Http.Firewall.ApiExamples.Models.SampleFirewallRule"
}
},
"example": {
"id": 2,
"deviceId": 3,
"rule": {
"id": 0,
"sources": [{
"id": 5,
"deviceId": 3,
"name": "Source 1",
"type": "group",
"ipGroups": "192.168.10.10",
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 5,
"retryCount": 0,
"joinedValues": "192.168.10.10",
"values": ["192.168.10.10"]
}],
"destinations": [{
"id": 3,
"deviceId": 3,
"name": "Destination 1",
"type": "group",
"ipGroups": "192.168.10.12",
"isReadonly": false,
"vcdOrgVdcId": 0,
"status": 5,
"retryCount": 0,
"joinedValues": "192.168.10.12",
"values": ["192.168.10.12"]
}],
"services": [{
"id": 2,
"deviceId": 3,
"location": "vsite-a",
"accountId": 2,
"name": "Service 2",
"values": [{
"port": 8888,
"protocol": "tcp",
"isConsistent": false
}, {
"port": 21,
"protocol": "udp",
"isConsistent": false
}]
}],
"action": "allow",
"name": "Test Rule edited",
"sortOrder": 12,
"isEnabled": true,
"providerRefId": 1069,
"readonly": false,
"status": 4,
"firewallRuleAction": 2
}
}
},
"FireHost.Services.Ipam.Data.Domain.IpDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"ip": {
"type": "string"
},
"state": {
"type": "string"
},
"type": {
"type": "string"
},
"assignedTo": {
"$ref": "#/definitions/FireHost.Services.Ipam.Data.Domain.AssignedToDto"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"isRecovery": {
"type": "boolean"
}
}
},
"FireHost.Services.Ipam.Data.Domain.AssignedToDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"assignmentType": {
"type": "string"
}
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.AssignPrivateIpToVmSampleRequest": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
}
},
"example": {
"vmId": 1,
"id": 518
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.UnAssignIpFromVmSampleRequest": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
}
},
"example": {
"vmId": 1,
"id": 518
}
},
"FireHost.Services.Ipam.Data.Domain.AssignExtDnatRequest": {
"type": "object",
"properties": {
"quantity": {
"format": "int32",
"type": "integer"
},
"locationId": {
"format": "int32",
"type": "integer"
},
"isRecovery": {
"type": "boolean"
}
},
"example": {
"quantity": 1,
"locationId": 1,
"isRecovery": false
}
},
"FireHost.Services.Common.Data.Domain.Nat.IpAddressModel": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"ipAddress": {
"type": "string"
},
"subnetId": {
"format": "int32",
"type": "integer"
},
"ipStateId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"type": {
"type": "string"
},
"cancelOrgRequestedSagaId": {
"type": "string"
},
"ipState": {
"format": "int32",
"enum": [0, 1, 2, 3, 4, 5, 6, 7, 8],
"type": "integer",
"readOnly": true
}
}
},
"FireHost.Infrastructure.Network.Models.SslVpnUserDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"isSslVpnEnabled": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Network.Models.SslVpnMemberDto": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"email": {
"type": "string"
},
"isSslVpnEnabled": {
"type": "boolean",
"readOnly": true
},
"vpcData": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Compute.Models.Environment.VdcDto"
}
}
}
},
"FireHost.Infrastructure.Compute.Models.Environment.VdcDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"isRecoveryVdc": {
"type": "boolean"
},
"description": {
"type": "string"
}
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.EnableSslVpnSampleRequest": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"locations": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Network.ApiExamples.Models.SampleLocation"
},
"readOnly": true
},
"enable": {
"type": "boolean",
"readOnly": true
}
},
"example": {
"userId": 3,
"locations": [{
"zone": "dfw01-vc01"
}],
"enable": true
}
},
"FireHost.Infrastructure.Network.Models.LocationDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
}
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.SampleLocation": {
"type": "object",
"properties": {
"zone": {
"type": "string",
"readOnly": true
}
}
},
"FireHost.Infrastructure.Network.Models.SslVpnConfigDetail": {
"type": "object",
"properties": {
"sslVpnConnectionDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslVpnConnectionDetail"
}
},
"sslVpnClientVersions": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.SslVpnClientVersion"
}
}
}
},
"FireHost.Infrastructure.Network.Models.SslVpnConnectionDetail": {
"type": "object",
"properties": {
"location": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Network.Models.SslVpnClientVersion": {
"type": "object",
"properties": {
"osName": {
"type": "string"
},
"version": {
"type": "string"
},
"clientDownloadUrl": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Firewall.Models.Services.ServiceCreatedDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceValueDto"
}
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Firewall.Models.Services.ServiceUpdatedDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"deviceId": {
"format": "int32",
"type": "integer"
},
"location": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceValueDto"
}
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"status": {
"format": "int32",
"type": "integer"
},
"retryCount": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Firewall.ApiExamples.Models.UpdateServiceSampleRequest": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"deviceId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"location": {
"type": "string",
"readOnly": true
},
"accountId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Firewall.Models.Services.ServiceValueDto"
},
"readOnly": true
}
},
"example": {
"id": 4,
"deviceId": 2,
"location": "DFW01",
"accountId": 0,
"name": "HTTP",
"description": "Use this for inbound HTTP traffic",
"values": [{
"port": 80,
"protocol": "tcp",
"isConsistent": false
}]
}
},
"FireHost.Services.Common.Events.Compute.Environment.Catalogs.NatRuleRefactoredDto": {
"type": "object",
"properties": {
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"destinationIpId": {
"format": "int32",
"type": "integer"
},
"type": {
"type": "string"
},
"sourceIpIds": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
},
"readOnly": true
}
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.NatSampleRequest": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"translatedIp": {
"type": "string",
"readOnly": true
},
"originalIps": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"id": {
"format": "int32",
"type": "integer",
"readOnly": true
}
},
"example": {
"vmId": 2,
"translatedIp": "100.10.10.1",
"originalIps": ["192.158.1.1"],
"id": 1
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.UpdateNatSampleRequest": {
"type": "object",
"properties": {
"vmId": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"translatedIp": {
"type": "string",
"readOnly": true
},
"originalIps": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"vmId": 2,
"translatedIp": "100.10.10.1",
"originalIps": ["192.158.1.1"],
"vcdOrgVdcId": 1
}
},
"FireHost.Services.Common.Events.Compute.Environment.Catalogs.VmNatRuleDto": {
"type": "object",
"properties": {
"vmIp": {
"type": "string"
},
"publicIps": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"FireHost.Infrastructure.Network.Models.L2LConfigurationDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"edgeId": {
"format": "int32",
"type": "integer"
},
"edgeIp": {
"type": "string"
},
"location": {
"type": "string"
},
"zone": {
"type": "string"
},
"lastModified": {
"format": "date-time",
"type": "string"
},
"sites": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Network.Models.L2LSiteDto"
}
},
"tenantCidr": {
"type": "string"
},
"vcdOrgVdcId": {
"format": "int32",
"type": "integer"
},
"vcdOrgId": {
"format": "int32",
"type": "integer"
},
"hasGen34": {
"type": "boolean"
},
"isNsxT": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Network.Models.L2LSiteDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"localIp": {
"type": "string"
},
"peerIp": {
"type": "string"
},
"isEnabled": {
"type": "boolean"
},
"notes": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"FireHost.Services.Http.Network.ApiExamples.Models.CreateL2LSampleRequest": {
"type": "object",
"properties": {
"peerId": {
"type": "string",
"readOnly": true
},
"encryption": {
"type": "string",
"readOnly": true
},
"enablePfs": {
"type": "boolean",
"readOnly": true
},
"dhGroup": {
"type": "string",
"readOnly": true
},
"localSubnets": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"peerSubnets": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"psk": {
"type": "string",
"readOnly": true
},
"authentication": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"localIp": {
"type": "string",
"readOnly": true
},
"peerIp": {
"type": "string",
"readOnly": true
},
"isEnabled": {
"type": "boolean",
"readOnly": true
}
},
"example": {
"peerId": "10.1.1.0",
"encryption": "aes256",
"enablePfs": true,
"dhGroup": "dh2",
"localSubnets": ["100.64.0.66/32"],
"peerSubnets": ["10.1.0.0/24"],
"psk": "Secur3_K3Y",
"authentication": "psk",
"name": "ME4",
"localIp": "146.88.118.5",
"peerIp": "10.1.1.3",
"isEnabled": true
}
},
"FireHost.Infrastructure.Patching.Models.PackageDepricatedResponse": {
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"type": "integer"
},
"warning": {
"type": "string"
}
}
},
"FireHost.Infrastructure.LogManagement.Models.LogSourceDetails": {
"type": "object",
"properties": {
"providerName": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageName": {
"type": "string"
},
"isConnected": {
"type": "boolean"
},
"category": {
"type": "string"
},
"configureUri": {
"type": "string"
},
"logSourceTypeId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.LogManagement.Models.LogInsightOverviewResponse": {
"type": "object",
"properties": {
"totalLogStorage": {
"format": "double",
"type": "number"
},
"totalLogStorageInBytes": {
"format": "int64",
"type": "integer"
},
"totalLogStorageUnit": {
"type": "string"
},
"armorAgentLogStorage": {
"format": "double",
"type": "number"
},
"armorAgentLogStorageInBytes": {
"format": "int64",
"type": "integer"
},
"logsAndDataManagementLogStorage": {
"format": "double",
"type": "number"
},
"logsAndDataManagementLogStorageInBytes": {
"format": "int64",
"type": "integer"
},
"armorAgentLogStorageUnit": {
"type": "string"
},
"logsAndDataManagementLogStorageUnit": {
"type": "string"
},
"logRetentionDays": {
"format": "int32",
"type": "integer"
},
"connectedSources": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.LogManagement.Models.ConnectorRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "int32",
"type": "integer"
},
"sourceName": {
"type": "string"
},
"sourceVendor": {
"type": "string"
}
},
"example": {
"accountId": 2,
"userId": 2002,
"sourceName": "EC2",
"sourceVendor": "Amazon Web Services"
}
},
"FireHost.Infrastructure.LogManagement.Models.VmLogDetails": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"vmName": {
"type": "string"
},
"lastLogDate": {
"format": "date-time",
"type": "string"
},
"vmProvider": {
"type": "string"
},
"vmProviderFullName": {
"type": "string"
},
"os": {
"type": "string"
},
"vmLocation": {
"type": "string"
},
"logRetentionPlan": {
"type": "string"
},
"logSize": {
"type": "string"
},
"logSeverity": {
"format": "int32",
"type": "integer"
},
"logApiUrl": {
"type": "string"
},
"agentStatus": {
"type": "string"
},
"profileName": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.LogManagement.Requests.RetentionUpgradeRequest": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"vmId": {
"format": "int32",
"type": "integer"
},
"retentionType": {
"format": "int32",
"description": "Log Retention type. Default value is 13 months since the feature initial design is for upgrade from the default 90 days.",
"enum": [0, 1],
"type": "integer"
}
},
"example": {
"coreInstanceId": "57c48819-9390-4f01-9257-5fc766591c61",
"vmId": 0,
"retentionType": 1
}
},
"FireHost.Infrastructure.LogManagement.Models.LogServiceTypeResponse": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"planRate": {
"format": "double",
"type": "number"
},
"sku": {
"type": "string"
}
}
},
"FireHost.Infrastructure.LogManagement.Models.LogDepotSubscription": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"modifiedByUserId": {
"format": "int32",
"type": "integer"
},
"modifiedDate": {
"format": "date-time",
"type": "string"
},
"isEnabled": {
"type": "boolean"
}
}
},
"FireHost.Services.Http.LogManagement.Requests.AccountRetentionPlanRequest": {
"type": "object",
"properties": {
"accountLogRetentionType": {
"format": "int32",
"enum": [30, 90, 400],
"type": "integer"
},
"retainLast30DaysData": {
"type": "boolean"
}
},
"example": {
"accountLogRetentionType": 90,
"retainLast30DaysData": true
}
},
"FireHost.Infrastructure.LogManagement.Models.AccountLogUtilizationTotals": {
"type": "object",
"properties": {
"totalLogUsage": {
"format": "double",
"type": "number"
},
"usageDate": {
"format": "date-time",
"type": "string"
},
"totalLogUsageInGb": {
"format": "double",
"type": "number",
"readOnly": true
},
"label": {
"type": "string"
}
}
},
"FireHost.Infrastructure.LogManagement.Models.RetentionPlanTypesDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"description": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"sortOrder": {
"format": "int32",
"type": "integer"
},
"skuBss": {
"type": "string"
},
"title": {
"type": "string"
},
"subTitle": {
"type": "string"
},
"imageList": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"isCurrentPlan": {
"type": "boolean"
},
"helpText": {
"type": "string"
}
}
},
"FireHost.Infrastructure.LogManagement.Models.AccountLogStorageUtilizedDto": {
"type": "object",
"properties": {
"day": {
"format": "date-time",
"type": "string"
},
"logSize": {
"format": "double",
"type": "number"
},
"armrorAgentLogSize": {
"format": "double",
"type": "number"
},
"logsAndDataManagementLogSize": {
"format": "double",
"type": "number"
},
"logSizeGb": {
"format": "double",
"type": "number",
"readOnly": true
},
"armrorAgentLogSizeGb": {
"format": "double",
"type": "number",
"readOnly": true
},
"logsAndDataManagementLogSizeGb": {
"format": "double",
"type": "number",
"readOnly": true
}
}
},
"FireHost.Infrastructure.LogSearch.Models.ExecuteSearchTemplateRequest": {
"type": "object",
"properties": {
"viewName": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
}
}
},
"example": {
"viewName": "Trend FIM List",
"parameters": {
"coreinstance_id": "b7939804-3190-494e-933f-f837fe545c3a",
"size": 10,
"from": 0,
"include_filteroptions": true,
"include_aggregations": true
}
}
},
"FireHost.Infrastructure.LogSearch.Models.ExecuteSearchTemplateResult": {
"type": "object",
"properties": {
"total": {
"format": "int64",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
}
}
},
"filterOptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Nest.IAggregate"
}
}
}
},
"Nest.IAggregate": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
},
"readOnly": true
}
}
},
"FireHost.Infrastructure.LogSearch.Models.ExecuteChaosSearchTemplateResult": {
"type": "object",
"properties": {
"total": {
"format": "int64",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
}
}
},
"filterOptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"aggregations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/System.Object"
}
}
}
},
"FireHost.Services.Http.TimeSeries.Models.TimeSeriesDataPointResponseDto": {
"type": "object",
"properties": {
"t": {
"format": "date-time",
"type": "string"
},
"v": {
"format": "double",
"type": "number"
}
}
},
"FireHost.Infrastructure.Trend.Models.AvamGridDto": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"vmName": {
"type": "string"
},
"location": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"vmProvider": {
"type": "string"
},
"providerFullName": {
"type": "string"
},
"os": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"lastAgentCommunicationSeverity": {
"format": "int32",
"type": "integer"
},
"lastScannedSeverity": {
"format": "int32",
"type": "integer"
},
"lastAgentCommunicationData": {
"type": "string"
},
"lastScannedData": {
"type": "string"
},
"lastAgentCommunicationDate": {
"format": "date-time",
"type": "string"
},
"lastScannedDate": {
"format": "date-time",
"type": "string"
},
"hostId": {
"format": "int32",
"type": "integer"
},
"overallAntiMalwareStatus": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"customLocatiom": {
"type": "string"
},
"customProvider": {
"type": "string"
},
"avamRealTimeScan": {
"type": "boolean"
},
"biosUuid": {
"type": "string"
},
"scanStatus": {
"format": "int32",
"type": "integer"
},
"isAvamEnabled": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Trend.Models.AvamVmOverAllStatus": {
"type": "object",
"properties": {
"totalOkStatus": {
"format": "int32",
"type": "integer"
},
"totalWarningStatus": {
"format": "int32",
"type": "integer"
},
"totalCriticalStatus": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Trend.Models.SecurityStatusDto": {
"type": "object",
"properties": {
"avamOkStatus": {
"format": "int32",
"type": "integer"
},
"avamWarningStatus": {
"format": "int32",
"type": "integer"
},
"avamCriticalStatus": {
"format": "int32",
"type": "integer"
},
"fimOkStatus": {
"format": "int32",
"type": "integer"
},
"fimWarningStatus": {
"format": "int32",
"type": "integer"
},
"fimCriticalStatus": {
"format": "int32",
"type": "integer"
},
"osPatchingOkStatus": {
"format": "int32",
"type": "integer"
},
"osPatchingWarningStatus": {
"format": "int32",
"type": "integer"
},
"osPatchingCriticalStatus": {
"format": "int32",
"type": "integer"
},
"overAllOkStatus": {
"format": "int32",
"type": "integer"
},
"overAllWarningStatus": {
"format": "int32",
"type": "integer"
},
"overAllCriticalStatus": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Trend.Models.FimGridDto": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"vmName": {
"type": "string"
},
"location": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"fimAgentStatus": {
"type": "string"
},
"fimAgentVersion": {
"type": "string"
},
"os": {
"type": "string"
},
"fimLastCommunicationDate": {
"format": "date-time",
"type": "string"
},
"fimLastCommunicationData": {
"type": "string"
},
"vmSeverity": {
"format": "int32",
"type": "integer"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"vmProvider": {
"type": "string"
},
"providerFullName": {
"type": "string"
},
"customProvider": {
"type": "string"
},
"customLocation": {
"type": "string"
},
"fimRealTimeScan": {
"format": "int32",
"type": "integer"
},
"biosUuid": {
"type": "string"
},
"isFimEnabled": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Trend.Models.FimOverAllStatusDto": {
"type": "object",
"properties": {
"totalOkStatus": {
"format": "int32",
"type": "integer"
},
"totalWarningStatus": {
"format": "int32",
"type": "integer"
},
"totalCriticalStatus": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Trend.Models.SecurityOverAllStatusDto": {
"type": "object",
"properties": {
"totalOkStatus": {
"format": "int32",
"type": "integer"
},
"totalWarningStatus": {
"format": "int32",
"type": "integer"
},
"totalCriticalStatus": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Trend.Models.CoreInstanceTrendSecurityDetails": {
"type": "object",
"properties": {
"hostname": {
"type": "string"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"providerRefId": {
"type": "string"
},
"lastAvamScan": {
"format": "date-time",
"type": "string"
},
"lastCommunicationDate": {
"format": "date-time",
"type": "string"
},
"isAvamRealtime": {
"type": "boolean"
},
"isFimRealtime": {
"type": "boolean"
},
"biosUuid": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Trend.Models.TrendCoreInstanceState": {
"type": "object",
"properties": {
"coreInstanceId": {
"type": "string"
},
"trendHostId": {
"format": "int32",
"type": "integer"
},
"lastScanDate": {
"format": "date-time",
"type": "string"
},
"lastAgentCommunicationDate": {
"format": "date-time",
"type": "string"
},
"overallStatus": {
"type": "string"
},
"trendOverallAntiMalwareStatus": {
"type": "string"
},
"trendOverallIntegrityMonitoringStatus": {
"type": "string"
},
"trendOverallIdsStatus": {
"type": "string"
},
"agentStatus": {
"type": "string"
},
"agentVersion": {
"type": "string"
},
"avamRealTimeScanEnabled": {
"type": "boolean"
},
"imRealTimeScanEnabled": {
"type": "boolean"
},
"container": {
"type": "string"
},
"lastModifiedDate": {
"format": "date-time",
"type": "string"
},
"lastModifiedBy": {
"type": "string"
},
"trendCoreInstanceStateMessage": {
"type": "string"
},
"trendUrl": {
"type": "string"
},
"lastDefinitionUpdatedDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.SecurityAnalytics.Models.OverviewResponse": {
"type": "object",
"properties": {
"timestamp": {
"format": "date-time",
"type": "string"
},
"overallScore": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"protectionScore": {
"format": "int32",
"type": "integer"
},
"detectionScore": {
"format": "int32",
"type": "integer"
},
"responseScore": {
"format": "int32",
"type": "integer"
},
"criticalIncidentsCount": {
"format": "int32",
"type": "integer"
},
"analyzedEventsCount": {
"format": "int32",
"type": "integer"
},
"vulnerabilities": {
"$ref": "#/definitions/FireHost.Infrastructure.SecurityAnalytics.Models.OverviewVulnerabilitiesResponse"
}
}
},
"FireHost.Infrastructure.SecurityAnalytics.Models.OverviewVulnerabilitiesResponse": {
"type": "object",
"properties": {
"scanDate": {
"format": "date-time",
"type": "string"
},
"criticalCount": {
"format": "int32",
"type": "integer"
},
"highCount": {
"format": "int32",
"type": "integer"
},
"mediumCount": {
"format": "int32",
"type": "integer"
},
"lowCount": {
"format": "int32",
"type": "integer"
},
"detailsUrl": {
"type": "string"
}
}
},
"FireHost.Infrastructure.SecurityAnalytics.Models.SecurityResourceDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"referenceUrl": {
"type": "string"
},
"imageData": {
"type": "string"
},
"modifiedBy": {
"type": "string"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.SecurityIncidents.Models.SecurityIncident]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.SecurityIncidents.Models.SecurityIncident"
}
}
}
},
"FireHost.Infrastructure.SecurityIncidents.Models.SecurityIncident": {
"type": "object",
"properties": {
"ticketNumber": {
"type": "string"
},
"ticketSummary": {
"type": "string"
},
"ticketPriority": {
"type": "string"
},
"ticketStatus": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"ticketLink": {
"type": "string"
}
}
},
"FireHost.Infrastructure.SecurityIncidents.Models.OpenSecurityIncidentStats": {
"type": "object",
"properties": {
"totalCriticalStatus": {
"format": "int32",
"type": "integer"
},
"totalHighStatus": {
"format": "int32",
"type": "integer"
},
"totalMediumStatus": {
"format": "int32",
"type": "integer"
},
"totalLowStatus": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Security.Models.IprmCustomListCreateRequestDto": {
"description": "The iprm custom list create request dto.",
"type": "object",
"properties": {
"ip": {
"description": "Gets or sets the ip.",
"type": "string"
},
"rule": {
"format": "int32",
"description": "Gets or sets the rule.",
"enum": [0, 1, 2],
"type": "integer"
},
"expirationTime": {
"format": "date-time",
"description": "Gets or sets the expiration time.",
"type": "string"
},
"meta": {
"description": "Gets or sets the meta.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"tags": {
"description": "Gets or sets the tags.",
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"ip": "23.251.224.0",
"rule": 1,
"expirationTime": "2026-02-26T16:26:00.224352Z"
}
},
"FireHost.Infrastructure.Security.Models.IprmUserRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"pageNumber": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"isSuccess": {
"type": "boolean"
}
},
"example": {
"accountId": 0,
"pageNumber": 0,
"pageSize": 5
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Security.Models.IprmUserResponse]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Security.Models.IprmUserResponse"
}
}
}
},
"FireHost.Infrastructure.Security.Models.IprmUserResponse": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"requester": {
"type": "string"
},
"lastQueryDate": {
"format": "date-time",
"type": "string"
},
"totalRequest": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Http.Security.Models.IprmDetectionRequestDto": {
"description": "The iprm detection request dto.",
"type": "object",
"properties": {
"ip": {
"description": "Gets or sets the ip.",
"type": "string"
},
"meta": {
"description": "Gets or sets the meta.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"tags": {
"description": "Gets or sets the tags.",
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"ip": "23.251.224.0"
}
},
"FireHost.Infrastructure.Security.Models.FilterRequestDto": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"pageNumber": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"searchText": {
"type": "string"
},
"sortField": {
"type": "string"
},
"sortDirection": {
"type": "string"
},
"ruleType": {
"type": "string"
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"isSuccess": {
"type": "boolean"
}
},
"example": {
"accountId": 0,
"pageNumber": 0,
"pageSize": 10,
"sortField": "date",
"sortDirection": "Descending",
"startDate": "2018-06-24T18.30.00",
"endDate": "2018-07-25T18.29.59",
"isSuccess": true
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Services.Http.Security.Models.IprmEventsDto]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Security.Models.IprmEventsDto"
}
}
}
},
"FireHost.Services.Http.Security.Models.IprmEventsDto": {
"description": "iprm events dto",
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"description": "Gets or sets the Account Id.",
"type": "integer"
},
"ipAddress": {
"description": "Gets or sets the ip address.",
"type": "string"
},
"createdBy": {
"format": "int32",
"description": "Gets or sets the CreatedBy.",
"type": "integer"
},
"requester": {
"description": "Gets or sets the requestor.",
"type": "string"
},
"date": {
"format": "date-time",
"description": "Gets or sets the date.",
"type": "string"
},
"recommendation": {
"description": "Gets or sets the date.",
"type": "string"
},
"ruleType": {
"description": "Gets or sets the rule type.",
"type": "string"
},
"requestType": {
"description": "Gets or sets the request type.",
"type": "string"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSetIprmEventsOveriew[FireHost.Infrastructure.Security.Models.IprmEventsOverviewDto]": {
"type": "object",
"properties": {
"total": {
"format": "int64",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Security.Models.IprmEventsOverviewDto"
}
}
}
},
"FireHost.Infrastructure.Security.Models.IprmEventsOverviewDto": {
"type": "object",
"properties": {
"eventCount": {
"format": "int64",
"type": "integer"
},
"date": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Infrastructure.Security.Models.IprmEventsTotalResponse": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"lookupType": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.Requests.TicketListRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "int32",
"type": "integer"
},
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"pageNumber": {
"format": "int32",
"type": "integer"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"searchText": {
"type": "string"
},
"sortField": {
"type": "string"
},
"sortDirection": {
"type": "string"
},
"filterStatus": {
"type": "string"
},
"filterStarred": {
"type": "string"
},
"filterType": {
"type": "string"
},
"isEmployee": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketResultDto": {
"type": "object",
"properties": {
"total": {
"format": "int64",
"type": "integer"
},
"ticketsList": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketDto"
}
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketDto": {
"type": "object",
"properties": {
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"isClosed": {
"type": "boolean"
},
"priority": {
"format": "int32",
"type": "integer"
},
"sensitivity": {
"format": "int32",
"type": "integer"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateModified": {
"format": "date-time",
"type": "string"
},
"createdByUserId": {
"format": "int32",
"type": "integer"
},
"lastResponderName": {
"type": "string"
},
"lastResponderDisplayName": {
"type": "string",
"readOnly": true
},
"isArmor": {
"type": "boolean",
"readOnly": true
},
"lastResponderExcerpt": {
"type": "string"
},
"lastResponseDate": {
"format": "date-time",
"type": "string"
},
"starred": {
"type": "boolean"
},
"read": {
"type": "boolean"
},
"userRating": {
"format": "int32",
"type": "integer"
},
"requestType": {
"type": "string"
},
"device": {
"type": "string"
},
"account": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.Insight.InsightAccountDto"
}
},
"tactics": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.ServiceDesk.Request.AssetsDto"
}
},
"techniques": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.ServiceDesk.Request.AssetsDto"
}
},
"reporter": {
"type": "string"
},
"issueKey": {
"type": "string"
},
"customerTicketUrl": {
"type": "string"
},
"jiraServerApiIssueUrl": {
"type": "string"
},
"jiraServiceDeskApiIssueUrl": {
"type": "string"
},
"queue": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.Insight.InsightAccountDto": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"FireHost.Services.ServiceDesk.Request.AssetsDto": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketDetailsDto": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketCommentDto"
}
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketRecipientDto"
}
},
"relatedServers": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketRelatedServerDto"
}
},
"relatedTickets": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketRelatedTicketDto"
}
},
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"isClosed": {
"type": "boolean"
},
"priority": {
"format": "int32",
"type": "integer"
},
"sensitivity": {
"format": "int32",
"type": "integer"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateModified": {
"format": "date-time",
"type": "string"
},
"createdByUserId": {
"format": "int32",
"type": "integer"
},
"lastResponderName": {
"type": "string"
},
"lastResponderDisplayName": {
"type": "string",
"readOnly": true
},
"isArmor": {
"type": "boolean",
"readOnly": true
},
"lastResponderExcerpt": {
"type": "string"
},
"lastResponseDate": {
"format": "date-time",
"type": "string"
},
"starred": {
"type": "boolean"
},
"read": {
"type": "boolean"
},
"userRating": {
"format": "int32",
"type": "integer"
},
"requestType": {
"type": "string"
},
"device": {
"type": "string"
},
"account": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.Insight.InsightAccountDto"
}
},
"tactics": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.ServiceDesk.Request.AssetsDto"
}
},
"techniques": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.ServiceDesk.Request.AssetsDto"
}
},
"reporter": {
"type": "string"
},
"issueKey": {
"type": "string"
},
"customerTicketUrl": {
"type": "string"
},
"jiraServerApiIssueUrl": {
"type": "string"
},
"jiraServiceDeskApiIssueUrl": {
"type": "string"
},
"queue": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketCommentDto": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"commentorId": {
"type": "string"
},
"commentorDisplayName": {
"type": "string",
"readOnly": true
},
"isArmor": {
"type": "boolean",
"readOnly": true
},
"date": {
"format": "date-time",
"type": "string"
},
"isPublic": {
"type": "boolean"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketAttachmentDto"
}
},
"feedback": {
"format": "int32",
"enum": [0, 1, -1],
"type": "integer"
},
"reason": {
"format": "int32",
"enum": [0, 1, 2, 3, 4],
"type": "integer"
},
"read": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketRecipientDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"account": {
"type": "boolean"
},
"billing": {
"type": "boolean"
},
"technical": {
"type": "boolean"
},
"partner": {
"type": "boolean"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketRelatedServerDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"hostName": {
"type": "string"
},
"correlationId": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketRelatedTicketDto": {
"type": "object",
"properties": {
"ticketNumber": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketAttachmentDto": {
"type": "object",
"properties": {
"ticket": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"url": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.Requests.GetAllIssuesRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "int32",
"type": "integer"
},
"userEmail": {
"type": "string"
},
"isEmployee": {
"type": "boolean"
},
"requestType": {
"type": "string"
},
"priority": {
"type": "string"
},
"queue": {
"type": "string"
},
"maxResults": {
"format": "int32",
"type": "integer"
},
"orderBy": {
"type": "string"
},
"nextPageToken": {
"type": "string"
},
"orderByDirection": {
"format": "int32",
"enum": [0, 1],
"type": "integer"
}
}
},
"FireHost.Services.Http.Tickets.ApiExamples.Models.IssueSummarySampleResponse": {
"type": "object",
"properties": {
"issueKeyId": {
"type": "string"
},
"summary": {
"type": "string"
},
"currentStatus": {
"type": "string"
},
"requestType": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.RequestTypeDto"
},
"reporter": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.ParticipantDto"
},
"assignee": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.ParticipantDto"
}
}
},
"FireHost.Infrastructure.Tickets.Models.RequestTypeDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"FireHost.Infrastructure.Tickets.Models.ParticipantDto": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"displayName": {
"type": "string"
}
}
},
"FireHost.Services.Http.Tickets.ApiExamples.Models.IssueDetailsSampleResponse": {
"type": "object",
"properties": {
"issueKeyId": {
"type": "string"
},
"summary": {
"type": "string"
},
"description": {
"type": "string"
},
"assignee": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.ParticipantDto"
},
"reporter": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.ParticipantDto"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.ParticipantDto"
}
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.JiraTicketOrganizationDto"
}
},
"currentStatus": {
"$ref": "#/definitions/FireHost.Services.ServiceDesk.Response.JiraIssueStatus"
},
"requestType": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.RequestTypeDto"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketStatusDto"
}
}
}
},
"FireHost.Infrastructure.Tickets.Models.JiraTicketOrganizationDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"FireHost.Services.ServiceDesk.Response.JiraIssueStatus": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketStatusDto": {
"type": "object",
"properties": {
"fromStatusId": {
"type": "string"
},
"fromStatusString": {
"type": "string"
},
"toStatusId": {
"type": "string"
},
"toStatusString": {
"type": "string"
},
"statusDate": {
"format": "date-time",
"type": "string"
}
}
},
"FireHost.Services.ServiceDesk.Response.ServiceDeskTransitions": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"FireHost.Services.Http.Tickets.ApiExamples.Models.TransitionTicketSampleRequest": {
"type": "object",
"properties": {
"ticketNumber": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"example": {
"ticketNumber": "ATS-123",
"comment": "Optional Comment"
}
},
"FireHost.Infrastructure.Tickets.Models.Responses.TicketMetadataResponse": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketRecipientDto"
}
},
"tickets": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketRelatedTicketDto"
}
},
"servers": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.TicketRelatedServerDto"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FireHost.Infrastructure.Tickets.Models.Responses.TicketGroupsResponseDto": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"ticketGroupTypeName": {
"type": "string"
},
"ticketGroupMemberId": {
"format": "int32",
"type": "integer"
},
"organizationId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Tickets.Models.Responses.TicketGroupResponse]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Tickets.Models.Responses.TicketGroupResponse"
}
}
}
},
"FireHost.Infrastructure.Tickets.Models.Responses.TicketGroupResponse": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"noOfMembers": {
"format": "int32",
"type": "integer"
},
"modified": {
"format": "date-time",
"type": "string"
},
"organizationId": {
"format": "int32",
"type": "integer"
}
}
},
"FireHost.Infrastructure.Tickets.Models.Responses.TicketGroupMembersDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"ticketGroupId": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "int32",
"type": "integer"
},
"organizationId": {
"format": "int32",
"type": "integer"
},
"firstname": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"ticketingOrganizationName": {
"type": "string"
}
}
},
"FireHost.Services.Http.Tickets.ApiExamples.Models.AddTicketGroupMemberSampleRequest": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"ticketGroupId": {
"format": "int32",
"type": "integer"
},
"userId": {
"format": "int32",
"type": "integer"
}
},
"example": {
"accountId": 1,
"ticketGroupId": 3,
"userId": 2
}
},
"FireHost.Services.Http.Tickets.ApiExamples.CreateTicketCommentExampleRequest": {
"type": "object",
"properties": {},
"example": {
"comment": "sample comment text",
"isPublic": false,
"issueKeyId": "ATS-360"
}
},
"FireHost.Infrastructure.Tickets.Models.Responses.JiraTicketComments": {
"type": "object",
"properties": {
"creator": {
"type": "string"
},
"comment": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Services.Http.Tickets.ApiExamples.Models.IssueSummarySampleResponse]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Tickets.ApiExamples.Models.IssueSummarySampleResponse"
}
}
}
},
"FireHost.Infrastructure.Tickets.Models.TicketUser": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"accountId": {
"format": "int32",
"type": "integer"
},
"isEnabled": {
"type": "boolean"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"isEmployee": {
"type": "boolean"
}
}
},
"FireHost.Services.Common.Infrastructure.PagedResultSet[FireHost.Infrastructure.Billing.Models.CoreHeartbeatCoreInstanceUsage]": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Billing.Models.CoreHeartbeatCoreInstanceUsage"
}
}
}
},
"FireHost.Infrastructure.Billing.Models.CoreHeartbeatCoreInstanceUsage": {
"type": "object",
"properties": {
"accountId": {
"format": "int32",
"type": "integer"
},
"accountName": {
"type": "string"
},
"coreInstanceId": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
}
}
}
},
"securityDefinitions": {
"Authorization": {
"type": "apiKey",
"description": "Authorization Token",
"name": "Authorization",
"in": "header"
},
"X-Account-Context": {
"type": "apiKey",
"description": "X-Account-Context",
"name": "X-Account-Context",
"in": "header"
}
}
}