{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Armor Services API"
},
"host": "api.armor.com",
"schemes": ["https"],
"paths": {
"/{entityType}/{entityId}/notes": {
"get": {
"tags": ["Account Management"],
"summary": "Return notes for a given entity type and id. Notes provide a free text field that can be used to storage additional information about a given entity.",
"operationId": "Notes_GetNoteAsync",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "Entity Type (apps)",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "Entity ID",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Account Management"],
"summary": "Add or update notes for a given entity type and id. A free text field that can be used to store additional information about a given entity.",
"operationId": "Notes_UpdateNoteAsync",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "Entity Type (apps)",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "Entity ID",
"required": true,
"type": "string"
}, {
"name": "request",
"in": "body",
"description": "messages: Notes go here",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Meta.ApiExamples.Models.UpdateNoteSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Account Management"],
"summary": "Delete notes for a given entity type and id.",
"operationId": "Notes_DeleteNoteAsync",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "Entity Type",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "Entity ID",
"required": true,
"type": "string"
}, {
"name": "request",
"in": "body",
"description": "Request (empty object)",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Meta.ApiExamples.Models.DeleteNoteSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/{entityType}/{entityId}/tags": {
"get": {
"tags": ["Account Management"],
"summary": "Return tags for entity type and id. Tags are custom meta-data attributes that can be leveraged when searching for a given entity type.",
"operationId": "Tags_GetTagsAsync",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "Entity Type (apps)",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "Entity ID",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"application/json": ["tag1", "tag2"]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Add tags for a given entity type and id.",
"operationId": "Tags_AddTagAsync",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "Entity Type (apps)",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "Entity ID",
"required": true,
"type": "string"
}, {
"name": "request",
"in": "body",
"description": "messages: Tags go here",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Meta.ApiExamples.Models.AddTagSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Account Management"],
"summary": "Delete tags for a given entity type and id.",
"operationId": "Tags_DeleteTagAsync",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "entityType",
"in": "path",
"description": "Entity Type (apps)",
"required": true,
"type": "string"
}, {
"name": "entityId",
"in": "path",
"description": "Entity ID",
"required": true,
"type": "string"
}, {
"name": "request",
"in": "body",
"description": "messages: The name of the tag
\r\n (You must enter the tag as it is logged. Here, tags are case-sensitive.)",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Meta.ApiExamples.Models.DeleteTagSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/account/activity/history": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve list of Account Activity for your account.",
"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 (required): filters down results. Data Type: string. Example: date%20eq%20%27null%27%20and%20type%20eq%20%27null%27%20and%20startDate%20eq%20%272018-10-03T05.00.00%27%20and%20endDate%20eq%20%272018-10-06T04.59.59%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
\r\n Times are submited as UTC",
"operationId": "AccountHistory_GetAccountActivityHistory",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.History.Models.AccountHistoryListResponseDto%5D"
},
"examples": {
"application/json": [{
"account": "Development Test Account",
"accountId": 1,
"type": "Infrastructure",
"date": "2026-02-12T16:25:51.6777668+00:00",
"user": "Development Test User",
"userId": 2,
"activity": "Added tier Example_Tier to workload Example_Workload.",
"details": {
"workloadName": "Example_Workload",
"tierName": "Example_Tier",
"action": "Added",
"user": "Development Test User",
"url": "http://example.url.com/orders/vms"
},
"isInternal": false,
"isArmor": false
}, {
"account": "Development Test Account",
"accountId": 1,
"type": "Security",
"date": "2026-02-12T16:25:51.6777668+00:00",
"user": "Development Test User",
"userId": 2,
"activity": "Enabled SSL VPN access for development.user@armor.com in AMP",
"details": {
"enable": "True",
"location": "DFW",
"accountName": "Development Test Account",
"user": "Development Test User",
"url": "http://example.url.com/sslvpn/enable"
},
"isInternal": false,
"isArmor": false
}]
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/account/children": {
"get": {
"tags": ["Account Management"],
"summary": "Returns a list of child accounts associated to the parent account",
"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%27Active%27
$search (optional): search for specific result. Data Type: string. Example: $search=Armor
$orderby (optional): order by column name (name, account ID, status, deployed agents). Data Type: string. Example: $orderby=Name%20desc",
"operationId": "ChildAccounts_GetAllChildAccounts",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Accounts.Data.Persistence.ChildAccount%5D"
},
"examples": {
"application/json": {
"total": 1,
"page": 1,
"items": [{
"id": 5,
"name": "Company Name 1",
"status": "Active",
"deployedAgents": 3
}, {
"id": 12,
"name": "Company Name 2",
"status": "Cancelled",
"deployedAgents": 0
}]
}
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Creates a child account",
"operationId": "ChildAccounts_CreateChildAccount",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "companyName: Name of the Account
\r\n relationshipEntity: Valid values: INC, LTD
\r\n addressLine1: Address Line 1
\r\n addressLine2: Address Line 2
\r\n city: City
\r\n state: State/Province ISO alpha-2 code
\r\n postalCode: Postal Code
\r\n country: Country ISO alpha-2 code
\r\n phone: Account Phone Number
\r\n website: Account Website
\r\n firstName: First Name
\r\n lastName: Last Name
\r\n email: Email
\r\n title: Title
\r\n currency: Valid values: USD, GBP
\r\n channel: Valid values: SMB, Enterprise, Government
\r\n productLine: Valid values: Anywhere, Complete
\r\n armorAnywhereLocation: Armor agent deployment location. Required if productLine is Anywhere. Valid values: Azure, AWS, Internal IT, Colocation, Other
\r\n armorAnywhereOtherLocation: Armor agent custom deployment location. Required if armorAnywhereLocation is Other
\r\n autoAcceptUserInvite: Setting this property to 'true' bypasses user invitation workflow, permitting users to immediately access the new sub-account.
",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.ChildAccounts.ChildAccountSignupRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/account/children/massgrantaccess": {
"post": {
"tags": ["Account Management"],
"summary": "Give mass access for Parent Account Users to Child Account",
"operationId": "ChildAccounts_MassGrantAccess",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.ChildAccounts.MassGrantAccessRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/account/contacts": {
"get": {
"tags": ["Account Management"],
"summary": "This will return the list of Armor Contacts for the given Armor Account.",
"operationId": "AccountContacts_GetContacts",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Data.Domain.AccountContacts"
}
},
"examples": {
"application/json": {
"accountExecutive": {
"accountId": "1",
"name": "Users Name",
"firstName": "Users",
"lastName": "Name",
"title": "developer",
"email": "user@email.com",
"homePhone": null,
"mobilePhone": null,
"street": "123 street",
"city": "New City",
"state": "TX",
"zipcode": "75000",
"country": "US",
"salesforceId": null,
"type": "AccountOwner"
},
"accountStrategicManager": null
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/account/pricing/{sku}": {
"get": {
"tags": ["Account Management"],
"operationId": "AccountSkuPricing_GetAccountPrice",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "sku",
"in": "path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/account/primary-user": {
"post": {
"tags": ["Account Management"],
"summary": "Set Primary User for one or more notification types",
"operationId": "PrimaryNotificationUser_UpdateAccountPrimaryBillingContact",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "userId: Id of the user being set
\r\n notificationTypes: one or more notification types to be set. Valid values: Account, Billing, Technical
",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.AddUpdatePrimaryNotificationUserRequestSample"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
},
"202": {
"description": "Accepted",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/accounts": {
"get": {
"tags": ["Account Management"],
"summary": "Return a list of accounts and the products related to the account id.",
"operationId": "Accounts_GetAccounts",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.UserAccountDto"
}
},
"examples": {
"application/json": {
"id": 2,
"name": "Development Test Account",
"currency": "USD",
"status": "Claimed",
"parentAccountId": 1,
"products": {
"aA-CORE": ["Monitoring", "Anti-Malware and Virus Protection", "Log Monitoring and Management", "Vulnerability Scanning", "File Integrity Monitoring", "Invoicing"],
"armoR-COMPLETE": ["Server Agent", "Operating System Server Hardening", "Operating System Patching", "Invoicing"]
},
"accountType": null,
"isSynced": false,
"isFreeTrial": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Update the Account information.",
"operationId": "Accounts_UpdateAccount",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "accountUpdateRequest",
"in": "body",
"description": "addressLine1: Recipient Line
addressLine2: Delivery Address Line
city: City
state: State
postalCode: Postal Code
country: Country",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateAccountSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.AccountDetail"
}
},
"examples": {
"application/json": {
"name": "Development Test Account",
"accountId": "2",
"addressLine1": "123 street",
"addressLine2": "ste 500",
"city": "City",
"state": "TX",
"postalCode": "75000",
"country": "US",
"accountSignupType": null
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/accounts/{accountId}": {
"get": {
"tags": ["Account Management"],
"summary": "Get the Account information.",
"operationId": "Accounts_GetAccount",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "accountId",
"in": "path",
"description": "Armor account id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.AccountDetail"
}
},
"examples": {
"application/json": {
"name": "Development Test Account",
"accountId": "2",
"addressLine1": "123 street",
"addressLine2": "ste 500",
"city": "City",
"state": "TX",
"postalCode": "75000",
"country": "US",
"accountSignupType": null
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/accounts/{accountId}/accountusersandrole": {
"get": {
"tags": ["Account Management"],
"summary": "Get the users of an account and their roles",
"operationId": "Accounts_GetAccountUsersAndRole",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "accountId",
"in": "path",
"description": "Armor account id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetRoleUser"
}
}
}
},
"deprecated": false
}
},
"/accounts/{accountId}/primary-billing": {
"get": {
"tags": ["AccountPrimaryBilling"],
"summary": "(Deprecated) Get the Account Primary Billing User",
"operationId": "AccountPrimaryBilling_GetAccountPrimaryBillingContact",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "accountId",
"in": "path",
"description": "account id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetUserResponse"
},
"examples": {
"application/json": {
"id": 2402,
"status": "disabled",
"title": "",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"phonePrimary": {
"countryCode": 1,
"countryIsoCode": "US",
"number": "8880000000",
"phoneExt": null
},
"timezone": "GMT Standard Time",
"culture": "en-US",
"permissions": [1],
"lastModified": "2015-09-22T15:28:06.89",
"passwordLastSet": "1999-01-01T00:00:00",
"mustChangePassword": false,
"lastLogin": "1999-01-01T00:00:00",
"apiKeyCount": 0,
"isPrimaryBillingNotificationUser": false,
"isPrimaryAccountNotificationUser": false,
"isPrimaryTechnicalNotificationUser": false
}
}
}
},
"deprecated": false
},
"put": {
"tags": ["AccountPrimaryBilling"],
"summary": "(Deprecated) Update the Account Primary Billing User. Instead use account/primary-notificationcontact endpoint to achieve same functionality",
"operationId": "AccountPrimaryBilling_UpdateAccountPrimaryBillingContact",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "accountId",
"in": "path",
"description": "account id",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "userId",
"in": "body",
"description": "user id",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.Requests.UpdateAccountPrimaryBillingContactRequest"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/accounts/{accountId}/roles": {
"get": {
"tags": ["Account Management"],
"summary": "Get the Roles of an account",
"operationId": "Accounts_GetRoles",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "accountId",
"in": "path",
"description": "Armor account id",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetRolesResponse"
}
}
}
},
"deprecated": false
}
},
"/cloud-connections": {
"post": {
"tags": ["Account Management"],
"summary": "Retrieve All Cloud Connections based on Account Id.",
"operationId": "CloudConnections_CloudConnections",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "Parameters: Contains page number, pagesize, search text, sort order, filter by and sorting field
",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.CloudConnections.Models.Requests.ServiceParams"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionsDto"
}
},
"examples": {
"application/json": {
"id": 1,
"accountId": 0,
"name": "AWS(Development)",
"externalId": "78a1d8dc-4d73-4575-8828-eb37bef28742",
"provider": "AWS",
"providerAccountId": "345186984524",
"providerAccessResource": null,
"total": 1,
"isEnabled_Beta": false,
"isEnabled_Ec2": false,
"isEnabled_Log": false,
"setupStatus": "Completed",
"services": []
}
}
},
"400": {
"description": "Invalid Request"
}
},
"deprecated": false
}
},
"/cloud-connections/{connectionId}": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve cloud connection detail by connection Id",
"operationId": "CloudConnections_CloudConnectionDetails",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "connectionId",
"in": "path",
"description": "Cloud connection Id to get the cloud connection details",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionDetailsDto"
}
},
"examples": {
"application/json": {
"armorAwsAccountId": "679703615338",
"connectionName": "AWS(Development)",
"description": "For Search",
"externalId": "33c6b08a-0872-4908-97f4-81b61a0d9235",
"providerAccessResource": "arn:aws:iam::d345186984524:role/armor_audit",
"accountConnectionId": 1,
"providerTypeName": "AWS",
"serviceTypeName": "CloudTrail Log Ingestion",
"awsBaseJsonPolicy": "Enable the following policies on AWS:",
"subServiceName": null
}
}
},
"400": {
"description": "Invalid Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Account Management"],
"summary": "Soft Delete Cloud Connection by Id.",
"operationId": "CloudConnections_CloudConnection",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "connectionId",
"in": "path",
"description": "Cloud connection Id to delete the cloud connection data",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Invalid request."
}
},
"deprecated": false
}
},
"/cloud-connections/connections/isEnabled": {
"get": {
"tags": ["Account Management"],
"summary": "Check whether any enabled cloud connections exist.",
"operationId": "CloudConnections_CloudConnectionsEnabled",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/cloud-connections/savecloudconnection": {
"post": {
"tags": ["Account Management"],
"summary": "Save cloud connection details.",
"operationId": "CloudConnections_SaveCloudConnectionsDetails",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "cloudConnectionDetailsDto",
"in": "body",
"description": "connectionName: Connection Name
\r\n description: Description
\r\n armorAwsAccountId: Armor AWS account id
\r\n externalId: External id
\r\n providerAccessResource: Provider access resource
\r\n providerTypeName:Provider type name
\r\n accountConnectionId:Account connection id
\r\n serviceTypeName:Service type name
\r\n accountId:Account id",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionDetailsDto"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionDetailsDto"
}
},
"examples": {
"application/json": {
"id": 1,
"accountId": 0,
"name": "AWS(Development)",
"externalId": "98f5da34-d763-48ca-bfe5-291c19ed01c1",
"provider": "AWS",
"providerAccountId": "345186984524",
"providerAccessResource": null,
"total": 1,
"isEnabled_Beta": false,
"isEnabled_Ec2": false,
"isEnabled_Log": false,
"setupStatus": "Completed",
"services": []
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/cloud-connections/servicetypes": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve All Connection Service Types.",
"operationId": "CloudConnections_AllServiceTypes",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionServiceTypesDto"
}
},
"examples": {
"application/json": {
"id": 1,
"name": "AWS Security Hub",
"subServices": [{
"id": 1,
"name": "Malware",
"subServiceName": null,
"imageName": "securityhub.svg",
"policy": null
}],
"policy": "securityhub*",
"imageName": null
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/cloud-connections/summary": {
"get": {
"tags": ["Account Management"],
"summary": "Cloud connectiion summary dto used by ngx-portal\r\n Returns cloud connection list for security hub",
"operationId": "CloudConnections_CloudConnectionsSummary",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionsSummaryDto"
}
},
"examples": {
"application/json": {
"armorAwsAccountId": "679703615338",
"connectionName": "AWS(Development)",
"description": "For Search",
"externalId": "1f7ffe08-3174-4678-a8c3-d15ef4ab07be",
"providerAccessResource": "arn:aws:iam::d345186984524:role/armor_audit",
"accountConnectionId": 1,
"providerTypeName": "AWS",
"serviceTypeName": "CloudTrail Log Ingestion",
"awsBaseJsonPolicy": "Enable the following policies on AWS:",
"subServiceName": null
}
}
},
"400": {
"description": "Invalid Request"
}
},
"deprecated": false
}
},
"/internal/awssecurityhub/audits": {
"get": {
"tags": ["Account Management"],
"summary": "Get AWS SecurityHub audit logs",
"operationId": "InternalAWSSecurityHubAudit_GetAWSSecurityHubAuditsAsync",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/internal/awssecurityhub/audits/{id}": {
"get": {
"tags": ["Account Management"],
"summary": "Get AWS SecurityHub payload by Id",
"operationId": "InternalAWSSecurityHubAudit_GetAuditsPayloadByIdAsync",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
}
},
"/invoices": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve invoices for an account.",
"operationId": "Invoice_GetInvoices",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.InvoiceResponse"
}
},
"examples": {
"application/json": [{
"invoiceId": "2c92a0b05925c98701595a9eeaa45251",
"invoiceNumber": "INV0010001",
"invoiceDate": "2015-01-01T00:00:00",
"invoiceDueDate": "2015-02-01T00:00:00",
"amount": 900,
"status": "Unpaid",
"remainingBalance": 900
}, {
"invoiceId": "2c92a0b158aa8e0b0158bb805071233e",
"invoiceNumber": "INV0010000",
"invoiceDate": "2015-12-01T00:00:00",
"invoiceDueDate": "2015-01-01T00:00:00",
"amount": 900,
"status": "Paid",
"remainingBalance": 0
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/invoices/{id}": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve the invoice summary for an invoice.",
"description": "Response Type: application/json or application/pdf - depends on Accept header on request",
"operationId": "Invoice_GetInvoiceSummary",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the requested invoice",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.InvoiceSummary"
},
"examples": {
"application/json": {
"lineItems": [{
"productLine": "Armor | Complete",
"category": "Network",
"subCategory": "Network + Connectivity",
"sku": "IP-001",
"name": "IP Address - Allocated",
"itemTotal": 42.65
}],
"invoiceNumber": "INV00100000",
"invoiceDate": "2015-12-22T00:00:00",
"billingPeriodStartDate": "2015-12-22T00:00:00",
"billingPeriodEndDate": "2015-12-31T00:00:00",
"paymentStatus": "Unpaid",
"subTotal": 7794.64,
"lineItemDiscounts": -85.15,
"invoiceTotal": 7709.48,
"billTo": {
"name": "Company",
"addressLine1": "1234 Main St",
"addressLine2": "",
"city": "Dallas",
"state": "TX",
"postalCode": "12345",
"country": "US"
},
"soldTo": {
"name": "Company",
"addressLine1": "1234 Main St",
"addressLine2": "",
"city": "Dallas",
"state": "TX",
"postalCode": "12345",
"country": "US"
},
"remitTo": {
"name": "Armor INC",
"addressLine1": "2360 Campbell Creek Blvd.",
"addressLine2": "Suite 525",
"city": "Richardson",
"state": "TX",
"postalCode": "75082",
"country": "US"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Invoice not found."
}
},
"deprecated": false
}
},
"/invoices/{id}/detail": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve invoice export detail for an invoice.",
"description": "Response Type: application/json or text/csv - depends on Accept header on request",
"operationId": "Invoice_GetInvoicesDetail",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the requested invoice",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Invoice not found."
}
},
"deprecated": false
}
},
"/paymentmethods": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve payment methods for an account.",
"operationId": "PaymentMethod_GetPaymentMethods",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.PaymentMethod"
}
},
"examples": {
"application/json": [{
"id": 1,
"accountBillingId": 1,
"name": "Corporate Visa",
"paymentMethodId": "2c92c0f959687a90015975b882f515a0",
"paymentType": "CreditCard",
"achRoutingNumber": "",
"achAccountMaskNumber": "",
"creditCardType": "",
"creditCardMaskNumber": "****1114",
"creditCardExpirationMonth": 2,
"creditCardExpirationYear": 2020,
"createdDate": "2015-01-06T21:38:52.027",
"createdBy": "2",
"modifiedDate": null,
"modifiedBy": null,
"status": "Pending",
"isDeleted": false,
"isPrimary": true
}]
}
}
},
"deprecated": false
}
},
"/paymentmethods/{id}": {
"delete": {
"tags": ["Account Management"],
"summary": "Delete payment method from an account",
"description": "Primary payment method cannot be deleted",
"operationId": "PaymentMethod_DeletePaymentMethodById",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of the payment method that you want to delete",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "modifiedBy: The user that is requesting the modification",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.DeletePaymentMethodByIdSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"patch": {
"tags": ["Account Management"],
"summary": "Update payment method on an account.",
"operationId": "PaymentMethod_SetDefaultPaymentMethod",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of the payment method that you want to delete",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Indicate whether the payment method should be set as primary",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.SetDefaultPaymentMethodSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/permissions": {
"get": {
"tags": ["Account Management"],
"summary": "Get a list of all permissions available on the account.",
"operationId": "Roles_GetPermissions",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetPermissionsResponse"
}
},
"examples": {
"application/json": [{
"name": "accounts",
"permissions": [{
"id": 29,
"name": "Read Identity",
"system": "Identity",
"resource": "Accounts",
"endpoints": [{
"method": "GET",
"route": "accounts"
}, {
"method": "GET",
"route": "accounts/{accountId}"
}, {
"method": "GET",
"route": "account/contacts"
}, {
"method": "GET",
"route": "roles"
}, {
"method": "GET",
"route": "roles/{id}"
}, {
"method": "GET",
"route": "users"
}, {
"method": "GET",
"route": "users/{id}"
}, {
"method": "GET",
"route": "usersecurity/challengephrase"
}, {
"method": "GET",
"route": "usersecurity/challengephrase/{userId}"
}, {
"method": "GET",
"route": "usersecurity/securityquestions"
}, {
"method": "GET",
"route": "users/LockedOut/{accountId}/{email}"
}, {
"method": "GET",
"route": "survey/{accountId}/{userId}"
}],
"description": "View account information."
}, {
"id": 32,
"name": "Write Account",
"system": "identity",
"resource": "accounts",
"endpoints": [{
"method": "POST",
"route": "accounts"
}],
"description": "Update account information"
}]
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/products": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve any product lists that are associated to your Account.",
"operationId": "ProductCatalog_GetProductLists",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Billing.Data.Persistence.ProductList"
}
},
"examples": {
"application/json": [{
"id": 1,
"name": "Armor USD",
"category": "Primary",
"currency": "USD",
"salesforceId": null
}]
}
}
},
"deprecated": false
}
},
"/products/{id}": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve a specific product list that is associated to your Account.",
"operationId": "ProductCatalog_GetProductList",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the product list of the desired products",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.ProductListItemModel"
}
},
"examples": {
"application/json": [{
"name": "SSD (GB)",
"sku": "SAN-001",
"category": "Disk",
"description": "SSD-based storage",
"typeCode": "PT02",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 1.7,
"units": null
}, {
"location": "PHX01",
"amount": 1.7,
"units": null
}],
"priceType": "PerUnit",
"tier": "SSD",
"min": 10,
"max": 500,
"increment": 10,
"billingOnly": false,
"hasRules": false
}, {
"name": "Fluid (GB)",
"sku": "SAN-002",
"category": "Disk",
"description": "Fluid-based storage",
"typeCode": "PT02",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 0.75,
"units": null
}, {
"location": "PHX01",
"amount": 0.75,
"units": null
}],
"priceType": "PerUnit",
"tier": "Fluid",
"min": 50,
"max": 2000,
"increment": 50,
"billingOnly": false,
"hasRules": false
}, {
"name": "RAW (GB)",
"sku": "SAN-003",
"category": "Disk",
"description": "RAW-based storage",
"typeCode": "PT02",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 0.15,
"units": null
}, {
"location": "PHX01",
"amount": 0.15,
"units": null
}],
"priceType": "PerUnit",
"tier": "RAW",
"min": 250,
"max": 2000,
"increment": 250,
"billingOnly": false,
"hasRules": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/products/{id}/{category}": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve a filtered list of products specific to a category within a given product list on your Account.",
"operationId": "ProductCatalog_GetProductListByCategory",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the product list of the desired products",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "category",
"in": "path",
"description": "Category of the desired products in the product list",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.ProductListItemModel"
}
},
"examples": {
"application/json": [{
"name": "A1-CentOS 6",
"sku": "A1-101",
"category": "Instance",
"description": "Armor-hardened 64-bit CentOS 6 image with 30GB SSD storage",
"typeCode": "PT01",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 25,
"units": null
}, {
"location": "PHX01",
"amount": 25,
"units": null
}],
"priceType": "PerUnit",
"instanceSeries": "A",
"cpu": 1,
"memory": 2,
"baseDiskSize": 30,
"baseDiskTier": "SSD",
"operatingSystem": "CentOS 6",
"billingOnly": false,
"hasRules": false
}, {
"name": "A1-CentOS 7",
"sku": "A1-102",
"category": "Instance",
"description": "Armor-hardened 64-bit CentOS 7 image with 30GB SSD storage",
"typeCode": "PT01",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 25,
"units": null
}, {
"location": "PHX01",
"amount": 25,
"units": null
}],
"priceType": "PerUnit",
"instanceSeries": "A",
"cpu": 1,
"memory": 2,
"baseDiskSize": 30,
"baseDiskTier": "SSD",
"operatingSystem": "CentOS 7",
"billingOnly": false,
"hasRules": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/products/{id}/resizeinstance": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve a resizable list of products specific to a instance.",
"operationId": "ProductCatalog_GetResizableInstanceProductList",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id for the product list of the desired products",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.ProductListItemModel"
}
},
"examples": {
"application/json": [{
"name": "A1-CentOS 6",
"sku": "A1-101",
"category": "Instance",
"description": "Armor-hardened 64-bit CentOS 6 image with 30GB SSD storage",
"typeCode": "PT01",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 25,
"units": null
}, {
"location": "PHX01",
"amount": 25,
"units": null
}],
"priceType": "PerUnit",
"instanceSeries": "A",
"cpu": 1,
"memory": 2,
"baseDiskSize": 30,
"baseDiskTier": "SSD",
"operatingSystem": "CentOS 6",
"billingOnly": false,
"hasRules": false
}, {
"name": "A1-CentOS 7",
"sku": "A1-102",
"category": "Instance",
"description": "Armor-hardened 64-bit CentOS 7 image with 30GB SSD storage",
"typeCode": "PT01",
"storagePolicyClass": null,
"chargeType": null,
"price": [{
"location": "DFW01",
"amount": 25,
"units": null
}, {
"location": "PHX01",
"amount": 25,
"units": null
}],
"priceType": "PerUnit",
"instanceSeries": "A",
"cpu": 1,
"memory": 2,
"baseDiskSize": 30,
"baseDiskTier": "SSD",
"operatingSystem": "CentOS 7",
"billingOnly": false,
"hasRules": false
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/roles": {
"get": {
"tags": ["Account Management"],
"summary": "Get a list of all roles on an account, including the associated permissions and assigned users.",
"operationId": "Roles_GetRoles",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetAccountRolePermissionsResponse"
}
},
"examples": {
"application/json": [{
"id": 4,
"name": "Admin",
"created": "2015-12-13T02:00:46.51",
"modified": null,
"members": [{
"id": 2,
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"added": "2015-12-13T02:01:30.923",
"enabled": true,
"roleId": 0
}],
"permissions": [1, 2, 3],
"default": true
}]
}
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Create a role with a group of permissions.",
"operationId": "Roles_CreateRole",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "Name and Permissions",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.CreateRoleSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetAccountRolePermissionsResponse"
}
},
"examples": {
"application/json": {
"id": 8,
"name": "Role 1",
"created": "2015-01-07T00:25:05.103",
"modified": null,
"members": [],
"permissions": [1, 2, 3],
"default": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/roles/{id}": {
"get": {
"tags": ["Account Management"],
"summary": "GET a role by the role id.",
"operationId": "Roles_GetRole",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Role ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetAccountRolePermissionsResponse"
}
},
"examples": {
"application/json": {
"id": 4,
"name": "Admin",
"created": "2015-12-13T02:00:46.51",
"modified": null,
"members": [{
"id": 2,
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"added": "2015-12-13T02:01:30.923",
"enabled": true,
"roleId": 0
}],
"permissions": [1, 2, 3],
"default": true
}
}
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Update the name and/or permissions assigned to a role.",
"operationId": "Roles_UpdateRole",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Role ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Name and Permissions",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateRoleSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetAccountRolePermissionsResponse"
}
},
"examples": {
"application/json": {
"id": 4,
"name": "Admin",
"created": "2015-12-13T02:00:46.51",
"modified": null,
"members": [{
"id": 2,
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"added": "2015-12-13T02:01:30.923",
"enabled": true,
"roleId": 0
}],
"permissions": [1, 2, 3],
"default": true
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"delete": {
"tags": ["Account Management"],
"summary": "Delete a role by id.",
"operationId": "Roles_DeleteRole",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Role ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/roles/{id}/members/{userId}": {
"post": {
"tags": ["Account Management"],
"summary": "Add a user to a role.",
"operationId": "Roles_UpdateRoleMember",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Role ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.RBAC.Data.Domain.RoleUser"
}
},
"examples": {
"application/json": {
"roleId": 4,
"id": 3,
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"createdDate": "2015-01-07T00:46:24.157",
"isEnabled": true
}
}
},
"404": {
"description": "User cannot be found for the account"
}
},
"deprecated": false
},
"delete": {
"tags": ["Account Management"],
"summary": "Delete a user from a role.",
"operationId": "Roles_DeleteRoleMember",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "Role ID",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.RBAC.Data.Domain.RoleUser"
}
},
"examples": {
"application/json": {
"roleId": 4,
"id": 3,
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"createdDate": "2015-01-07T00:46:24.157",
"isEnabled": true
}
}
},
"404": {
"description": "User cannot be found for the account"
}
},
"deprecated": false
}
},
"/subscriptions": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve subscriptions for an account.",
"operationId": "Subscription_GetSubscriptions",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.SubscriptionResponse"
}
},
"examples": {
"application/json": [{
"uniqueProductIdentifier": "a4bee0fd-4a3c-4c23-87a1-bc2a136e6d06",
"productName": "SQL Server Express 2016",
"productCategory": "Software License",
"quantity": 1,
"sku": "DB-SQL-EXPRESS-2016",
"price": 0,
"totalPrice": 0,
"ticketNumber": null,
"contractEffectiveDate": null,
"pendingCancellation": false,
"ticketKey": null
}]
}
}
},
"deprecated": false
}
},
"/subscriptions/account-details": {
"get": {
"tags": ["Account Management"],
"summary": "Get partner customer details for logged-in account.",
"operationId": "SubscriptionUsage_GetAllAccountDetailsForPartner",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Billing.Models.AccountListDto"
}
}
}
},
"deprecated": false
}
},
"/subscriptions/account-usage": {
"get": {
"tags": ["Account Management"],
"summary": "Get account all usage for billing period.",
"operationId": "SubscriptionUsage_GetAccountUsage",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.Usage.AccountUsageResponse"
}
}
}
},
"deprecated": false
}
},
"/subscriptions/account-usagedetails": {
"get": {
"tags": ["Account Management"],
"summary": "Get usage details for partner and partner customers",
"operationId": "SubscriptionUsage_GetAccountUsageDetails",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.Models.Usage.AccountUsageResponse"
}
}
}
},
"deprecated": false
}
},
"/subscriptions/actions/cancel": {
"post": {
"tags": ["Account Management"],
"summary": "Cancel an active subscription.",
"operationId": "Subscription_CancelSubscription",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "sku: Sku of the product to be removed
\r\n UniqueProductIdentifier: Identifier for the specific product to be removed",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Billing.ApiExamples.Models.CancelSubscriptionSampleRequest"
}
}],
"responses": {
"200": {
"description": ""
},
"202": {
"description": "Accepted"
}
},
"deprecated": false
}
},
"/subscriptions/hourlyusage": {
"get": {
"tags": ["Account Management"],
"summary": "Get partners and partner customers hourly usagedetails for logged-in account.",
"operationId": "SubscriptionUsage_GetHourlyUsage",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Billing.Models.AccountHourlyUsageItem"
}
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": false
}
},
"/usage": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve Usage records for an account.",
"operationId": "Usage_GetAccountUsage",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetUsageResponse"
}
},
"examples": {
"application/json": [{
"accountId": 2,
"sku": "SKU-001",
"vmId": 2079,
"quantity": 2,
"usageDate": "2018-04-04"
}]
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve a list of users for an account.",
"operationId": "Users_GetUsers",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetUserResponse"
}
},
"examples": {
"application/json": {
"id": 2540,
"status": "disabled",
"title": "",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"phonePrimary": {
"countryCode": 1,
"countryIsoCode": null,
"number": "8880000000",
"phoneExt": null
},
"timezone": "GMT Standard Time",
"culture": "en-US",
"permissions": [1, 2],
"lastModified": "2015-12-08T20:25:34.083",
"passwordLastSet": "1999-01-01T00:00:00",
"mustChangePassword": false,
"lastLogin": "2025-02-08T20:25:34.083",
"apiKeyCount": 15,
"isPrimaryBillingNotificationUser": false,
"isPrimaryAccountNotificationUser": false,
"isPrimaryTechnicalNotificationUser": false
}
}
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Invite a new or existing user to an account.",
"operationId": "Users_CreateAccountUser",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "firstName First name of the user you want to create
\r\n lastName: Last name of the user you want to create
\r\n email: Email of the user you want to create
\r\n roles: Array of roles you want to apply to the user
",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.CreateAccountUserSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.CreateAccountResponse"
}
},
"examples": {
"application/json": {
"id": 2598
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users/{id}": {
"get": {
"tags": ["Account Management"],
"summary": "Get details about a specific user.",
"operationId": "Users_GetUser",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of the user",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.GetUserResponse"
}
},
"examples": {
"application/json": {
"id": 2402,
"status": "disabled",
"title": "",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"phonePrimary": {
"countryCode": 1,
"countryIsoCode": "US",
"number": "8880000000",
"phoneExt": null
},
"timezone": "GMT Standard Time",
"culture": "en-US",
"permissions": [1],
"lastModified": "2015-09-22T15:28:06.89",
"passwordLastSet": "1999-01-01T00:00:00",
"mustChangePassword": false,
"lastLogin": "1999-01-01T00:00:00",
"apiKeyCount": 0,
"isPrimaryBillingNotificationUser": false,
"isPrimaryAccountNotificationUser": false,
"isPrimaryTechnicalNotificationUser": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Account Management"],
"summary": "Update the attributes of a user.",
"operationId": "Users_UpdateUser",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "id of the user",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "user",
"in": "body",
"description": "firstName: First name
\r\n lastName: Last name
\r\n status: Enabled or disabled status
\r\n phonePrimary: Phone object",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateUserSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"id": 2381,
"firstName": "John",
"lastName": "Smith",
"title": "",
"timezone": "GMT Standard Time",
"culture": "en-US",
"phonePrimary": {
"countryCode": 1,
"countryIsoCode": "US",
"number": "8880000000",
"phoneExt": null
},
"accountid": 2093
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users/{id}/keys": {
"get": {
"tags": ["Keys"],
"summary": "/Returns list of api keys for a user",
"operationId": "Keys_GetApiTokenList",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.ApiKey"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Example Key Name",
"createdDate": "2026-02-12T00:00:00+00:00",
"lastUsed": "2026-02-12T16:25:56.4275729Z",
"keyStatus": "True"
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
},
"put": {
"tags": ["Keys"],
"summary": "Rename Api key",
"operationId": "Keys_RenameAPIKey",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "updateApiKeyRequest",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.UpdateApiKeyRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/System.Object"
}
}
},
"deprecated": false
},
"post": {
"tags": ["Keys"],
"summary": "Method to create Api Key",
"operationId": "Keys_CreateAPIKey",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "User Id",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "request",
"in": "body",
"description": "Create Api Key request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.CreateApiKeyRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.CreateApiKeyResponse"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users/{id}/keys/{key}": {
"delete": {
"tags": ["Keys"],
"summary": "Deletes api key",
"operationId": "Keys_DeleteApiKey",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "id",
"in": "path",
"description": "User Id",
"required": true,
"type": "integer",
"format": "int32"
}, {
"name": "key",
"in": "path",
"description": "Key Id",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
},
"examples": {
"application/json": true
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users/{userId}/invite": {
"post": {
"tags": ["Account Management"],
"summary": "Resend email invitation for an invited user.",
"operationId": "Users_ResendAccountInvite",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "userId",
"in": "path",
"description": "id of the user",
"required": true,
"type": "integer",
"format": "int32"
}],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users/notifications": {
"get": {
"tags": ["Account Management"],
"summary": "Get a user's notification settings. Notification settings determine the types of notifications a given user is subscribed to (e.g. Technical notifications, Ticket notifications, etc.).",
"operationId": "Users_GetUserNotificationPreferences",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Infrastructure.Accounts.Data.Persistence.UserNotificationPreferencesResponse"
}
},
"examples": {
"application/json": {
"notificationPreferences": [{
"notificationTypeId": 7,
"notificationType": "Billing",
"alert": true,
"sms": false,
"email": false
}, {
"notificationTypeId": 3,
"notificationType": "Ticket",
"alert": true,
"sms": false,
"email": true
}, {
"notificationTypeId": 2,
"notificationType": "Security",
"alert": false,
"sms": false,
"email": false
}, {
"notificationTypeId": 1,
"notificationType": "Account",
"alert": false,
"sms": false,
"email": true
}, {
"notificationTypeId": 8,
"notificationType": "Technical",
"alert": false,
"sms": false,
"email": true
}]
}
}
}
},
"deprecated": false
},
"post": {
"tags": ["Account Management"],
"summary": "Update the notification settings for a user.",
"operationId": "Users_CreateUserNotificationPreferences",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "userId: id of the user
\r\n isSelfUpdate:Where the user you are updating is yourself
\r\n NotificationPreferences: Array of UserNotificationPreferences",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.CreateUserNotificationPreferenceSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/users/simpleUserList": {
"get": {
"tags": ["Account Management"],
"summary": "Retrieve a simplified list of users for an account.",
"operationId": "Users_GetUsersSimpleList",
"consumes": [],
"produces": ["application/json", "text/json"],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Accounts.Data.Persistence.AccountUserSimple%5D"
},
"examples": {
"application/json": {
"total": 10,
"page": 1,
"items": [{
"id": 2540,
"accountId": 1,
"isEnabled": true,
"title": "",
"lastModified": "2015-12-08T20:25:34.083",
"lastLoginTime": "2025-02-08T20:25:34.083",
"firstName": null,
"lastName": null,
"name": "John Smith",
"email": "john.smith@example.com",
"isEmployee": false,
"timeZoneId": "GMT Standard Time",
"culture": "en-US",
"invitationAcceptedDate": "2026-02-12T16:25:50.5025965+00:00",
"apiKeyCount": 15,
"status": "enabled",
"total": null,
"isPrimaryBillingNotificationUser": false,
"isPrimaryAccountNotificationUser": false,
"isPrimaryTechnicalNotificationUser": false
}, {
"id": 2541,
"accountId": 1,
"isEnabled": true,
"title": "",
"lastModified": "2015-11-08T20:25:34.083",
"lastLoginTime": "2025-11-03T20:25:34.083",
"firstName": null,
"lastName": null,
"name": "John Smith2",
"email": "john.smith2@example.com",
"isEmployee": false,
"timeZoneId": "GMT Standard Time",
"culture": "en-US",
"invitationAcceptedDate": "2026-02-12T16:25:50.5025965+00:00",
"apiKeyCount": 10,
"status": "enabled",
"total": null,
"isPrimaryBillingNotificationUser": false,
"isPrimaryAccountNotificationUser": false,
"isPrimaryTechnicalNotificationUser": false
}]
}
}
}
},
"deprecated": false
}
},
"/users/status": {
"post": {
"tags": ["Account Management"],
"summary": "Enable or disable a user on an account.",
"operationId": "Users_UpdateUserStatus",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "isEnabled: Whether the user is enabled or not
\r\n accountId: id of the account
\r\n id: Id of the user",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateUserStatusSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.Models.UpdateUserStatusResponse"
}
},
"examples": {
"application/json": {
"userId": 5718,
"isEnabled": false
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/usersecurity/challengephrase": {
"put": {
"tags": ["Account Management"],
"summary": "Update the user challenge phrase for a given user account.",
"operationId": "UserSecurity_UpdateChallengePhrase",
"consumes": ["application/json", "text/json", "application/x-www-form-urlencoded"],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "request",
"in": "body",
"description": "Request",
"required": true,
"schema": {
"$ref": "#/definitions/FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateChallengePhraseSampleRequest"
}
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": ""
}
},
"examples": {
"application/json": {
"userId": 0,
"challengePhrase": "what is your mother's maiden name?",
"challengeAnswer": "maiden",
"userName": "user@example.com",
"signedInUserId": 0
}
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/utilization/{reportType}": {
"get": {
"tags": ["Utilization"],
"summary": "Retrieve Utilization for an account.",
"description": "Response Type: csv or zip file based on the report Type.",
"operationId": "Utilization_GetUtilization",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "reportType",
"in": "path",
"description": "Type of the report required. All, Detail, ByHost, ByHour",
"required": true,
"type": "string"
}, {
"name": "startDate",
"in": "query",
"description": "Start Date of the report (YYYY-MM-DD)",
"required": true,
"type": "string",
"format": "date-time"
}, {
"name": "endDate",
"in": "query",
"description": "End Date of the report (YYYY-MM-DD)",
"required": true,
"type": "string",
"format": "date-time"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request"
}
},
"deprecated": false
}
},
"/utilization/usage-for": {
"get": {
"tags": ["Utilization"],
"summary": "Retrieve Utilization for an account group by Core Instance.",
"description": "End Date should be later than Start Date. But not over 1 month later than Start Date.
Get request URI contain the following query options
$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
",
"operationId": "Utilization_GetUsagePerCoreInstance",
"consumes": [],
"produces": ["application/json", "text/json"],
"parameters": [{
"name": "startDate",
"in": "query",
"description": "Start Date of the report (YYYY-MM-DD)",
"required": true,
"type": "string",
"format": "date-time"
}, {
"name": "endDate",
"in": "query",
"description": "End Date of the report (YYYY-MM-DD).",
"required": true,
"type": "string",
"format": "date-time"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FireHost.Services.Common.Infrastructure.PagedResultSet%5BFireHost.Infrastructure.Billing.Models.CoreHeartbeatCoreInstanceUsage%5D"
}
},
"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"
}
}
}