{ "x-generator": "NSwag v13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "Citrix Monitor Service API for Developer Portal", "version": "devportal-cloud-ga" }, "servers": [ { "url": "https://api.cloud.com/monitorodata", "description": "For customers in US/EU/APS region" }, { "url": "https://api.citrixcloud.jp/monitorodata", "description": "For customers in JP region" } ], "paths": { "/ApplicationActivitySummaries": { "get": { "tags": [ "ApplicationActivitySummaries" ], "summary": "Get all ApplicationActivitySummaries", "description": "Roll up table for Application instances", "operationId": "ApplicationActivitySummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SummaryDate, ApplicationId, DesktopGroupId, Granularity.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationActivitySummaries.\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationActivitySummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationErrors": { "get": { "tags": [ "ApplicationErrors" ], "summary": "Get all ApplicationErrors", "description": "Record of an application error", "operationId": "ApplicationErrors", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SessionKey, MachineId, ErrorReportedDate, FaultingApplicationPath, BrowserNames and FaultingApplicationPath.", "schema": { "type": "string" }, "example": "ErrorReportedDate gt 2024-12-01T00:00:00Z and ErrorReportedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationErrors\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationErrorsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationFaults": { "get": { "tags": [ "ApplicationFaults" ], "summary": "Get all ApplicationFaults", "description": "Record of an application fault", "operationId": "ApplicationFaults", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SessionKey, MachineId, FaultReportedDate, FaultingApplicationPath, BrowserNames, MachineId.", "schema": { "type": "string" }, "example": "FaultReportedDate gt 2024-12-01T00:00:00Z and FaultReportedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationFaults\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFaultsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationInstances": { "get": { "tags": [ "ApplicationInstances" ], "summary": "Get all ApplicationInstances", "description": "A running or previously running instance of a published application within a session.", "operationId": "ApplicationInstances", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: EndDate, StartDate, SessionKey, ApplicationId, ModifiedDate.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationInstances\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationInstancesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Applications": { "get": { "tags": [ "Applications" ], "summary": "Get all Applications", "description": "Represents a published application known to the Monitor service. Each time a user launches this application the run is tracked separately as an ApplicationInstance.", "operationId": "Applications", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: Path, BrowserName", "schema": { "type": "string" }, "example": "BrowserName eq 'MyBrowserName'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Applications\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/AutoScalePredictions": { "get": { "tags": [ "AutoScalePredictions" ], "summary": "Get all AutoScalePredictions", "description": "Autoscale prediction record containing forecasted values used to drive proactive power management for a delivery group.", "operationId": "AutoScalePredictions", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: PredictionDate", "schema": { "type": "string" }, "example": "PredictionDate gt 2024-12-01T00:00:00Z and PredictionDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all AutoScalePredictions", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScalePredictionsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Catalogs": { "get": { "tags": [ "Catalogs" ], "summary": "Get all Catalogs", "description": "A machine catalog defining provisioning, allocation, and session support.", "operationId": "Catalogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Catalogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ConnectionFailureCategories": { "get": { "tags": [ "ConnectionFailureCategories" ], "summary": "Get all ConnectionFailureCategories", "description": "ConnectionFailureCategory, grouping for Connection failure types", "operationId": "ConnectionFailureCategories", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ConnectionFailureCategories\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionFailureCategoriesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ConnectionFailureLogs": { "get": { "tags": [ "ConnectionFailureLogs" ], "summary": "Get all ConnectionFailureLogs", "description": "ConnectionFailureLog", "operationId": "ConnectionFailureLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: FailureDate, SessionKey, MachineId, UserId, ConnectionId.", "schema": { "type": "string" }, "example": "FailureDate gt 2024-12-01T00:00:00Z and FailureDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ConnectionFailureLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionFailureLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Connections": { "get": { "tags": [ "Connections" ], "summary": "Get all Connections", "description": "Summary collection object for session detail information - a new record will be created for every connect/reconnect on the same session All session connect data points will be captured in this class", "operationId": "Connections", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: EstablishmentDate, DisconnectDate, SessionKey, LogOnStartDate, InteractiveEndDate, CreatedDate. ", "schema": { "type": "string" }, "example": "EstablishmentDate gt 2024-12-01T00:00:00Z and EstablishmentDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Connections\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/DesktopGroups": { "get": { "tags": [ "DesktopGroups" ], "summary": "Get all DesktopGroups", "description": "Assignment for - get-brokerdesktopgroup cmdlet", "operationId": "DesktopGroups", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: Id.", "schema": { "type": "string" }, "example": "CreatedDate gt 2024-12-01T00:00:00Z and CreatedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all DesktopGroups\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesktopGroupsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/DesktopOSDesktopSummaries": { "get": { "tags": [ "DesktopOSDesktopSummaries" ], "summary": "Get all DesktopOSDesktopSummaries", "description": "Time-windowed VDI (single-session) desktop usage per Delivery Group.", "operationId": "DesktopOSDesktopSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: Granularity, SummaryDate, DesktopGroupId", "schema": { "type": "string" }, "example": "Granularity eq 1440 and SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all DesktopOSDesktopSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesktopOSDesktopSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/EndpointMetrics": { "get": { "tags": [ "EndpointMetrics" ], "summary": "Get all EndpointMetrics", "description": "Client endpoint performance metrics collected during a session (WiFi, throughput, CPU, memory, GPU, beacon latency).", "operationId": "EndpointMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all EndpointMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/FailureLogSummaries": { "get": { "tags": [ "FailureLogSummaries" ], "summary": "Get all FailureLogSummaries", "description": "POCO object for failures (connection/machine) rollup/summary per minute/hour/day", "operationId": "FailureLogSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields:SummaryDate, Granularity, FailureCategory, DesktopGroupId.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all FailureLogSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureLogSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Hotfixes": { "get": { "tags": [ "Hotfixes" ], "summary": "Get all Hotfixes", "description": "Hotfix class", "operationId": "Hotfixes", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "CreatedDate gt 2024-12-01T00:00:00Z and CreatedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Hotfixes\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HotfixesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Hypervisors": { "get": { "tags": [ "Hypervisors" ], "summary": "Get all Hypervisors", "description": "Assignment for - get-BrokerHypervisorConnection cmdlet", "operationId": "Hypervisors", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "CreatedDate gt 2024-12-01T00:00:00Z and CreatedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Hypervisors\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/LhcReport": { "get": { "tags": [ "LhcReport" ], "summary": "Get all LhcReport", "description": "Local Host Cache (LHC) activity report - one row per window when LHC was active (primary broker unavailable).", "operationId": "LhcReport", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields:StartDate, EndDate, ZoneName, ControllerName.", "schema": { "type": "string" }, "example": "StartDate gt 2024-12-01T00:00:00Z and StartDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all LhcReport\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LhcReportGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/LoadIndexSummaries": { "get": { "tags": [ "LoadIndexSummaries" ], "summary": "Get all LoadIndexSummaries", "description": "POCO object for load index rollup/summary per hour/day", "operationId": "LoadIndexSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: MachineId, Granularity, SummaryDate.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all LoadIndexSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadIndexSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/LoadIndexes": { "get": { "tags": [ "LoadIndexes" ], "summary": "Get all LoadIndexes", "description": "Load Index collected data", "operationId": "LoadIndexes", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: MachineId, CreatedDate.", "schema": { "type": "string" }, "example": "CreatedDate gt 2024-12-01T00:00:00Z and CreatedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all LoadIndexes\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadIndexesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/LogOnMetrics": { "get": { "tags": [ "LogOnMetrics" ], "summary": "Get all LogOnMetrics", "description": "Logon Metric", "operationId": "LogOnMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SessionKey.", "schema": { "type": "string" }, "example": "SessionKey eq 61827d05-88f3-4793-a808-1f797406f162" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all LogOnMetrics\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogOnMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/LogOnSummaries": { "get": { "tags": [ "LogOnSummaries" ], "summary": "Get all LogOnSummaries", "description": "POCO object for logon breakdown rollup/summary per hour/day The total duration and each breakdown has an associated count This count is used to get the average correctly in case of rollups", "operationId": "LogOnSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.\n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: Granularity, SummaryDate, DesktopGroupId.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all LogOnSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogOnSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineCostSavingsSummaries": { "get": { "tags": [ "MachineCostSavingsSummaries" ], "summary": "Represents a summary of cost savings for a machine over a specified period.", "description": "Aggregated cost-savings per delivery group from power management (AutoScale + end-user actions).", "operationId": "MachineCostSavingsSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: DesktopGroupId.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineCostSavingsSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCostSavingsSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineCosts": { "get": { "tags": [ "MachineCosts" ], "summary": "Get all MachineCosts", "description": "Model entity of the cost of a VM", "operationId": "MachineCosts", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SpecId.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineCosts\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCostsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineFailureLogs": { "get": { "tags": [ "MachineFailureLogs" ], "summary": "Get all MachineFailureLogs", "description": "Represents the accumulation of machine failures", "operationId": "MachineFailureLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: MachineId, FailureStartDate, FailureEndDate, FaultState, CreatedDate.", "schema": { "type": "string" }, "example": "CreatedDate gt 2024-12-01T00:00:00Z and CreatedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineFailureLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineFailureLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineHotfixLogs": { "get": { "tags": [ "MachineHotfixLogs" ], "summary": "Get all MachineHotfixLogs", "description": "HotfixHistory class relates the machine and hotfixes installed/ removed", "operationId": "MachineHotfixLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: MachineId, CurrentState, HotfixId.", "schema": { "type": "string" }, "example": "CurrentState eq true and CreatedDate gt 2024-12-01T00:00:00Z and CreatedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineHotfixLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineHotfixLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineMetric": { "get": { "tags": [ "MachineMetric" ], "summary": "Get all MachineMetric", "description": "Machine-level resource metrics such as IOPS and latency for a particular machine, with its related machine.", "operationId": "MachineMetric", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: CollectedDate.", "schema": { "type": "string" }, "example": "CollectedDate gt 2024-12-01T00:00:00Z and CollectedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineMetric\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineMetricGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineMetricSummary": { "get": { "tags": [ "MachineMetricSummary" ], "summary": "Get all MachineMetricSummary", "description": "Summary table for MachineMetric", "operationId": "MachineMetricSummary", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineMetricSummary\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineMetricSummaryGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineSummaries": { "get": { "tags": [ "MachineSummaries" ], "summary": "Get all MachineSummaries", "description": "POCO object for machine rollup/summary per hour/day", "operationId": "MachineSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: Granularity, SummaryDate, DesktopGroupId.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Machines": { "get": { "tags": [ "Machines" ], "summary": "Get all Machines", "description": "Represents a Machine in the site", "operationId": "Machines", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: CatalogId, HypervisorId, DesktopGroupId, MachineRole, Hash, Name, ModifiedDate, CurrentLoadIndexId.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Machines\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachinesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationActionEmails": { "get": { "tags": [ "NotificationActionEmails" ], "summary": "Get all NotificationActionEmails", "description": "Email action configuration linking a notification rule action to its recipient addresses and SMTP server settings.", "operationId": "NotificationActionEmails", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationActionEmails\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationActionEmailsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationEmailAddresses": { "get": { "tags": [ "NotificationEmailAddresses" ], "summary": "Get all NotificationEmailAddresses", "description": "A single notification email recipient address belonging to an email action.", "operationId": "NotificationEmailAddresses", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationEmailAddresses\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationEmailAddressesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationEmailServerConfigurations": { "get": { "tags": [ "NotificationEmailServerConfigurations" ], "summary": "Get all NotificationEmailServerConfigurations", "description": "SMTP server configuration for sending notification emails.", "operationId": "NotificationEmailServerConfigurations", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationEmailServerConfigurations\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationEmailServerConfigurationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRuleActions": { "get": { "tags": [ "NotificationRuleActions" ], "summary": "Get all NotificationRuleActions", "description": "An action to execute when a rule fires (currently Email).", "operationId": "NotificationRuleActions", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRuleActions\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRuleActionsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRuleGroups": { "get": { "tags": [ "NotificationRuleGroups" ], "summary": "Get all NotificationRuleGroups", "description": "Logical grouping of notification rules (an alert policy) with shared webhook/SNMP/email settings.", "operationId": "NotificationRuleGroups", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRuleGroups\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRuleGroupsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRuleParameterChangeLogs": { "get": { "tags": [ "NotificationRuleParameterChangeLogs" ], "summary": "Get all NotificationRuleParameterChangeLogs", "description": "Audit-trail entry for rule parameter modifications (timestamp + snapshot of parameter values at change time).", "operationId": "NotificationRuleParameterChangeLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRuleParameterChangeLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRuleParameterChangeLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRuleParameters": { "get": { "tags": [ "NotificationRuleParameters" ], "summary": "Get all NotificationRuleParameters", "description": "A single configurable value for a rule (threshold, interval, percentage), typed by parameter type.", "operationId": "NotificationRuleParameters", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRuleParameters\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRuleParametersGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRuleTargetValues": { "get": { "tags": [ "NotificationRuleTargetValues" ], "summary": "Get all NotificationRuleTargetValues", "description": "A single target object ID within a NotificationRuleTarget.", "operationId": "NotificationRuleTargetValues", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRuleTargetValues\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRuleTargetValuesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRuleTargets": { "get": { "tags": [ "NotificationRuleTargets" ], "summary": "Get all NotificationRuleTargets", "description": "A category of infrastructure objects a rule monitors; child target-values hold the object IDs.", "operationId": "NotificationRuleTargets", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRuleTargets\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRuleTargetsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationRules": { "get": { "tags": [ "NotificationRules" ], "summary": "Get all NotificationRules", "description": "An alert policy definition (condition template, data source, scope, parameters, targets, and actions).", "operationId": "NotificationRules", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationRules\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRulesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationSnmpConfigurations": { "get": { "tags": [ "NotificationSnmpConfigurations" ], "summary": "Get all NotificationSnmpConfigurations", "description": "SNMP trap destination configuration (v2c community string, v3 auth/privacy passwords).", "operationId": "NotificationSnmpConfigurations", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationSnmpConfigurations\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSnmpConfigurationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationTargets": { "get": { "tags": [ "NotificationTargets" ], "summary": "Get all NotificationTargets", "description": "The specific infrastructure object that triggered a Notification.", "operationId": "NotificationTargets", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationTargets\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTargetsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Notifications": { "get": { "tags": [ "Notifications" ], "summary": "Get all Notifications", "description": "A fired alert instance, created when a rule condition evaluates true for a target; tracks lifecycle through trigger and completion.", "operationId": "Notifications", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Notifications\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationsLogs": { "get": { "tags": [ "NotificationsLogs" ], "summary": "Get all NotificationsLogs", "description": "Historical log entry for a notification state change (Began -> Pending -> Triggered -> Completed).", "operationId": "NotificationsLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationsLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeDesktop": { "get": { "tags": [ "ProbeDesktop" ], "summary": "Get all ProbeDesktop", "description": "Probe Desktop", "operationId": "ProbeDesktop", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: DesktopGroupId.", "schema": { "type": "string" }, "example": "DesktopGroupId eq dd1c6df8-be81-4d11-8d39-291233f32fb9" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeDesktop\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeDesktopGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeEndpoints": { "get": { "tags": [ "ProbeEndpoints" ], "summary": "Get all ProbeEndpoints", "description": "ProbeEndPoint", "operationId": "ProbeEndpoints", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeEndpoints\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeEndpointsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeLogDesktop": { "get": { "tags": [ "ProbeLogDesktop" ], "summary": "Get all ProbeLogDesktop", "description": "Probe Log Desktop", "operationId": "ProbeLogDesktop", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SessionKey, DesktopId, EndPointId, RuleId, ProbeLogDesktop, ProbeStartTime, ProbeLogResult.", "schema": { "type": "string" }, "example": "ProbeStartTime gt 2024-12-01T00:00:00Z and ProbeStartTime lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeLogDesktop\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeLogDesktopGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeLogs": { "get": { "tags": [ "ProbeLogs" ], "summary": "Get all ProbeLogs", "description": "A single application probe execution log; one row per application launch attempt run from a probe endpoint during an application probe.", "operationId": "ProbeLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: EndPointId, RuleId, ApplicationId, SessionKey, ProbeStartTime, ProbeLogResult.", "schema": { "type": "string" }, "example": "ProbeStartTime gt 2024-12-01T00:00:00Z and ProbeStartTime lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeResultDesktop": { "get": { "tags": [ "ProbeResultDesktop" ], "summary": "Get all ProbeResultDesktop", "description": "Probe Result", "operationId": "ProbeResultDesktop", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: ProbeLogId, StageId, StageResult.", "schema": { "type": "string" }, "example": "ProbeLogId eq 1234" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeResultDesktop\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeResultDesktopGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeResults": { "get": { "tags": [ "ProbeResults" ], "summary": "Get all ProbeResults", "description": "Probe Result", "operationId": "ProbeResults", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: ProbeLogId, StageId, ProbeResult.", "schema": { "type": "string" }, "example": "ProbeLogId eq 1234" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeResults\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeResultsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeRuleApplications": { "get": { "tags": [ "ProbeRuleApplications" ], "summary": "Get all ProbeRuleApplications", "description": "Probe Rule Application", "operationId": "ProbeRuleApplications", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: RuleId, ApplicationId.", "schema": { "type": "string" }, "example": "ApplicationId eq dd1c6df8-be81-4d11-8d39-291233f32fb9" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeRuleApplications\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeRuleApplicationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeRuleDesktop": { "get": { "tags": [ "ProbeRuleDesktop" ], "summary": "Get all ProbeRuleDesktop", "description": "Probe Rule Desktop", "operationId": "ProbeRuleDesktop", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: DesktopId, RuleId.", "schema": { "type": "string" }, "example": "RuleId eq 1234" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeRuleDesktop\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeRuleDesktopGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeRuleEndpoints": { "get": { "tags": [ "ProbeRuleEndpoints" ], "summary": "Get all ProbeRuleEndpoints", "description": "Probe Rule Target", "operationId": "ProbeRuleEndpoints", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: EndPointId, RuleId.", "schema": { "type": "string" }, "example": "RuleId eq 1234" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeRuleEndpoints\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeRuleEndpointsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeRules": { "get": { "tags": [ "ProbeRules" ], "summary": "Get all ProbeRules", "description": "A configured probe rule that schedules automated application or desktop launch tests, defining the execution schedule, targets, and notification settings.", "operationId": "ProbeRules", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeRules\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeRulesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProbeStages": { "get": { "tags": [ "ProbeStages" ], "summary": "Get all ProbeStages", "description": "A named stage/step within a probe run's lifecycle (for example, StorefrontReachable, IcaFileDownload, ApplicationLaunch).", "operationId": "ProbeStages", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProbeStages\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeStagesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ProcessDataLimitedMachines": { "get": { "tags": [ "ProcessDataLimitedMachines" ], "summary": "Get all ProcessDataLimitedMachines", "description": "A machine that is configured to collect and send per-process resource utilization data.", "operationId": "ProcessDataLimitedMachines", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: MachineId, LastModifiedDate.", "schema": { "type": "string" }, "example": "LastModifiedDate gt 2024-12-01T00:00:00Z and LastModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ProcessDataLimitedMachines\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessDataLimitedMachinesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/PublishedDesktopNames": { "get": { "tags": [ "PublishedDesktopNames" ], "summary": "Get all PublishedDesktopNames", "description": "Lookup table mapping published desktop IDs to their display names.", "operationId": "PublishedDesktopNames", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all PublishedDesktopNames\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishedDesktopNamesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ResourceUtilization": { "get": { "tags": [ "ResourceUtilization" ], "summary": "Get all ResourceUtilization", "description": "New added ResourceUtilization View to union ResourceUtilization table and ResourceUtilizationViewV2 table.", "operationId": "ResourceUtilization", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: CollectedDate, DesktopGroupId. ", "schema": { "type": "string" }, "example": "CollectedDate gt 2024-12-01T00:00:00Z and CollectedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ResourceUtilization\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUtilizationGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ResourceUtilizationSummary": { "get": { "tags": [ "ResourceUtilizationSummary" ], "summary": "Get all ResourceUtilizationSummary", "description": "Summary table for ResourceUtilization", "operationId": "ResourceUtilizationSummary", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: DesktopGroupId, Granularity, SummaryDate.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ResourceUtilizationSummary\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUtilizationSummaryGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ServerOSDesktopSummaries": { "get": { "tags": [ "ServerOSDesktopSummaries" ], "summary": "Get all ServerOSDesktopSummaries", "description": "Time-windowed multi-session (Server OS) desktop usage per Delivery Group and machine.", "operationId": "ServerOSDesktopSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: DesktopGroupId, MachineId, Granularity, SummaryDate.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ServerOSDesktopSummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerOSDesktopSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionActivitySummaries": { "get": { "tags": [ "SessionActivitySummaries" ], "summary": "Get all SessionActivitySummaries", "description": "POCO object for session activity consolidation", "operationId": "SessionActivitySummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: DesktopGroupId, MachineId, Granularity, SummaryDate.", "schema": { "type": "string" }, "example": "SummaryDate gt 2024-12-01T00:00:00Z and SummaryDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionActivitySummaries\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionActivitySummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionAutoReconnects": { "get": { "tags": [ "SessionAutoReconnects" ], "summary": "Get all SessionAutoReconnects", "description": "Session Auto Reconnect class", "operationId": "SessionAutoReconnects", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SessionKey, ConnectionId, EventTimestamp.", "schema": { "type": "string" }, "example": "EventTimestamp gt 2024-12-01T00:00:00Z and EventTimestamp lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionAutoReconnects\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionAutoReconnectsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionMetrics": { "get": { "tags": [ "SessionMetrics" ], "summary": "Get all SessionMetrics", "description": "New added SessionMetrics View to union SessionMetrics table and SessionMetricsV2 table.", "operationId": "SessionMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: SessionId, CollectedDate.", "schema": { "type": "string" }, "example": "CollectedDate gt 2024-12-01T00:00:00Z and CollectedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionMetrics\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionMetricsLatest": { "get": { "tags": [ "SessionMetricsLatest" ], "summary": "Get all SessionMetricsLatest", "description": "The most recent (current) HDX/ICA connection-quality metrics for each active session - one row per session, keyed by SessionKey and updated in place as new measurements arrive, so it always reflects the latest values. Use this entity for real-time (live) dashboards that show what sessions are experiencing right now, such as latency, round-trip time, and throughput. For the historical time-series of these metrics over a session's lifetime, query the SessionMetrics entity instead.", "operationId": "SessionMetricsLatest", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionMetricsLatest", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMetricsLatestGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionRecordingServers": { "get": { "tags": [ "SessionRecordingServers" ], "summary": "Get all SessionRecordingServers", "description": "Maps recorded sessions to the Session Recording Server that captured them.", "operationId": "SessionRecordingServers", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionRecordingServers\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRecordingServersGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionLogonMetrics": { "get": { "tags": [ "SessionLogonMetrics" ], "summary": "Get all SessionLogonMetrics", "description": "Profile and logon-phase metadata captured once per session. Contains FSLogix/CPM profile details and GPO records.", "operationId": "SessionLogonMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionLogonMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionLogonMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Sessions": { "get": { "tags": [ "Sessions" ], "summary": "Get all Sessions", "description": "Represents a user connected to a desktop.", "operationId": "Sessions", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: CurrentConnectionId, FailureId, UserId, PublishedDesktopId, MachineId, LifecycleState, SessionType, EndDate, StartDate, ConnectionState. ", "schema": { "type": "string" }, "example": "StartDate gt 2024-12-01T00:00:00Z and StartDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Sessions\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaApplications": { "get": { "tags": [ "SpaApplications" ], "summary": "Get all SpaApplications", "description": "Represents a single application-access event within a Secure Private Access (SPA) session: a user reaching a web/SaaS app or a TCP/UDP resource. Captures the accessed URL, applied access policy and security controls, routing, destination, and gateway/connector context, and links to its parent SPA enumeration and session.", "operationId": "SpaApplications", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: ApplicationId, EnumerationId, SessionId, TransactionId, LaunchTime.", "schema": { "type": "string" }, "example": "LaunchTime gt 2024-12-01T00:00:00Z and LaunchTime lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaApplications", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaApplicationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaEnumerations": { "get": { "tags": [ "SpaEnumerations" ], "summary": "Get all SpaEnumerations", "description": "Represents a single Secure Private Access (SPA) resource-enumeration event, recorded when the SPA plugin lists the applications a user is entitled to before launch. Captures the user identity, client device, gateway context, status, timings, correlation key, and deployment type.", "operationId": "SpaEnumerations", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: UserSid, UserOid, DeviceName, StartTime, LastActiveTime, CorrelationKey.", "schema": { "type": "string" }, "example": "StartTime gt 2024-12-01T00:00:00Z and StartTime lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaEnumerations", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaEnumerationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaSessions": { "get": { "tags": [ "SpaSessions" ], "summary": "Get all SpaSessions", "description": "Represents a single Citrix Secure Private Access (SPA) end-user session as recorded by the Monitor service. A session covers a user accessing internal, SaaS, and TCP/UDP resources through the SPA plugin, StoreFront, and a gateway or connector, and captures user and device identity, gateway and StoreFront routing, client details, session timings, single sign-on and auto-logon outcomes, and any linked ICA session. Backs the SpaSessions OData entity set.", "operationId": "SpaSessions", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: UserSid, UserOid, DeviceId, DeviceName, StartTime, EndTime, LastActiveTime, SpaSession, CorrelationKey.", "schema": { "type": "string" }, "example": "StartTime gt 2024-12-01T00:00:00Z and StartTime lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaSessions", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaSessionsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/TaskLogs": { "get": { "tags": [ "TaskLogs" ], "summary": "Get all TaskLogs", "description": "Represents the task execution log", "operationId": "TaskLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: RunDate, Task, Result, TaskCategory.", "schema": { "type": "string" }, "example": "RunDate gt 2024-12-01T00:00:00Z and RunDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all TaskLogs\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Users": { "get": { "tags": [ "Users" ], "summary": "Get all Users", "description": "Represents a user in the system. A user identity that has launched sessions in the site.", "operationId": "Users", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax. \n Please use the indexed fields for the filter to improve the performance. \n Indexed fields: Sid.", "schema": { "type": "string" }, "example": "ModifiedDate gt 2024-12-01T00:00:00Z and ModifiedDate lt 2024-12-02T00:00:00Z" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Users\n .The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ActiveApplicationLaunches": { "get": { "tags": [ "ActiveApplicationLaunches" ], "summary": "Get all ActiveApplicationLaunches", "description": "Currently running application instance (one row per active launch; IsAppEnded flips true on process exit).", "operationId": "ActiveApplicationLaunches", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ActiveApplicationLaunches", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveApplicationLaunchesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationIdDesktopGroupIdMappings": { "get": { "tags": [ "ApplicationIdDesktopGroupIdMappings" ], "summary": "Get all ApplicationIdDesktopGroupIdMappings", "description": "Represents ApplicationId and DesktopGroupId Mapping data for local applications", "operationId": "ApplicationIdDesktopGroupIdMappings", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationIdDesktopGroupIdMappings", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationIdDesktopGroupIdMappingsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationNameIds": { "get": { "tags": [ "ApplicationNameIds" ], "summary": "Get all ApplicationNameIds", "description": "Lightweight lookup mapping an application identifier string to its display name (local/uberAgent-discovered apps).", "operationId": "ApplicationNameIds", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationNameIds", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationNameIdsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationsUsageSummaryData": { "get": { "tags": [ "ApplicationsUsageSummaryData" ], "summary": "Get all ApplicationsUsageSummaryData", "description": "Represents the summary of application usage metrics", "operationId": "ApplicationsUsageSummaryData", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationsUsageSummaryData", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationsUsageSummaryDataGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/BlockedUsers": { "get": { "tags": [ "BlockedUsers" ], "summary": "Get all BlockedUsers", "description": "A user blocked from launching sessions or published resources, for example after repeated connection failures or via the block-user action.", "operationId": "BlockedUsers", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all BlockedUsers", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockedUsersGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ComponentResourceUtilizations": { "get": { "tags": [ "ComponentResourceUtilizations" ], "summary": "Get all ComponentResourceUtilizations", "description": "Resource Utilization for a given component at a given time", "operationId": "ComponentResourceUtilizations", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ComponentResourceUtilizations", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentResourceUtilizationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/DirectorAgent": { "get": { "tags": [ "DirectorAgent" ], "summary": "Get all DirectorAgent", "description": "DirectorAgent class", "operationId": "DirectorAgent", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all DirectorAgent", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectorAgentGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/GatewayPopInfo": { "get": { "tags": [ "GatewayPopInfo" ], "summary": "Get all GatewayPopInfo", "description": "Represents a mappings between Pop ID and Pop location.", "operationId": "GatewayPopInfo", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all GatewayPopInfo", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayPopInfoGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/HistoricalApplicationLaunches": { "get": { "tags": [ "HistoricalApplicationLaunches" ], "summary": "Get all HistoricalApplicationLaunches", "description": "Completed (historical) application launch record, created when an active launch ends; includes startup performance metrics.", "operationId": "HistoricalApplicationLaunches", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all HistoricalApplicationLaunches", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricalApplicationLaunchesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/LocationCoordinates": { "get": { "tags": [ "LocationCoordinates" ], "summary": "Get all LocationCoordinates", "description": "Represents geographic location data with city, country, and coordinates.", "operationId": "LocationCoordinates", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all LocationCoordinates", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationCoordinatesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineCostAllocationSummaries": { "get": { "tags": [ "MachineCostAllocationSummaries" ], "summary": "Get all MachineCostAllocationSummaries", "description": "Represents cost and savings incurred while running a machine", "operationId": "MachineCostAllocationSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineCostAllocationSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCostAllocationSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineDiagnosticAlerts": { "get": { "tags": [ "MachineDiagnosticAlerts" ], "summary": "Get all MachineDiagnosticAlerts", "description": "Machine Diagnostic Insights Alerts Entity Class", "operationId": "MachineDiagnosticAlerts", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineDiagnosticAlerts", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDiagnosticAlertsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineDiagnosticInsights": { "get": { "tags": [ "MachineDiagnosticInsights" ], "summary": "Get all MachineDiagnosticInsights", "description": "Machine Diagnostic Insights Entity Class", "operationId": "MachineDiagnosticInsights", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineDiagnosticInsights", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDiagnosticInsightsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachinePowerActionLogs": { "get": { "tags": [ "MachinePowerActionLogs" ], "summary": "Get all MachinePowerActionLogs", "description": "Log of power actions initiated on a machine (initiator, action type, reason, completion state).", "operationId": "MachinePowerActionLogs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachinePowerActionLogs", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachinePowerActionLogsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineSpecs": { "get": { "tags": [ "MachineSpecs" ], "summary": "Get all MachineSpecs", "description": "Represents the specs of machines", "operationId": "MachineSpecs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineSpecs", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineSpecsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MonthlyCostSummaries": { "get": { "tags": [ "MonthlyCostSummaries" ], "summary": "Get all MonthlyCostSummaries", "description": "Represents historical data of total cost, savings and unique users for a month", "operationId": "MonthlyCostSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MonthlyCostSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyCostSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/NotificationWebhookProfiles": { "get": { "tags": [ "NotificationWebhookProfiles" ], "summary": "Get all NotificationWebhookProfiles", "description": "Reusable webhook delivery configuration (static or custom key-value payloads).", "operationId": "NotificationWebhookProfiles", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all NotificationWebhookProfiles", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationWebhookProfilesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionAccessDenied": { "get": { "tags": [ "SessionAccessDenied" ], "summary": "Get all SessionAccessDenied", "description": "deviceTRUST-initiated access-denial events where a session was blocked due to endpoint policy violation.", "operationId": "SessionAccessDenied", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionAccessDenied", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionAccessDeniedGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/UserMachineLogSummaries": { "get": { "tags": [ "UserMachineLogSummaries" ], "summary": "Get all UserMachineLogSummaries", "description": "Represents logs for session launched by a user on a machine", "operationId": "UserMachineLogSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all UserMachineLogSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMachineLogSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/UserResourceUtilizationSummary": { "get": { "tags": [ "UserResourceUtilizationSummary" ], "summary": "Get all UserResourceUtilizationSummary", "description": "Summary table for UserResourceUtilization", "operationId": "UserResourceUtilizationSummary", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all UserResourceUtilizationSummary", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResourceUtilizationSummaryGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ActionSummaries": { "get": { "tags": [ "ActionSummaries" ], "summary": "Get all ActionSummaries", "description": "Outcome of a remediation action executed in response to an alert (per-target success/failure/skip counts).", "operationId": "ActionSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ActionSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ApplicationPerformanceMetrics": { "get": { "tags": [ "ApplicationPerformanceMetrics" ], "summary": "Get all ApplicationPerformanceMetrics", "description": "Per-application performance metrics from uberAgent on VDAs (CPU, memory, disk, input delay, network latency, page faults).", "operationId": "ApplicationPerformanceMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ApplicationPerformanceMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationPerformanceMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/CcMetrics": { "get": { "tags": [ "CcMetrics" ], "summary": "Get all CcMetrics", "description": "Cloud Connector health metrics (Windows service statuses and connectivity failure details).", "operationId": "CcMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all CcMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CcMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ConnectorApplianceChildServices": { "get": { "tags": [ "ConnectorApplianceChildServices" ], "summary": "Get all ConnectorApplianceChildServices", "description": "Health snapshot of an individual service running on a Connector Appliance, linked to a parent ConnectorApplianceMetrics record.", "operationId": "ConnectorApplianceChildServices", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ConnectorApplianceChildServices", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorApplianceChildServicesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ConnectorApplianceMetrics": { "get": { "tags": [ "ConnectorApplianceMetrics" ], "summary": "Get all ConnectorApplianceMetrics", "description": "Health and inventory snapshot of a Citrix Cloud Connector Appliance, captured at a point in time. Covers status, software version, network addressing, Active Directory and domain-join state, and disk capacity.", "operationId": "ConnectorApplianceMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ConnectorApplianceMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorApplianceMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ConnectorApplianceProxyDetails": { "get": { "tags": [ "ConnectorApplianceProxyDetails" ], "summary": "Get all ConnectorApplianceProxyDetails", "description": "Proxy configuration entry for a Connector Appliance, linked to a parent ConnectorApplianceMetrics record.", "operationId": "ConnectorApplianceProxyDetails", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ConnectorApplianceProxyDetails", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorApplianceProxyDetailsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/DdcMetrics": { "get": { "tags": [ "DdcMetrics" ], "summary": "Get all DdcMetrics", "description": "Delivery Controller (DDC) health metrics (broker service, license state, DB connectivity, certificate validity).", "operationId": "DdcMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all DdcMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DdcMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/DirectorAgentRegistrationStateHistory": { "get": { "tags": [ "DirectorAgentRegistrationStateHistory" ], "summary": "Get all DirectorAgentRegistrationStateHistory", "description": "History of registration state changes for a Director agent.", "operationId": "DirectorAgentRegistrationStateHistory", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all DirectorAgentRegistrationStateHistory", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectorAgentRegistrationStateHistoryGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/DirectorUIThresholdConfiguration": { "get": { "tags": [ "DirectorUIThresholdConfiguration" ], "summary": "Get all DirectorUIThresholdConfiguration", "description": "A configurable warning and critical threshold for a metric shown in the Citrix Director UI. Thresholds drive color-coding and alerting when a metric's value crosses the configured levels.", "operationId": "DirectorUIThresholdConfiguration", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all DirectorUIThresholdConfiguration", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectorUIThresholdConfigurationGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/EndpointSecurityEvents": { "get": { "tags": [ "EndpointSecurityEvents" ], "summary": "Get all EndpointSecurityEvents", "description": "Security events reported from client endpoints via Citrix Workspace App or deviceTRUST.", "operationId": "EndpointSecurityEvents", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all EndpointSecurityEvents", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointSecurityEventsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineInventoryMetrics": { "get": { "tags": [ "MachineInventoryMetrics" ], "summary": "Get all MachineInventoryMetrics", "description": "Current-state hardware and OS inventory for a VDA machine (one row per machine).", "operationId": "MachineInventoryMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineInventoryMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineInventoryMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachinePowerActionStatuses": { "get": { "tags": [ "MachinePowerActionStatuses" ], "summary": "Get all MachinePowerActionStatuses", "description": "Represents Machine Power Action Status events triggered by external systems like AlertEngine, Citrix Aidrien, etc.", "operationId": "MachinePowerActionStatuses", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachinePowerActionStatuses", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachinePowerActionStatusesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/MachineTags": { "get": { "tags": [ "MachineTags" ], "summary": "Get all MachineTags", "description": "A tag association linking a machine to a tag (composite key of MachineId and TagId).", "operationId": "MachineTags", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all MachineTags", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineTagsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Pvs": { "get": { "tags": [ "Pvs" ], "summary": "Get all Pvs", "description": "A Provisioning Services (PVS) record for a machine, capturing the PVS server identity and configuration that links a Director agent to a PVS farm and site.", "operationId": "Pvs", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Pvs", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PvsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/PvsMetrics": { "get": { "tags": [ "PvsMetrics" ], "summary": "Get all PvsMetrics", "description": "Provisioning Services (PVS) metrics reported for a machine.", "operationId": "PvsMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all PvsMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PvsMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ReconnectSummaries": { "get": { "tags": [ "ReconnectSummaries" ], "summary": "Get all ReconnectSummaries", "description": "Hourly and daily rollup of session reconnect durations, broken down by phase, with a per-phase count used to compute correct averages across rollups.", "operationId": "ReconnectSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ReconnectSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconnectSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ResourceUtilizationSummaryLatestMapping": { "get": { "tags": [ "ResourceUtilizationSummaryLatestMapping" ], "summary": "Get all ResourceUtilizationSummaryLatestMapping", "description": "Mapping of the latest resource-utilization summary per granularity to each machine.", "operationId": "ResourceUtilizationSummaryLatestMapping", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ResourceUtilizationSummaryLatestMapping", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUtilizationSummaryLatestMappingGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/ServiceContinuityMetrics": { "get": { "tags": [ "ServiceContinuityMetrics" ], "summary": "Get all ServiceContinuityMetrics", "description": "Detailed per-device metrics for the Service Continuity feature, including device readiness, app and desktop availability, client-side lease sync status, and related data.", "operationId": "ServiceContinuityMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all ServiceContinuityMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceContinuityMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionPerformanceSummaries": { "get": { "tags": [ "SessionPerformanceSummaries" ], "summary": "Get all SessionPerformanceSummaries", "description": "Consolidated per-session performance summary.", "operationId": "SessionPerformanceSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionPerformanceSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPerformanceSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SessionScoreMetrics": { "get": { "tags": [ "SessionScoreMetrics" ], "summary": "Get all SessionScoreMetrics", "description": "Aggregated session performance (score) metrics collected from uberAgent for a session.", "operationId": "SessionScoreMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SessionScoreMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionScoreMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SfMetrics": { "get": { "tags": [ "SfMetrics" ], "summary": "Get all SfMetrics", "description": "StoreFront (SF) health metrics.", "operationId": "SfMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SfMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SfMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaConnectorApplianceAppServerMetrics": { "get": { "tags": [ "SpaConnectorApplianceAppServerMetrics" ], "summary": "Get all SpaConnectorApplianceAppServerMetrics", "description": "Reachability metrics from a Citrix Secure Private Access (SPA) Connector Appliance to a backend application server, including round-trip time and the resolved backend host.", "operationId": "SpaConnectorApplianceAppServerMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaConnectorApplianceAppServerMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaConnectorApplianceAppServerMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaConnectorApplianceMetrics": { "get": { "tags": [ "SpaConnectorApplianceMetrics" ], "summary": "Get all SpaConnectorApplianceMetrics", "description": "Per-Connector-Appliance network latency metrics for Citrix Secure Private Access (SPA), measuring round-trip time from a connector appliance to its gateway point of presence (PoP).", "operationId": "SpaConnectorApplianceMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaConnectorApplianceMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaConnectorApplianceMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaEnumerationApplications": { "get": { "tags": [ "SpaEnumerationApplications" ], "summary": "Get all SpaEnumerationApplications", "description": "An application that appears in a Policy.Evaluation.Enumeration event. ApplicationId is the business identifier string (GUID).", "operationId": "SpaEnumerationApplications", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaEnumerationApplications", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaEnumerationApplicationsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaGoogleLoginActivities": { "get": { "tags": [ "SpaGoogleLoginActivities" ], "summary": "Get all SpaGoogleLoginActivities", "description": "Represents a Google Chrome Enterprise (CEP) pre-launch login event stored in the SpaGoogleLoginActivity table.", "operationId": "SpaGoogleLoginActivities", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaGoogleLoginActivities", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaGoogleLoginActivitiesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SpaLatencyMetrics": { "get": { "tags": [ "SpaLatencyMetrics" ], "summary": "Get all SpaLatencyMetrics", "description": "Client-device-side network latency and link telemetry for Citrix Secure Private Access (SPA). Captures CDN ping latency, gateway latency, and connection characteristics such as ISP, interface type, signal strength, and link speed.", "operationId": "SpaLatencyMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SpaLatencyMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaLatencyMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyAnswerFreetexts": { "get": { "tags": [ "SurveyAnswerFreetexts" ], "summary": "Get all SurveyAnswerFreetexts", "description": "One free-text answer row (FreeText question type only), stored separately from SurveyAnswer. AnswerText is capped at 128 characters.", "operationId": "SurveyAnswerFreetexts", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyAnswerFreetexts", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyAnswerFreetextsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyAnswers": { "get": { "tags": [ "SurveyAnswers" ], "summary": "Get all SurveyAnswers", "description": "One Rating or Choice answer row. Free-text answers are stored separately in SurveyAnswerFreetext.", "operationId": "SurveyAnswers", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyAnswers", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyAnswersGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyDGScopes": { "get": { "tags": [ "SurveyDGScopes" ], "summary": "Get all SurveyDGScopes", "description": "One Delivery-Group GUID value belonging to a SurveyScope whose ScopeType is DG.", "operationId": "SurveyDGScopes", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyDGScopes", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDGScopesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyOptionQuestionValues": { "get": { "tags": [ "SurveyOptionQuestionValues" ], "summary": "Get all SurveyOptionQuestionValues", "description": "One selectable option for a SingleChoice / MultipleChoice SurveyQuestion.", "operationId": "SurveyOptionQuestionValues", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyOptionQuestionValues", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyOptionQuestionValuesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyQuestions": { "get": { "tags": [ "SurveyQuestions" ], "summary": "Get all SurveyQuestions", "description": "A single question belonging to a Survey.", "operationId": "SurveyQuestions", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyQuestions", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyQuestionsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyResponses": { "get": { "tags": [ "SurveyResponses" ], "summary": "Get all SurveyResponses", "description": "One presentation of a Survey to a user; tracks lifecycle (Shown, Submitted, Dismissed, Snoozed) and references back to the answers (SurveyAnswer, SurveyAnswerFreetext).", "operationId": "SurveyResponses", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyResponses", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResponsesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Surveys": { "get": { "tags": [ "Surveys" ], "summary": "Get all Surveys", "description": "Employee Experience Survey definition and configuration. Lifecycle (Scheduled / Active / Expired / Disabled / Deleted) is derived from IsDeleted, IsEnabled, StartDate and EndDate; there is no Status column.", "operationId": "Surveys", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Surveys", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveysGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/SurveyScopes": { "get": { "tags": [ "SurveyScopes" ], "summary": "Get all SurveyScopes", "description": "A single targeting rule (DG or Tag) attached to a Survey. The GUID values for DG scopes are stored in SurveyDGScope.", "operationId": "SurveyScopes", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all SurveyScopes", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyScopesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/Tags": { "get": { "tags": [ "Tags" ], "summary": "Get all Tags", "description": "A tag definition that can be applied to machines, delivery groups, or applications for filtering and policy targeting.", "operationId": "Tags", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all Tags", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/UCAppsOptimizationSummaries": { "get": { "tags": [ "UCAppsOptimizationSummaries" ], "summary": "Get all UCAppsOptimizationSummaries", "description": "Unified Communications app optimization status within a session (HDX-optimized media offload vs fallback).", "operationId": "UCAppsOptimizationSummaries", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all UCAppsOptimizationSummaries", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UCAppsOptimizationSummariesGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/VdaAdvisorDataPoints": { "get": { "tags": [ "VdaAdvisorDataPoints" ], "summary": "Get all VdaAdvisorDataPoints", "description": "One data point captured during a VdaCollectionRun. DataPointKey is a free-form string, so newer VDAs can introduce new data points without a controller code change.", "operationId": "VdaAdvisorDataPoints", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all VdaAdvisorDataPoints", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VdaAdvisorDataPointsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/VdaCollectionRuns": { "get": { "tags": [ "VdaCollectionRuns" ], "summary": "Get all VdaCollectionRuns", "description": "One execution of the VDA generic collection pipeline for a single machine. Aggregates the data points collected during that run via DataPoints.", "operationId": "VdaCollectionRuns", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all VdaCollectionRuns", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VdaCollectionRunsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } }, "/VdaHealthMetrics": { "get": { "tags": [ "VdaHealthMetrics" ], "summary": "Get all VdaHealthMetrics", "description": "Health status metrics for a VDA machine, including Windows service states (one row per machine).", "operationId": "VdaHealthMetrics", "parameters": [ { "$ref": "#/components/headers/RequestHeaderCustomerId" }, { "$ref": "#/components/headers/RequestHeaderAuthorization" }, { "$ref": "#/components/headers/RequestHeaderUserAgent" }, { "$ref": "#/components/headers/RequestHeaderAccept" }, { "$ref": "#/components/headers/RequestHeaderAcceptEncoding" }, { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" }, "example": "MachineId eq '1234'" }, { "$ref": "#/components/headers/RequestHeaderOperationOrderby" }, { "$ref": "#/components/headers/RequestHeaderOperationTop" }, { "$ref": "#/components/headers/RequestHeaderOperationSkip" }, { "$ref": "#/components/headers/RequestHeaderOperationCount" }, { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, { "$ref": "#/components/headers/RequestHeaderOperationExpand" } ], "responses": { "200": { "description": "Get all VdaHealthMetrics", "headers": { "$ref": "#/components/headers/Response200Hearder" }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VdaHealthMetricsGet200ApplicationJsonResponse" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" } } } } }, "components": { "headers": { "Response200Hearder": { "Date": { "description": "Date and time of the response.", "schema": { "type": "string" }, "example": "Mon, 29 Jul 2024 05:12:50 GMT" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json; odata.metadata=minimal" }, "Content-Length": { "description": "Response Content Length.", "schema": { "type": "string" }, "example": "5620" }, "Connection": { "description": "Connection status.", "schema": { "type": "string" }, "example": "keep-alive" }, "odata-version": { "description": "OData version.", "schema": { "type": "string" }, "example": "4.0" } }, "RequestHeaderCustomerId": { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Cloud Customer ID.", "schema": { "type": "string" } }, "RequestHeaderAuthorization": { "name": "Authorization", "in": "header", "required": true, "description": "Citrix Cloud authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, "RequestHeaderUserAgent": { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, "RequestHeaderAccept": { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, "RequestHeaderAcceptEncoding": { "name": "Accept-Encoding", "in": "header", "description": "Must accept Encoding format.", "schema": { "type": "string" }, "example": "gzip, deflate, br" }, "RequestHeaderOperationFilter": { "name": "$filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "type": "string" } }, "RequestHeaderOperationOrderby": { "name": "$orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "type": "string" } }, "RequestHeaderOperationTop": { "name": "$top", "in": "query", "description": "Limit the number of results returned.", "schema": { "type": "integer", "format": "int32" }, "example": 1 }, "RequestHeaderOperationSkip": { "name": "$skip", "in": "query", "description": "Skip the number of results.", "schema": { "type": "integer", "format": "int32" } }, "RequestHeaderOperationCount": { "name": "$count", "in": "query", "description": "Include the count of results.", "schema": { "type": "boolean" }, "example": true }, "RequestHeaderOperationSelect": { "name": "$select", "in": "query", "description": "Select the fields to return.", "schema": { "type": "string" } }, "RequestHeaderOperationExpand": { "name": "$expand", "in": "query", "description": "Expand the fields to return.\n The example value and schema in the response show the result after using the expand operation. Without the expand operation, only return the current entity.", "schema": { "type": "string" } } }, "responses": { "Error400": { "description": "Caller passed an invalid input.", "headers": { "Date": { "description": "Date and time of the response.", "schema": { "type": "string" }, "example": "Mon, 29 Jul 2024 05:12:50 GMT" }, "Content-Type": { "description": "Response Content Type.", "schema": { "type": "string" }, "example": "text/plain; charset=utf-8" }, "Content-Length": { "description": "Response Content Length.", "schema": { "type": "string" }, "example": "5620" }, "Connection": { "description": "Connection status.", "schema": { "type": "string" }, "example": "keep-alive" } }, "content": { "application/json": { "schema": { "$ref": "#/components/responses/ErrorGeneral" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "Error401": { "description": "Caller did not present a valid bearer token.", "headers": { "Date": { "description": "Date and time of the response.", "schema": { "type": "string" }, "example": "Mon, 29 Jul 2024 05:12:50 GMT" }, "Content-Type": { "description": "Response Content Type.", "schema": { "type": "string" }, "example": "text/plain; charset=utf-8" }, "Content-Length": { "description": "Response Content Length.", "schema": { "type": "string" }, "example": "5620" }, "Connection": { "description": "Connection status.", "schema": { "type": "string" }, "example": "keep-alive" } }, "content": { "application/json": { "schema": { "$ref": "#/components/responses/ErrorGeneral" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "Error404": { "description": "A referenced entity was not found.", "headers": { "Date": { "description": "Date and time of the response.", "schema": { "type": "string" }, "example": "Mon, 29 Jul 2024 05:12:50 GMT" }, "Content-Type": { "description": "Response Content Type.", "schema": { "type": "string" }, "example": "text/plain; charset=utf-8" }, "Content-Length": { "description": "Response Content Length.", "schema": { "type": "string" }, "example": "5620" }, "Connection": { "description": "Connection status.", "schema": { "type": "string" }, "example": "keep-alive" } }, "content": { "application/json": { "schema": { "$ref": "#/components/responses/ErrorGeneral" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Resource not found" } } } } } }, "Error429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Date": { "description": "Date and time of the response.", "schema": { "type": "string" }, "example": "Mon, 29 Jul 2024 05:12:50 GMT" }, "Content-Type": { "description": "Response Content Type.", "schema": { "type": "string" }, "example": "text/plain; charset=utf-8" }, "Content-Length": { "description": "Response Content Length.", "schema": { "type": "string" }, "example": "5620" }, "Connection": { "description": "Connection status.", "schema": { "type": "string" }, "example": "keep-alive" } }, "content": { "application/json": { "schema": { "$ref": "#/components/responses/ErrorGeneral" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "ErrorGeneral": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } }, "schemas": { "Citrix.Monitor.Model.ActiveApplicationLaunch": { "description": "Currently running application instance (one row per active launch; IsAppEnded flips true on process exit).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "AppId": { "type": "string", "format": "string", "description": "Application Id" }, "ProcessName": { "type": "string", "format": "string", "description": "Process Name associated with the application" }, "StartDate": { "type": "string", "format": "date-time", "description": "Start Time of the application" }, "AppVersion": { "type": "string", "format": "string", "description": "Application Version" }, "ExecutablePath": { "type": "string", "format": "string", "description": "Application executable path" }, "UserName": { "type": "string", "format": "string", "description": "User who launched the application." }, "MachineId": { "type": "string", "format": "uuid", "description": "Foreign key to the Machine on which the application was launched." }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "DesktopGroup Id" }, "SessionGUID": { "type": "string", "format": "uuid", "description": "Unique Identifier of the session" }, "ProcessGUID": { "type": "string", "format": "uuid", "description": "Unique Identifier of the process" }, "StartupTimeMs": { "type": "integer", "format": "int32", "description": "Startup time in ms for the application to initialize" }, "StartupIOPS": { "type": "integer", "format": "int32", "description": "Startup IOPS for the application" }, "ProcessParentGUID": { "type": "string", "format": "uuid", "description": "Parent Process GUID" }, "ProcessParentName": { "type": "string", "format": "string", "description": "Parent Process Name" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Database Record to track the chanages to the launch record" }, "IsPublishedApp": { "type": "boolean", "format": "boolean", "description": "True if the launch is for a published application" }, "IsAppEnded": { "type": "boolean", "format": "boolean", "description": "True if the application is Terminated" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine on which the application was launched." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "Desktop group id of the launched application." } } }, "Citrix.Monitor.Model.Application": { "description": "Represents a published application known to the Monitor service. Each time a user launches this application the run is tracked separately as an ApplicationInstance.", "required": [ "Id", "ApplicationType", "Enabled", "LifecycleState", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier for the application" }, "Name": { "type": "string", "description": "Unique administrative name of application" }, "PublishedName": { "type": "string", "description": "The name published to the end user corresponding to the Broker SDK's \"PublishedName\" property" }, "ApplicationType": { "type": "integer", "format": "int32", "description": "Type of the application, whether HostedOnDesktop or InstalledOnClient, corresponding to the ApplicationType enumeration." }, "Enabled": { "type": "boolean", "description": "Specifies whether or not this application can be launched." }, "AdminFolder": { "type": "string", "description": "Admin Folder" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state for the Application user for internal tracking and deletion management." }, "Path": { "type": "string", "description": "Path of the application published on the VDA" }, "BrowserName": { "type": "string", "description": "BrowserName associated with Application" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "DesktopGroups": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" }, "description": "The Delivery groups this application is related to." }, "ApplicationInstances": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationInstance" }, "description": "Navigation collection of the historical and currently running instances (ApplicationInstance) of this application." }, "ProbeRuleApplications": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleApplication" }, "description": "Contains list of rules containing this application." }, "ProbeLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLog" }, "description": "Contains list of probe logs associated with the application" } } }, "Citrix.Monitor.Model.ApplicationError": { "description": "Record of an application error", "required": [ "Id", "SessionKey", "ErrorReportedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the application error" }, "FaultingApplicationPath": { "type": "string", "description": "Path of the application" }, "ProcessName": { "type": "string", "description": "Process Name" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Unique identifier of the session" }, "Version": { "type": "string", "description": "Application Version" }, "Description": { "type": "string", "description": "Error Description" }, "ErrorReportedDate": { "type": "string", "format": "date-time", "description": "Date when the application error occurred" }, "BrowserNames": { "type": "string", "description": "List of Applications running in the session" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this Error record is associated with" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Session this error is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine this Error record is associated with." } } }, "Citrix.Monitor.Model.ApplicationFault": { "description": "Record of an application fault", "required": [ "Id", "SessionKey", "FaultReportedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the application fault" }, "FaultingApplicationPath": { "type": "string", "description": "Path of the application" }, "ProcessName": { "type": "string", "description": "Process Name" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Unique identifier of the session" }, "Version": { "type": "string", "description": "Application Version" }, "Description": { "type": "string", "description": "Fault Description" }, "FaultReportedDate": { "type": "string", "format": "date-time", "description": "Date when the application fault occurred" }, "BrowserNames": { "type": "string", "description": "List of Applications running in the session" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this Fault record is associated with" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Session this fault is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine this Fault record is associated with." } } }, "Citrix.Monitor.Model.ApplicationIdDesktopGroupIdMapping": { "description": "Represents ApplicationId and DesktopGroupId Mapping data for local applications", "required": [ "AppId", "AppVersion", "DesktopGroupId" ], "type": "object", "properties": { "AppId": { "type": "string", "format": "string", "description": "Application Id" }, "AppVersion": { "type": "string", "format": "string", "description": "Application Version" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "DesktopGroup Id" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Time of creation of the application" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Time of modification of the application" }, "LastUsageTimestamp": { "type": "string", "format": "date-time", "description": "Time when the application was last used" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "Desktop Group details." } } }, "Citrix.Monitor.Model.ApplicationInstance": { "description": "A running or previously running instance of a published application within a session.", "required": [ "Id", "SessionKey", "StartDate", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the application instance" }, "ApplicationId": { "type": "string", "format": "uuid", "description": "Guid of the application" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Guid of the session this application instance was created on (See Session property)." }, "StartDate": { "type": "string", "format": "date-time", "description": "Date when the application was started" }, "EndDate": { "type": "string", "format": "date-time", "description": "Date when the application was terminated" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Application": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Application", "description": "Application associated this application instance." }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "The session associated with the application." } } }, "Citrix.Monitor.Model.ApplicationInstanceSummary": { "description": "Roll up table for Application instances", "required": [ "Id", "SummaryDate", "PeakConcurrentInstanceCount", "TotalUsageDuration", "TotalLaunchesCount", "StartingInstanceCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for ApplicationInstanceSummary" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning time (to the minute) that this summary data represents" }, "ApplicationId": { "type": "string", "format": "uuid", "description": "Guid of the application this instance summary corresponds to (see Application property)" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "The Id of the Delivery Group this application instance is associated with." }, "PeakConcurrentInstanceCount": { "type": "integer", "format": "int32", "description": "Number of peak concurrent instances of the application for the time slot specified" }, "TotalUsageDuration": { "type": "number", "format": "double", "description": "Total application usage duration in seconds (sum of each application instance's active duration) for all instances of this application in the time slot. Value is in seconds, not milliseconds." }, "TotalLaunchesCount": { "type": "integer", "format": "int32", "description": "Total number of application launch events in the time slot" }, "StartingInstanceCount": { "type": "integer", "format": "int32", "description": "Number of application instances at the start of the summary window (see SummaryDate)" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes (how many minutes of data included in this time slot)" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Application": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Application", "description": "The application this summary data represents." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The delivery group this application instance is associated with." } } }, "Citrix.Monitor.Model.ApplicationUsageSummaryData": { "description": "Represents the summary of application usage metrics", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Summary Date" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Foreign key to the DesktopGroups entity. Null when the summary spans all delivery groups." }, "AppId": { "type": "string", "format": "string", "description": "Application Id" }, "UniqueUserCount": { "type": "integer", "format": "int32", "description": "Unique Users Count" }, "TotalMachinesCount": { "type": "integer", "format": "int32", "description": "Total Machines Count" }, "PeakConcurrentLaunches": { "type": "integer", "format": "int32", "description": "Peak Concurrent Launches" }, "StartingInstancesCount": { "type": "integer", "format": "int32", "description": "Starting Instances Count" }, "TotalLaunches": { "type": "integer", "format": "int32", "description": "Total Launches" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "Desktop group details of the application." } } }, "Citrix.Monitor.Model.AutoScalePrediction": { "description": "Autoscale prediction record containing forecasted values used to drive proactive power management for a delivery group.", "required": [ "DesktopGroupId", "PredictionDate" ], "type": "object", "properties": { "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of the desktop group this entry is associated with." }, "PredictionDate": { "type": "string", "format": "date-time", "description": "Prediction Date" }, "SameHourEma": { "type": "number", "format": "double", "description": "The same hour ema component" }, "PredictedMachineCount": { "type": "integer", "format": "int32", "description": "The predicated machine count for the desktop group" }, "QuickAdderPrediction": { "type": "integer", "format": "int32", "description": "QuickAdapter used for statistic model w1 *(preweek1SameHOur-preWeek1PrevHour) +...w5* (preweek5SameHour-preWeek5PrevHour)" }, "CombinedPrediction": { "type": "integer", "format": "int32", "description": "CombinedPrediction used for statistic model" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date" }, "UpdatedDate": { "type": "string", "format": "date-time", "description": "Updated Date" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "foreign key reference for desktop group." } } }, "Citrix.Monitor.Model.Catalog": { "description": "A machine catalog defining provisioning, allocation, and session support.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier for the Catalog" }, "Name": { "type": "string", "format": "string", "description": "Name of Catalog Broker name: CatalogName Desktop Director name: Catalog" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state for the Catalog used for internal management and tracking" }, "ProvisioningType": { "type": "integer", "format": "int32", "description": "Provisioning type for the Catalog. See Provisioning Type enum for possible values." }, "PersistentUserChanges": { "type": "integer", "format": "int32", "description": "Specifies how user changes are persisted on machines in the catalog. See Get-BrokerCatalog for details. See PersistentUserChangesType enum for possible values." }, "IsMachinePhysical": { "type": "boolean", "format": "boolean", "description": "Indicates whether machine is physical" }, "AllocationType": { "type": "integer", "format": "int32", "description": "Denotes how the the machines in the catalog are allocated to a user. See Get-BrokerCatalog for details. See AllocationType enum for possible values." }, "SessionSupport": { "type": "integer", "format": "int32", "description": "Specifies the session support of the machines in the catalog (single vs multi) See Get-BrokerCatalog for details. See SessionSupportCode enum for possible values." }, "ProvisioningSchemeId": { "type": "string", "format": "uuid", "description": "The GUID of the provisioning scheme (if any) associated with the catalog. This only applies if the provisioning type is MCS." }, "ZoneUid": { "type": "string", "format": "uuid", "description": "Zone Uid for the catalog" }, "ZoneName": { "type": "string", "format": "string", "description": "Zone name for the catalog Broker name: ZoneName Destop Director name: Resouce Location" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machines": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "description": "List of machines that are part of this catalog" } } }, "Citrix.Monitor.Model.CloudConnectorServiceStatus": { "required": [ "ConnectorName", "ServiceName", "ZoneName" ], "type": "object", "properties": { "ServiceName": { "type": "string", "format": "string", "description": "Name of the Cloud Connector service being reported." }, "ConnectorName": { "type": "string", "format": "string", "description": "Name of the Cloud Connector reporting the status." }, "ZoneName": { "type": "string", "format": "string", "description": "Resource zone the Cloud Connector belongs to." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Record creation timestamp." }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Last update timestamp." }, "Status": { "type": "integer", "format": "int32", "description": "Reported service status." } }, "description": "Health and availability status of Citrix Cloud Connector services, reported per connector and resource zone." }, "Citrix.Monitor.Model.ComponentResourceUtilization": { "description": "Resource Utilization for a given component at a given time", "required": [ "AgentId", "CollectedDate" ], "type": "object", "properties": { "CollectedDate": { "type": "string", "format": "date-time", "description": "Collection date for this a given row" }, "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this data is collected from" }, "FetchId": { "type": "string", "format": "uuid", "description": "FetchId to join this with component specific data e.g. PvsMetrics, etc." }, "PercentCpus": { "type": "string", "format": "string", "description": "CPU percentages for the component" }, "AvgPercentCpu": { "type": "number", "format": "double", "description": "Average CPU percentage for the component" }, "PeakPercentCpu": { "type": "number", "format": "double", "description": "Peak CPU percentage for the component" }, "MemoryUsages": { "type": "string", "format": "string", "description": "Memory usages for the component" }, "AvgMemoryUsage": { "type": "number", "format": "double", "description": "Average Memory usage for the component" }, "PeakMemoryUsage": { "type": "number", "format": "double", "description": "Peak Memory usgae for the component" }, "DiskIOs": { "type": "string", "format": "string", "description": "Disk IOs for the component" }, "AvgDiskIO": { "type": "number", "format": "double", "description": "Average Disk IO for the component" }, "PeakDiskIO": { "type": "number", "format": "double", "description": "Peak Disk IO for the component" }, "DiskLatenciesInMs": { "type": "string", "format": "string", "description": "Disk Latencies in milliseconds for the component" }, "AvgDiskLatencyInMs": { "type": "number", "format": "double", "description": "Average Disk Latency in millisecond for the component" }, "PeakDiskLatencyInMs": { "type": "number", "format": "double", "description": "Peak Disk Latency in millisecond for the component" } } }, "Citrix.Monitor.Model.Connection": { "description": "Summary collection object for session detail information - a new record will be created for every connect/reconnect on the same session All session connect data points will be captured in this class", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for Connection" }, "ClientName": { "type": "string", "format": "string", "description": "The host name of the client connected to the session Broker name: ClientName Desktop Director name: Endpoint" }, "ClientAddress": { "type": "string", "format": "string", "description": "The IP address of the client connected to the session Broker name: ClientAddress Desktop Director name: Endpoint (IP)" }, "ClientPublicIP": { "type": "string", "format": "string", "description": "Client Public IP Address" }, "ClientVersion": { "type": "string", "format": "string", "description": "The version of the Citrix Receiver running on the client connected to the session. Assigning to this property automatically refreshes the derived ClientVersionYYMM so the two columns stay in sync without each caller having to remember." }, "ClientPlatform": { "type": "string", "format": "string", "description": "The platform running on the client." }, "ClientISP": { "type": "string", "format": "string", "description": "Client Internet Service Provider" }, "ClientLocationCountry": { "type": "string", "format": "string", "description": "Client Location (Country)" }, "ClientLocationCity": { "type": "string", "format": "string", "description": "Client Location (City)" }, "ClientNetworkInterfaceType": { "type": "", "format": "", "description": "Client Network Interface Type" }, "WorkspaceType": { "type": "", "format": "", "description": "Citrix Workspace App (CWA) client/workspace type used for the connection, as a WorkspaceType enum value. Null when not reported." }, "ConnectedViaHostName": { "type": "string", "format": "string", "description": "The host name of the incoming connection. This is usually a gateway, router or client. Broker name: ConnectedViaHostName Desktop Director name: ConnectedVia" }, "ConnectedViaIPAddress": { "type": "string", "format": "string", "description": "The IP address of the incoming connection This is usually a gateway, router or client. Broker name: ConnectedViaIP Desktop Director name: ConnectedVia (IP)" }, "LaunchedViaHostName": { "type": "string", "format": "string", "description": "The host name of the StoreFront server used to launch the session. Broker name: LaunchedViaHostName Desktop Director name: LaunchedVia" }, "LaunchedViaIPAddress": { "type": "string", "format": "string", "description": "The IP address of the StoreFront server used to launch the session Broker name: LaunchedViaIP Desktop Director name: LaunchedVia (IP)" }, "IsReconnect": { "type": "boolean", "format": "boolean", "description": "Indicates whether this connection is a reconnection to an existing session." }, "IsSecureIca": { "type": "boolean", "format": "boolean", "description": "Indicates whether SecureICA is active on the session. Broker name: SecureIcaActive Desktop Director name: SecureICA" }, "Protocol": { "type": "string", "format": "string", "description": "The protocol that the session is using, can be HDX, RDP, or Console Broker name: Protocol Desktop Director name: Connection Type" }, "LogOnStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of Logon Start event" }, "LogOnEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of Logon end event" }, "BrokeringDuration": { "type": "integer", "format": "int64", "description": "Brokering duration calculation" }, "BrokeringDate": { "type": "string", "format": "date-time", "description": "Time stamp of Brokering time" }, "DisconnectCode": { "type": "integer", "format": "int64", "description": "Disconnect event code" }, "DisconnectDate": { "type": "string", "format": "date-time", "description": "Time stamp of Disconnect event" }, "VMStartStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of VmStartStart event maps to Brokering Time in Desktop Director UI" }, "VMPoweredOnDate": { "type": "string", "format": "date-time", "description": "Time stamp of VMPoweredOn event" }, "VMStartEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of VmStartEnd event" }, "ClientSessionValidateDate": { "type": "string", "format": "date-time", "description": "Time stamp of Client Session Validated" }, "ServerSessionValidateDate": { "type": "string", "format": "date-time", "description": "Time stamp of Server Session Validated" }, "EstablishmentDate": { "type": "string", "format": "date-time", "description": "Time stamp recorded on the Broker at the point when the VDA confirms session connect / reconnect maps to Resolution Time in Desktop Director UI" }, "HdxStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of Hdx Start event" }, "HdxEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of Hdx end event" }, "AuthenticationDuration": { "type": "integer", "format": "int32", "description": "Authentication Duration in milliseconds" }, "GpoStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of GpoStart event" }, "GpoEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of GpoEnd event" }, "LogOnScriptsStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of LogonScriptsStart event" }, "LogOnScriptsEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of LogonScriptsEnd event" }, "ProfileLoadStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of ProfileLoadStart event" }, "ProfileLoadEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of ProfileLoadEnd event" }, "InteractiveStartDate": { "type": "string", "format": "date-time", "description": "Time stamp of InteractiveStart event" }, "InteractiveEndDate": { "type": "string", "format": "date-time", "description": "Time stamp of InteractiveEnd event" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Guid if session this connection is associated with" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Session this connection is associated with." }, "ConnectionFailureLog": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectionFailureLog", "description": "ConnectionFailureLog this connection is associated with, if any." } } }, "Citrix.Monitor.Model.ConnectionFailureLog": { "description": "ConnectionFailureLog", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for ConnectionFailureLog" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Guid of session associated with the failure log entry" }, "FailureDate": { "type": "string", "format": "date-time", "description": "Time of failure" }, "UserId": { "type": "integer", "format": "int64", "description": "User this failure is associated with" }, "MachineId": { "type": "string", "format": "uuid", "description": "Machine this failure is associated with" }, "ConnectionFailureEnumValue": { "type": "integer", "format": "int32", "description": "Numeric connection failure code identifying the specific connection failure reason. The matching human-readable text is in ConnectionFailureText." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Session associated with the failure log entry." }, "Connection": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Connection", "description": "Connection this failure is associated with." }, "User": { "$ref": "#/components/schemas/Citrix.Monitor.Model.User", "description": "User this failure is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine this failure is associated with." } } }, "Citrix.Monitor.Model.DesktopGroup": { "description": "Assignment for - get-brokerdesktopgroup cmdlet", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier for DesktopGroup" }, "Name": { "type": "string", "format": "string", "description": "Desktop group name" }, "IsRemotePC": { "type": "boolean", "format": "boolean", "description": "Remote PC indicator" }, "DesktopKind": { "type": "integer", "format": "int32", "description": "Indicates if the session is shared or private. Broker name: DesktopKind Desktop Director name: Allocation Type" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Internal property used for navigation and management" }, "SessionSupport": { "type": "integer", "format": "int32", "description": "Specifies the session support (single/multi) of the machines in the desktop group See the SessionSupportCode for possible values." }, "DeliveryType": { "type": "integer", "format": "int32", "description": "The type of resources being published. See the enum DeliveryType for possible values." }, "IsInMaintenanceMode": { "type": "boolean", "format": "boolean", "description": "Maintenance mode indicator" }, "MachineCost": { "type": "number", "format": "double", "description": "Per-machine cost value configured for this delivery group. Null when unavailable." }, "CurrencyType": { "type": "", "format": "", "description": "Currency of the MachineCost value, as a CurrencyType enum value (for example, 1=USD, 2=EUR, 7=GBP). Null when unknown." }, "AutoscaleTagId": { "type": "integer", "format": "int32", "description": "Identifier of the tag used to scope Autoscale power management for this delivery group. Null when Autoscale is not restricted to a tag." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machines": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "description": "List of Machines that are in the desktop group" }, "Applications": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Application" }, "description": "List of Applications that are in this group" }, "DesktopGroupDesktop": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeDesktop" }, "description": "List of published desktops that are in this group" }, "ResourceUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilization" }, "description": "Resource utilizations for all machines in this desktop group" }, "ResourceUtilizationSummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummary" }, "description": "ResourceUtilizationSummary values associated with this Desktop Group" }, "HistoricalApplicationLaunches": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.HistoricalApplicationLaunch" }, "description": "The desktop group of the application launched" }, "ApplicationIdDesktopGroupIdMappings": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationIdDesktopGroupIdMapping" }, "description": "The desktop group of the application id and the desktopgroup id mapping" }, "ApplicationsUsageSummaryData": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationUsageSummaryData" }, "description": "The desktop group details of applications usage summary" }, "ActiveApplicationLaunches": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ActiveApplicationLaunch" }, "description": "The desktop group of the active application launch" } } }, "Citrix.Monitor.Model.DesktopOSDesktopSummary": { "description": "Time-windowed VDI (single-session) desktop usage per Delivery Group.", "required": [ "Id", "SummaryDate", "PeakConcurrentInstanceCount", "TotalUsageDuration", "TotalLaunchesCount", "StartingInstanceCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the DesktopOSDesktopSummary instance" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) that this summary data represents" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of the DesktopGroupId this machine belongs to." }, "PeakConcurrentInstanceCount": { "type": "integer", "format": "int32", "description": "Peak number of concurrent desktop sessions (distinct SessionKey) on single-session (VDI) machines in this Delivery Group during the time slot." }, "TotalUsageDuration": { "type": "number", "format": "double", "description": "Total desktop session usage in seconds (sum of each session's active duration) across all sessions in this Delivery Group for the time slot. Value is in seconds, not milliseconds." }, "TotalLaunchesCount": { "type": "integer", "format": "int32", "description": "Number of desktop sessions that started during the time slot." }, "StartingInstanceCount": { "type": "integer", "format": "int32", "description": "Number of desktop sessions already running at the start of the summary window (see SummaryDate)." }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes (how many minutes of data included in this time slot)" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The session associated with the application." } } }, "Citrix.Monitor.Model.DirectorAgent": { "description": "DirectorAgent class", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the agent" }, "ResourceLocationId": { "type": "string", "format": "uuid", "description": "Unique identifier of the resource location the agent belongs to" }, "ResourceLocationName": { "type": "string", "format": "string", "description": "Name of the resource location the agent belongs to." }, "Fqdn": { "type": "string", "format": "string", "description": "FQDN of the machine where agent is installed" }, "Component": { "type": "integer", "format": "int32", "description": "Component Type for the agent." }, "ComponentId": { "type": "string", "format": "string", "description": "Optional component id to identify the component associated with this agent" }, "ComponentStatus": { "type": "string", "format": "string", "description": "Component Status to indicate the healthyness of the component" }, "PrivateKey": { "type": "string", "format": "string", "description": "Private Key to sign calls for this agent" }, "EncryptionKey": { "type": "string", "format": "string", "description": "Key that can be used for symmetric encryption decryption" }, "LastCollectionDate": { "type": "string", "format": "date-time", "description": "Last time the agent was called and data was collected" }, "LastCollectionStatus": { "type": "integer", "format": "int32", "description": "Status of the most recent metrics collection for the agent." }, "Version": { "type": "string", "format": "string", "description": "Version of the agent installed" }, "CreatedBy": { "type": "string", "format": "string", "description": "Created by user" }, "ModifiedBy": { "type": "string", "format": "string", "description": "Last modified by user" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.EndpointMetrics": { "description": "Client endpoint performance metrics collected during a session (WiFi, throughput, CPU, memory, GPU, beacon latency).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Autogenerated id for EndpointMetrics record" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Session key this EndpontMetrics record is associated with" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date time this object was collected from source (UTC time, yyyy-MM-dd HH:mm:ss.SSS)" }, "WifiSignalStrength": { "type": "integer", "format": "int32", "description": "Endpoint Wifi Signal Strength" }, "ThroughputIncoming": { "type": "integer", "format": "int64", "description": "Endpoint Throughput Incoming" }, "ThroughputOutgoing": { "type": "integer", "format": "int64", "description": "Endpoint Throughput Outgoing" }, "PercentCPU": { "type": "number", "format": "double", "description": "Endpoint CPU Usage" }, "PercentMemory": { "type": "number", "format": "double", "description": "Endpoint Memory Usage" }, "PercentGPU": { "type": "number", "format": "double", "description": "Endpoint GPU Usage" }, "BeaconLatency": { "type": "number", "format": "double", "description": "Beacon Latency" }, "LatencyUnit": { "type": "string", "format": "string", "description": "Latency unit for Beacon Latency" }, "LinkSpeed": { "type": "number", "format": "double", "description": "Network link speed of the client connection, expressed in the unit given by SpeedUnit (e.g., Mbps). Null if not measured." }, "SpeedUnit": { "type": "string", "format": "string", "description": "Speed unit for Link Speed" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date time of this record (UTC time, yyyy-MM-dd HH:mm:ss.SSS)" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "The session this EndpointMetrics record is associated with." } } }, "Citrix.Monitor.Model.FailureLogSummary": { "description": "POCO object for failures (connection/machine) rollup/summary per minute/hour/day", "required": [ "Id", "SummaryDate", "FailureCategory", "FailureCode", "FailureCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for DesktopGroupSummary" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Time slot to which this summary data is assigned" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of Delivery Group this failure log summary is associated with" }, "FailureCategory": { "type": "integer", "format": "int32", "description": "Category for the failure: Connection or Machine. See FailureCategory enum for possible values." }, "FailureCode": { "type": "integer", "format": "int32", "description": "Failure code identifying the specific connection or machine failure reason for this summary." }, "FailureCount": { "type": "integer", "format": "int32", "description": "Number of failures for this desktop group for the corresponding time interval" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes Length in minutes of the time slot associated with the summary data" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "Delivery Group this failure log summary is associated with." } } }, "Citrix.Monitor.Model.HistoricalApplicationLaunch": { "description": "Completed (historical) application launch record, created when an active launch ends; includes startup performance metrics.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "AppId": { "type": "string", "format": "string", "description": "Application Id" }, "ProcessName": { "type": "string", "format": "string", "description": "Process Name associated with the application" }, "StartDate": { "type": "string", "format": "date-time", "description": "Start Time of the application" }, "EndDate": { "type": "string", "format": "date-time", "description": "End Time of the application" }, "AppVersion": { "type": "string", "format": "string", "description": "Application Version" }, "ExecutablePath": { "type": "string", "format": "string", "description": "Application executable path" }, "UserName": { "type": "string", "format": "string", "description": "User who launched the application." }, "MachineId": { "type": "string", "format": "uuid", "description": "Foreign key to the Machine on which the application was launched." }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "DesktopGroup Id" }, "SessionGUID": { "type": "string", "format": "uuid", "description": "Unique Identifier of the session" }, "ProcessGUID": { "type": "string", "format": "uuid", "description": "Unique Identifier of the process" }, "StartupTimeMs": { "type": "integer", "format": "int32", "description": "Startup time in ms for the application to initialize" }, "StartupIOPS": { "type": "integer", "format": "int32", "description": "Startup IOPS for the application" }, "ProcessParentGUID": { "type": "string", "format": "uuid", "description": "Parent Process GUID" }, "ProcessParentName": { "type": "string", "format": "string", "description": "Parent Process Name" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Database Record to track the chanages to the launch record" }, "IsPublishedApp": { "type": "boolean", "format": "boolean", "description": "True if the launch is for a published application" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine on which the application was launched." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "Desktop group id of the launched application." } } }, "Citrix.Monitor.Model.Hotfix": { "description": "Hotfix class", "required": [ "Id", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the hotfix" }, "Name": { "type": "string", "description": "Name of the hotfix" }, "Article": { "type": "string", "description": "URL for the article about the hotfix" }, "ArticleName": { "type": "string", "description": "Name of the article" }, "FileName": { "type": "string", "description": "File name of the hotfix" }, "FileFormat": { "type": "string", "description": "File format of the hotfix" }, "Version": { "type": "string", "description": "Version of the hotfix installed" }, "ComponentName": { "type": "string", "description": "Name of the component" }, "ComponentVersion": { "type": "string", "description": "Version of the component" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "MachineHotfixLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineHotfixLog" }, "description": "Historical list of the all the machines that have this hotfix installed/ removed" } } }, "Citrix.Monitor.Model.Hypervisor": { "description": "Assignment for - get-BrokerHypervisorConnection cmdlet", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier for Hypervisor" }, "Name": { "type": "string", "format": "string", "description": "Name of hypervisor" }, "Type": { "type": "string", "format": "string", "description": "Type of hypervisor" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state for the Hypervisor - can be active or deleted See the LifecycleState enum for possible values" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machines": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "description": "Machines hosted by this hypervisor" } } }, "Citrix.Monitor.Model.LhcReport": { "description": "Local Host Cache (LHC) activity report - one row per window when LHC was active (primary broker unavailable).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for LhcReport" }, "StartDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when Local Host Cache became active (start of the outage window)." }, "EndDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when Local Host Cache deactivated (end of the outage window)." }, "SessionBrokeredCount": { "type": "integer", "format": "int32", "description": "Number of sessions brokered while Local Host Cache was active." }, "ReconnectedSessionCount": { "type": "integer", "format": "int32", "description": "Number of sessions reconnected while Local Host Cache was active." }, "MachineInZoneCount": { "type": "integer", "format": "int32", "description": "Number of machines in the zone while Local Host Cache was active." }, "MachineRegisteredCount": { "type": "integer", "format": "int32", "description": "Number of registered machines while Local Host Cache was active." }, "ZoneName": { "type": "string", "format": "string", "description": "Name of the resource zone this report covers." }, "ControllerName": { "type": "string", "format": "string", "description": "Name of the Delivery Controller (DDC) that ran Local Host Cache." } } }, "Citrix.Monitor.Model.LoadIndex": { "description": "Load Index collected data", "required": [ "Id", "EffectiveLoadIndex", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for LoadIndex" }, "EffectiveLoadIndex": { "type": "integer", "format": "int32", "description": "Percentage of Total load Desktop Director name: Load Evaluator %" }, "Cpu": { "type": "integer", "format": "int32", "description": "Percentage of CPU load" }, "Memory": { "type": "integer", "format": "int32", "description": "Percentage of Memory load" }, "Disk": { "type": "integer", "format": "int32", "description": "Percentage of Disk load" }, "Network": { "type": "integer", "format": "int32", "description": "Percentage of Network load" }, "SessionCount": { "type": "integer", "format": "int32", "description": "Percentage of Session Count load maps to # of Session in Desktop Director UI" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this LoadIndex record is associated with" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine this LoadIndex record is associated with." } } }, "Citrix.Monitor.Model.LoadIndexSummary": { "description": "POCO object for load index rollup/summary per hour/day", "required": [ "Id", "SummaryDate", "SumCount", "SumLoadIndex", "SumCpu", "SumNetwork", "SumDisk", "SumMemory", "SumSessionCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Time stamp associated with this summary data" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this summary is associated with" }, "SumCount": { "type": "integer", "format": "int32", "description": "Count of samples aggregated for each of the loadIndex parameters" }, "SumLoadIndex": { "type": "integer", "format": "int32", "description": "Aggregation of effective load index for this machine for the time window associated with this summary" }, "SumCpu": { "type": "integer", "format": "int32", "description": "Aggregation of CPU for this machine for the time window associated with this summary" }, "SumNetwork": { "type": "integer", "format": "int32", "description": "Aggregation of Network bandwidth records for this machine for the time window associated with this summary" }, "SumDisk": { "type": "integer", "format": "int32", "description": "Aggregation of Disk for this machine for this machine for the time window associated with this summary" }, "SumMemory": { "type": "integer", "format": "int32", "description": "Aggregation of Memory for this machine for the time window associated with this summary" }, "SumSessionCount": { "type": "integer", "format": "int32", "description": "Aggregation of session counts for this machine for the time window associated with this summary" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes Size of the time windows in minutes for this summary" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine this summary is associated with." } } }, "Citrix.Monitor.Model.LogOnMetric": { "description": "Logon Metric", "required": [ "Id", "SessionKey" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Logon Metric Id" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Foreign key to the Session these logon metrics belong to." }, "UserInitStartDate": { "type": "string", "format": "date-time", "description": "User Init Start Date" }, "UserInitEndDate": { "type": "string", "format": "date-time", "description": "User Init End Date" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Contains mapping to the Session." } } }, "Citrix.Monitor.Model.LogOnSummary": { "description": "POCO object for logon breakdown rollup/summary per hour/day The total duration and each breakdown has an associated count This count is used to get the average correctly in case of rollups", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Time stamp associated with this summary data" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of DesktopGroup this summary is associated with" }, "TotalDuration": { "type": "integer", "format": "int64", "description": "Sum of all logon durations" }, "TotalCount": { "type": "integer", "format": "int32", "description": "Count of Total logons" }, "BrokeringDuration": { "type": "integer", "format": "int64", "description": "Sum of all brokering durations" }, "BrokeringCount": { "type": "integer", "format": "int32", "description": "Count of the Brokering durations" }, "VMStartDuration": { "type": "integer", "format": "int64", "description": "Sum of all VM Start durations" }, "VMPowerOnDuration": { "type": "integer", "format": "int64", "description": "Sum of all VM power on durations" }, "VMRegistrationDuration": { "type": "integer", "format": "int64", "description": "Sum of all VM registration durations" }, "VMStartCount": { "type": "integer", "format": "int32", "description": "Count of all VM Start durations" }, "HdxDuration": { "type": "integer", "format": "int64", "description": "Sum of all Hdx durations" }, "HdxCount": { "type": "integer", "format": "int32", "description": "Count of all Hdx durations" }, "AuthenticationDuration": { "type": "integer", "format": "int64", "description": "Sum of all Authentication durations" }, "AuthenticationCount": { "type": "integer", "format": "int32", "description": "Count of all Authentication durations" }, "GpoDuration": { "type": "integer", "format": "int64", "description": "Sum of all Gpo durations" }, "GpoCount": { "type": "integer", "format": "int32", "description": "Count of all Gpo durations" }, "LogOnScriptsDuration": { "type": "integer", "format": "int64", "description": "Sum of all LogonScripts durations" }, "LogOnScriptsCount": { "type": "integer", "format": "int32", "description": "Count of all LogonScripts durations" }, "InteractiveDuration": { "type": "integer", "format": "int64", "description": "Sum of all Interactive durations" }, "InteractiveCount": { "type": "integer", "format": "int32", "description": "Count of all Interactive durations" }, "ProfileLoadDuration": { "type": "integer", "format": "int64", "description": "Sum of all Profile Load durations" }, "ProfileLoadCount": { "type": "integer", "format": "int32", "description": "Count of all Profile Load durations" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes Size of the time windows in minutes for this summary" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "DesktopGroup this summary is associated with." } } }, "Citrix.Monitor.Model.Machine": { "description": "Represents a Machine in the site", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier for Machine" }, "Sid": { "type": "string", "format": "string", "description": "SID of the machine" }, "Name": { "type": "string", "format": "string", "description": "Machine name Broker name: MachineName Director name: Name" }, "DnsName": { "type": "string", "format": "string", "description": "DNS name for this Machine, typically FQDN Broker name: DNSName Director name: DNS Name" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state for the Machine. Used internally for data management." }, "IPAddress": { "type": "string", "format": "string", "description": "IP Address of the machine, can be either IP v4 or IP v6 depending on how the machine is set up Broker name: IPAddress Desktop Director name: IP Address" }, "HostedMachineId": { "type": "string", "format": "string", "description": "Hypervisor identifier for this Machine" }, "HostingServerName": { "type": "string", "format": "string", "description": "DNS name of the hypervisor that is hosting the machine if managed. Broker name: HostingServerName Desktop Director name: Server" }, "HostedMachineName": { "type": "string", "format": "string", "description": "The friendly name of a hosted machine as used by its hypervisor. This is not necessarily the DNS name of the machine. Broker name: HostedMachineName Desktop Director name: VM" }, "IsAssigned": { "type": "boolean", "format": "boolean", "description": "Denotes whether a private desktop has been assigned to a user/users, or a client name/address Broker name: IsAssigned Desktop Director name: Is Allocated" }, "IsInMaintenanceMode": { "type": "boolean", "format": "boolean", "description": "Denotes if the machine is in maintenance mode. Broker name: InMaintenanceMode Desktop Director name: Maintenance Mode" }, "IsPendingUpdate": { "type": "boolean", "format": "boolean", "description": "Denotes if the VM image for a hosted machine is out of date. Broker name: ImageOutOfDate Desktop Director name: Pending Update" }, "AgentVersion": { "type": "string", "format": "string", "description": "The version of the VDA agent installed on this machine. Assigning to this property automatically refreshes the derived AgentVersionYYMM so the two columns stay in sync without each caller having to remember." }, "AssociatedUserFullNames": { "type": "string", "format": "string", "description": "Full names of the users that have been associated with the machine (usually in the form \"Firstname Lastname\"). Associated users are the current user(s) for shared machines and the assigned users for private machines." }, "AssociatedUserNames": { "type": "string", "format": "string", "description": "Usernames of the users that have been associated with the machine (in the form \"domain\\user\"). Associated users are the current user(s) for shared machines and the assigned users for private machines." }, "AssociatedUserUPNs": { "type": "string", "format": "string", "description": "The User Principal Names of the users associated with the machine (in the form user@domain). Associated users are the current user(s) for shared machines and the assigned users for private machines." }, "CurrentRegistrationState": { "type": "integer", "format": "int32", "description": "Current Registration state of this machine. See enum RegistrationState for possible values" }, "RegistrationStateChangeDate": { "type": "string", "format": "date-time", "description": "Time stamp of change to current registation state" }, "LastDeregisteredCode": { "type": "integer", "format": "int32", "description": "Last deregistration reason for this machine. See enum DeregistrationReasonCode for possible values" }, "LastDeregisteredDate": { "type": "string", "format": "date-time", "description": "Time of the last machine deregistration from the controller." }, "CurrentPowerState": { "type": "integer", "format": "int32", "description": "Current power state of this machine. See enum PowerStateCode for possible values" }, "CurrentSessionCount": { "type": "integer", "format": "int32", "description": "Number of sessions running on machine. Populated each minute from Session Activity consolidation task" }, "ControllerDnsName": { "type": "string", "format": "string", "description": "The DNS host name of the controller that the machine is registered to. Can be null if not brokered." }, "PoweredOnDate": { "type": "string", "format": "date-time", "description": "Time of last powering on event for this machine" }, "PowerStateChangeDate": { "type": "string", "format": "date-time", "description": "Time of change of current power state" }, "FunctionalLevel": { "type": "integer", "format": "int32", "description": "Functional Level of machine See enum FunctionalLevelCode for possible values" }, "FailureDate": { "type": "string", "format": "date-time", "description": "If the machine is in a failure state, the time the failure started. Otherwise, null" }, "WindowsConnectionSetting": { "type": "integer", "format": "int32", "description": "The logon mode reported by Windows itself (multi-session machines only). For single-session machines the value is always hardwired to LogonEnabled. See enum WindowsConnectionSettingCode for possible values" }, "IsPreparing": { "type": "boolean", "format": "boolean", "description": "Current PvD State of this machine (currently only used for IsPreparing value)" }, "FaultState": { "type": "integer", "format": "int32", "description": "Summary state of any current fault state of the machine. See enum MachineFaultStateCode for possible values" }, "OSType": { "type": "string", "format": "string", "description": "A string that can be used to identify the operating system that is running on the machine. Broker name: OsType Desktop Director name: OS" }, "CurrentLoadIndexId": { "type": "integer", "format": "int64", "description": "Current LoadIndex identifier for this machine" }, "CatalogId": { "type": "string", "format": "uuid", "description": "Guid of Catalog this machine belongs to" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of Delivery Group this machine belongs to" }, "HypervisorId": { "type": "string", "format": "uuid", "description": "Guid of Hypervisor this machine is running on" }, "LastPowerActionType": { "type": "", "format": "", "description": "Last Power Action Type" }, "LastPowerActionReason": { "type": "", "format": "", "description": "Last Power Action Reason" }, "LastPowerActionFailureReason": { "type": "", "format": "", "description": "Last failure reason for this machine during the power action. See enum DeregistrationReasonCode for possible values" }, "LastPowerActionCompletedDate": { "type": "string", "format": "date-time", "description": "Last PowerAction Completed Date" }, "LastUpgradeState": { "type": "integer", "format": "int32", "description": "Last upgrade state of this machine. See enum UpgradeState for possible values" }, "LastUpgradeStateChangeDate": { "type": "string", "format": "date-time", "description": "Time of the last machine upgrade state change from the VUS." }, "Tags": { "type": "", "format": "", "description": "Names of the tags applied to this machine." }, "Hash": { "type": "string", "format": "string", "description": "Holds the hash of the hotfixes on the machine" }, "MachineRole": { "type": "integer", "format": "int32", "description": "Indicates whether a machine is VDA, DDC or both See the enum MachineRole for possible values" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "CurrentLoadIndex": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LoadIndex", "description": "Most recent Load index values of machine (null if no data)." }, "Catalog": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Catalog", "description": "Catalog this machine was created from." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "Delivery group this desktop is part of." }, "Hypervisor": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Hypervisor", "description": "The hypervisor that this machine is associated with - can be null - not all machines are powered by hypervisors." }, "MachineCost": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineCost", "description": "A MachineCost refers to a machine." }, "Sessions": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "description": "List of past and present sessions for this Machine" }, "ConnectionFailureLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectionFailureLog" }, "description": "List of past and present connectionfailures for this Machine" }, "LoadIndex": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LoadIndex" }, "description": "LoadIndex values associated with this machine" }, "ResourceUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilization" }, "description": "ResourceUtilizations for this machine" }, "ProcessInfo": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessInfo" }, "description": "ProcessInfo values associated with this machine" }, "ProcessUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilization" }, "description": "ProcessUtilization values associated with this machine" }, "ProcessUtilizationMinuteSummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilizationMinuteSummary" }, "description": "ProcessUtilizationMinuteSummary values associated with this machine" }, "ProcessUtilizationHourSummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilizationHourSummary" }, "description": "ProcessUtilizationHourSummary values associated with this machine" }, "ProcessUtilizationDaySummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilizationDaySummary" }, "description": "ProcessUtilizationDaySummary values associated with this machine" }, "MachineFailures": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineFailureLog" }, "description": "Failures associated with this machine" }, "MachineMetric": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineMetric" }, "description": "IOPS Utilization values associated with this machine" }, "MachineMetricSummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineMetricDaySummary" }, "description": "IOPS Utilization values associated with this machine" }, "MachineHotfixLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineHotfixLog" }, "description": "List of hotfix logs (instalation and removal) that have been applied to this machine" }, "ApplicationFaults": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationFault" }, "description": "Application faults associated wth this machine" }, "ApplicationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationError" }, "description": "Application errors associated wth this machine" }, "HistoricalApplicationLaunches": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.HistoricalApplicationLaunch" }, "description": "The machine on which the application is launched for local apps" }, "ActiveApplicationLaunches": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ActiveApplicationLaunch" }, "description": "The machine on which the application is launched for local apps" } } }, "Citrix.Monitor.Model.MachineCost": { "description": "Model entity of the cost of a VM", "required": [ "MachineId" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine ID as the Unique identifier" }, "SpecId": { "type": "integer", "format": "int32", "description": "Machine Spec ID" }, "CostPerHour": { "type": "number", "format": "double", "description": "Machine per hour Cost" }, "Currency": { "type": "", "format": "", "description": "Currency of the cost values, as a CurrencyType enum value (for example, 1=USD, 2=EUR, 7=GBP)." }, "CostSource": { "type": "", "format": "", "description": "Source of the cost figures, as a CostType enum value (for example, 1=AssumedCost, 2=ConfiguredCostFromStudio, 3=AzureRetailAPI). Null when unknown." }, "PowerOnComputeCostPerHour": { "type": "number", "format": "double", "description": "Machine per hour Cost" }, "PowerOnStorageCostPerHour": { "type": "number", "format": "double", "description": "Machine per hour Cost" }, "PowerOffStorageCostPerHour": { "type": "number", "format": "double", "description": "Machine per hour Cost" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine associated with the machine cost entity." } } }, "Citrix.Monitor.Model.MachineCostSavingsSummary": { "description": "Aggregated cost-savings per delivery group from power management (AutoScale + end-user actions).", "required": [ "DesktopGroupId", "SummaryDate", "Granularity", "HypervisorType", "TagId", "TotalMachinesCount", "PowerManagedMachinesOff", "PowerManagedMachinesInHibernate", "PowerManagedMachinesOnWithSessions", "PowerManagedMachinesOnWithoutSessions", "PowerManagedMachineMinutesTurnedOff", "TotalScaleInActions", "TotalHibernateActions", "TotalScaleOutActions", "TotalPeakConcurrentSessions", "AverageLogonDurationInSec", "AveragePowerManagedMachinesCount", "AverageMachineCostPerHour", "CostType", "CurrencyType", "TotalAmountSaved", "TotalCostIfNoPowerManagement", "TotalAutoscaleComputeSavings", "TotalAutoscaleStorageSavings", "TotalEndUserComputeSavings", "TotalEndUserStorageSavings", "AverageComputeCostPerHour", "AverageStorageCostPerHour", "TotalComputeCost", "TotalStorageCost" ], "type": "object", "properties": { "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of desktopgroup this summary is associated with" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "The SummaryDate of the machine cost savings summary. Machine Cost Saving Summary results are generated at hour, day and month level. Starting hour at 00:00:00.000 UTC." }, "Granularity": { "type": "integer", "format": "int32", "description": "The aggregation Granularity of the generated machine cost savings summary per DesktopGroup. See enum [CostSavingsSummaryGranularity](/en-us/monitor-service-odata-api/monitor-service-enums#CostSavingsSummaryGranularity) for possible values." }, "HypervisorType": { "type": "integer", "format": "int32", "description": "Column that denotes the HypervisorType of the machine that is associated with the aggregation results. See enum [HypervisorType](/en-us/monitor-service-odata-api/monitor-service-enums#HypervisorType) for possible values." }, "TagId": { "type": "integer", "format": "int32", "description": "Autoscale Tag Id associated with the cost saving summary." }, "TotalMachinesCount": { "type": "integer", "format": "int32", "description": "no of machines present in the delivery group" }, "PowerManagedMachinesOff": { "type": "integer", "format": "int32", "description": "no of power managed machines which are off at the time of aggregation" }, "PowerManagedMachinesInHibernate": { "type": "integer", "format": "int32", "description": "no of power managed machines which are in hibernate state at the time of aggregation" }, "PowerManagedMachinesOnWithSessions": { "type": "integer", "format": "int32", "description": "no of power managed machines which are on and have sessions at the time of aggregation" }, "PowerManagedMachinesOnWithoutSessions": { "type": "integer", "format": "int32", "description": "no of power managed machines which are on without having any sessions at the time of aggregation" }, "PowerManagedMachineMinutesTurnedOff": { "type": "integer", "format": "int32", "description": "total downtime (in minutes) of all power managed machine during the window of aggregation" }, "TotalScaleInActions": { "type": "integer", "format": "int32", "description": "total no of successful scale in (power off) actions during the window of aggregation" }, "TotalHibernateActions": { "type": "integer", "format": "int32", "description": "total no of successful hibernate actions during the window of aggregation" }, "TotalScaleOutActions": { "type": "integer", "format": "int32", "description": "total no of successful scale out (power on) actions during the window of aggregation" }, "TotalPeakConcurrentSessions": { "type": "integer", "format": "int32", "description": "max number of concurrent sessions during the window of aggregation" }, "AverageLogonDurationInSec": { "type": "integer", "format": "int32", "description": "average logon duration in seconds" }, "AveragePowerManagedMachinesCount": { "type": "integer", "format": "int32", "description": "no of power managed machines" }, "AverageMachineCostPerHour": { "type": "number", "format": "double", "description": "average machine cost per hour" }, "CostType": { "type": "integer", "format": "int32", "description": "The cost type associated with the given desktop group level summary. See enum [CostType](/en-us/monitor-service-odata-api/monitor-service-enums#costtype) for possible values." }, "CurrencyType": { "type": "integer", "format": "int32", "description": "The currency type associated with the given desktop group level summary. See enum [CurrencyType](/en-us/monitor-service-odata-api/monitor-service-enums#currencytype) for possible values." }, "TotalAmountSaved": { "type": "number", "format": "double", "description": "total amount saved during the window of aggregation" }, "TotalCostIfNoPowerManagement": { "type": "number", "format": "double", "description": "total cost that would have incurred if there is no powermanagement" }, "TotalAutoscaleComputeSavings": { "type": "number", "format": "double", "description": "total compute savings due to autoscale Actions" }, "TotalAutoscaleStorageSavings": { "type": "number", "format": "double", "description": "total storage savings due to autoscale Actions" }, "TotalEndUserComputeSavings": { "type": "number", "format": "double", "description": "total compute savings due to EndUser Actions" }, "TotalEndUserStorageSavings": { "type": "number", "format": "double", "description": "total storage savings due to EndUser Actions" }, "AverageComputeCostPerHour": { "type": "number", "format": "double", "description": "Average Compute Cost Per Hour" }, "AverageStorageCostPerHour": { "type": "number", "format": "double", "description": "Average Storage Cost Per Hour" }, "TotalComputeCost": { "type": "number", "format": "double", "description": "Total Compute Cost" }, "TotalStorageCost": { "type": "number", "format": "double", "description": "Total Storage Cost" }, "PowerManagedMachinesFailedWithoutSessions": { "type": "integer", "format": "int32", "description": "no of power managed machines which are in failed state without having any sessions at the time of aggregation" }, "PowerManagedMachinesUnregisteredWithSessions": { "type": "integer", "format": "int32", "description": "no of power managed machines which are in Unregistered state and sessions at the time of aggregation" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "foreign key reference for desktop group." } } }, "Citrix.Monitor.Model.MachineFailureLog": { "description": "Represents the accumulation of machine failures", "required": [ "Id", "FailureStartDate", "FaultState", "LastDeregisteredCode", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for machine failure log entry" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of the machine associated with the failure log entry" }, "FailureStartDate": { "type": "string", "format": "date-time", "description": "Failure start time." }, "FailureEndDate": { "type": "string", "format": "date-time", "description": "Failure end time." }, "FaultState": { "type": "integer", "format": "int32", "description": "Fault State of the machine See the enum MachineFaultStateCode for possible values" }, "LastDeregisteredCode": { "type": "integer", "format": "int32", "description": "Last deregistration reason for this machine See the enum DeregistrationReasonCode for possible values" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine associated with the failure log entry." } } }, "Citrix.Monitor.Model.MachineHotfixLog": { "description": "HotfixHistory class relates the machine and hotfixes installed/ removed", "required": [ "Id", "ChangeType", "CurrentState", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for each history entry" }, "MachineId": { "type": "string", "format": "uuid", "description": "Unique identifier of the machine a hotfix has been installed to or removed form." }, "HotfixId": { "type": "string", "format": "uuid", "description": "Unique identifier of the hotfix" }, "ChangeType": { "type": "integer", "format": "int32", "description": "Whether the hotfix was removed or added" }, "CurrentState": { "type": "boolean", "description": "Is the hotfix currently installed" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine associated with a hotfix." }, "Hotfix": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Hotfix", "description": "The hotfix associated with Machine." } } }, "Citrix.Monitor.Model.MachineMetric": { "description": "Machine-level resource metrics such as IOPS and latency for a particular machine, with its related machine.", "required": [ "CollectedDate", "Iops", "Latency" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this MachineMetric record is associated with" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "Iops": { "type": "integer", "format": "int64", "description": "Iops on the machine" }, "Latency": { "type": "number", "format": "double", "description": "Latency on the machine" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine this MachineMetric record is associated with." } } }, "Citrix.Monitor.Model.MachineMetricDaySummary": { "description": "Summary table for MachineMetric", "required": [ "SummaryDate", "AvgIops", "PeakIops", "AvgLatency" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) this Summary date represent" }, "AvgIops": { "type": "number", "format": "double", "description": "Average IOPS for given SummaryDate Eg: Lets say iops for this machine available at times 10:00,11:00,...,21:00 Lets say summary is calculated for every 1 DAY(i.e., granularity) SummaryDate will be DAY x 00:00 and Average will be calculated for above records" }, "PeakIops": { "type": "integer", "format": "int64", "description": "Peak IOPS given SummaryDate Eg: Lets say iops for this machine available at times 10:00,11:00,...,21:00 Lets say summary is calculated for every 1 DAY(i.e., granularity) SummaryDate will be DAY x 00:00 and Peak will be calculated for above records" }, "AvgLatency": { "type": "number", "format": "double", "description": "Average Latency on the machine for given SummaryDate" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." } } }, "Citrix.Monitor.Model.MachineSummary": { "description": "POCO object for machine rollup/summary per hour/day", "required": [ "Id", "SummaryDate", "PoweredOnMachinesCount", "RegisteredMachinesCount", "MachinesInMaintenanceModeCount", "MachinesCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Time stamp associated with this summary data" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of desktopgroup this summary is associated with" }, "PoweredOnMachinesCount": { "type": "integer", "format": "int32", "description": "Number of powered-on machines for this desktop group at the time of consolidation" }, "RegisteredMachinesCount": { "type": "integer", "format": "int32", "description": "Number of registered machines for this desktop group at the time of consolidation" }, "MachinesInMaintenanceModeCount": { "type": "integer", "format": "int32", "description": "Number of machines in maintenance mode for this desktop group at the time of consolidation" }, "MachinesCount": { "type": "integer", "format": "int32", "description": "Number of machines in this desktop group at the time of consolidation" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes Size of the time windows in minutes for this summary" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "DesktopGroup this summary is associated with." } } }, "Citrix.Monitor.Model.Pnaa.Notification": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the Notification." }, "FirstTimeConditionTrue": { "type": "string", "format": "date-time", "description": "first time in this cycle the condition for this rule was evaluated true" }, "FirstTimeNotificationTriggered": { "type": "string", "format": "date-time", "description": "first time in this cycle the condition was true and the waiting period had expired" }, "LastReannouncementTime": { "type": "string", "format": "date-time", "description": "last time this was reannounced" }, "LastTimeConditionTrue": { "type": "string", "format": "date-time", "description": "last time this was reannounced" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state of the notification as a NotificationLifecycle value (0=Unknown, 1=NotificationActive, 2=NotificationDismissed, 3=NotificationComplete), indicating whether the notification is active, dismissed, or complete." }, "NotificationRuleId": { "type": "integer", "format": "int64", "description": "foreign key to the NotificationRule instance explicitly included for PowerPivot functionality" }, "NotificationTargetId": { "type": "integer", "format": "int64", "description": "Active target tracked in this rule notification" }, "NotificationPriority": { "type": "integer", "format": "int32", "description": "Priority of the notification being referenced" }, "ScopeEntities": { "type": "string", "format": "string", "description": "Scope entities for this notification" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule", "description": "references the NotificationRule instance upon which this current notification is based." }, "NotificationTarget": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationTarget", "description": "Active target tracked in this rule notification." }, "NotificationLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationLog" }, "description": "List of historical notifications for this Notification" } }, "description": "A fired alert instance, created when a rule condition evaluates true for a target; tracks lifecycle through trigger and completion." }, "Citrix.Monitor.Model.Pnaa.NotificationActionEmail": { "required": [ "Id", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique Action Id" }, "CultureName": { "type": "string", "description": "Culture name to identify language to send emails in" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Action": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleAction", "description": "Action to which this action email belongs." }, "EmailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationEmailAddress" }, "description": "List of email addresses to send to for this action" }, "ServerConfiguration": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationEmailServerConfiguration", "description": "Server to send emails with." } }, "description": "Email action configuration linking a notification rule action to its recipient addresses and SMTP server settings." }, "Citrix.Monitor.Model.Pnaa.NotificationEmailAddress": { "required": [ "Id", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key for the email recipient record." }, "EmailAddress": { "type": "string", "description": "Recipient email address." }, "NotificationActionEmailId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent NotificationActionEmail (NotificationActionEmails entity)." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationActionEmail": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationActionEmail", "description": "Related entity, available via $expand=NotificationActionEmail." } }, "description": "A single notification email recipient address belonging to an email action." }, "Citrix.Monitor.Model.Pnaa.NotificationEmailServerConfiguration": { "required": [ "Id", "Port", "RequiresAuthentication", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationEmailServerConfiguration." }, "Protocol": { "type": "string", "description": "Mail protocol" }, "HostName": { "type": "string", "description": "Server address" }, "Port": { "type": "integer", "format": "int64", "description": "TCP port used to connect to the SMTP server." }, "Sender": { "type": "string", "description": "From address used when sending notification emails." }, "RequiresAuthentication": { "type": "boolean", "description": "Whether the server requires authentication" }, "UserName": { "type": "string", "description": "Mail UserName" }, "Site": { "type": "string", "description": "Mail UserName" }, "EncryptedPassword": { "type": "string", "description": "Encrypted password for the SMTP account used to send emails." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } }, "description": "SMTP server configuration for sending notification emails." }, "Citrix.Monitor.Model.Pnaa.NotificationLog": { "required": [ "Id", "NotificationState", "NotificationStateChangeDate", "IsReannouncement", "NotificationPriority", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the NotificationLog." }, "NotificationState": { "type": "integer", "format": "int32", "description": "state of this NotificationLog object" }, "NotificationStateChangeDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this notification state change occurred." }, "IsReannouncement": { "type": "boolean", "description": "IsReannouncement - will be true if this is a triggered event and it has been previously noted" }, "NotificationRuleId": { "type": "integer", "format": "int64", "description": "foreign key identifier to the NotificationRule explicitly included for PowerPivot functionality" }, "NotificationPriority": { "type": "integer", "format": "int32", "description": "Priority of the notification being referenced" }, "NotificationId": { "type": "string", "format": "uuid", "description": "foreign key identifier to the Notification object explicitly included for PowerPivot functionality" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule", "description": "navigation object reference to the NotificationRule." }, "Notification": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.Notification", "description": "references most current Notification instance that relates to this NotificationLog record." }, "NotificationTarget": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationTarget", "description": "Active target tracked in this rule notification." } }, "description": "Historical log entry for a notification state change (Began -> Pending -> Triggered -> Completed)." }, "Citrix.Monitor.Model.Pnaa.NotificationRule": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier (primary key) for the notification rule." }, "Enabled": { "type": "boolean", "format": "boolean", "description": "Whether this rule is active. When true the rule is evaluated by the alerting engine; when false it is retained but does not fire notifications." }, "IsAggregate": { "type": "boolean", "format": "boolean", "description": "Whether the rule's targets are evaluated in aggregate (true) or individually (false). When true the condition is checked across all targets together; when false it is checked per target." }, "Name": { "type": "string", "format": "string", "description": "Display name of the notification rule (for example, \"High CPU Alert\")." }, "Description": { "type": "string", "format": "string", "description": "Human-readable description of what this rule monitors." }, "NotificationTemplateId": { "type": "string", "format": "string", "description": "Text identifier of the condition template (defined in the Rule Template XML file) that this rule is based on. This is a text reference, not a database foreign key." }, "NotificationRuleGroupId": { "type": "integer", "format": "int64", "description": "Foreign key of the optional notification rule group that this rule belongs to." }, "DataSource": { "type": "integer", "format": "int32", "description": "Data source that this rule monitors, as a NotificationRuleDataSource value (0=Unknown, 1=Machines, 2=Sessions, 3=PVS, 4=StoreFront, 5=Delivery Controller, 6=Cloud Connector, 7=Connector Appliance, 8=SPA)." }, "ScopeType": { "type": "integer", "format": "int32", "description": "Scope at which the rule is applied, as a NotificationRuleScopeType value (0=Unknown, 1=DesktopGroup, 2=Site, 3=DirectorAgent, 4=PvsSite)." }, "NextDueAt": { "type": "string", "format": "date-time", "description": "Time at which this rule is next due for evaluation. Computed at runtime and not persisted to the database." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRuleParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleParameter" }, "description": "Collection of parameter values that configure this rule's condition (for example, threshold and duration)." }, "NotificationRuleTargets": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleTarget" }, "description": "Collection of targets (such as delivery groups or sites) that this rule evaluates." }, "NotificationRuleActions": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleAction" }, "description": "Collection of actions to run when this rule's condition is met (for example, sending an email)." }, "NotificationRuleGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleGroup", "description": "Optional group to which this belongs." } }, "description": "An alert policy definition (condition template, data source, scope, parameters, targets, and actions)." }, "Citrix.Monitor.Model.Pnaa.NotificationRuleAction": { "required": [ "Id", "NotificationRuleActionType", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationRuleAction." }, "Name": { "type": "string", "description": "Name of the notification rule action." }, "NotificationRuleActionType": { "type": "integer", "format": "int32", "description": "Type of NotificationAction" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRules": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule" }, "description": "List of NotificationRules that use this NotificationRuleAction" } }, "description": "An action to execute when a rule fires (currently Email)." }, "Citrix.Monitor.Model.Pnaa.NotificationRuleGroup": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationRuleGroup." }, "Name": { "type": "string", "format": "string", "description": "Name of the notification rule group (alert policy)." }, "Description": { "type": "string", "format": "string", "description": "Description of NotificationRule" }, "Webhook": { "type": "string", "format": "string", "description": "webhook URL for the NotificationRuleGroup" }, "IsSnmpEnabled": { "type": "boolean", "format": "boolean", "description": "The boolean value to check if SNMP is enabled" }, "IsEmailAttachmentEnabled": { "type": "boolean", "format": "boolean", "description": "The boolean value to check if email attachment is enabled" }, "IsWebhookAttachmentEnabled": { "type": "boolean", "format": "boolean", "description": "The boolean value to check if webhook attachment is enabled" }, "NotificationGroupState": { "type": "integer", "format": "int32", "description": "State of the notification group" }, "NotificationWebhookProfileId": { "type": "integer", "format": "int64", "description": "WebhookProfileId for the NotificationRuleGroup" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRules": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule" }, "description": "List of rules in the group" } }, "description": "Logical grouping of notification rules (an alert policy) with shared webhook/SNMP/email settings." }, "Citrix.Monitor.Model.Pnaa.NotificationRuleParameter": { "required": [ "Id", "NotificationRuleParameterType", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationRuleParameter." }, "TemplateParameterId": { "type": "string", "description": "TemplateParameterId A string representation of the text Id that references the template parameter Id in the Rule Template XML file This is not a database foreign key" }, "NotificationRuleParameterType": { "type": "integer", "format": "int32", "description": "indicates the datatype of the Value attribute" }, "Value": { "type": "string", "description": "string representation of the data for this parameter value" }, "NotificationRuleId": { "type": "integer", "format": "int64", "description": "foreign key identifier to the NotificationRule explicitly included for PowerPivot functionality" }, "NotificationRuleParameterChangeLogId": { "type": "integer", "format": "int64", "description": "Optional rule parameter change log" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule", "description": "navigation object reference to the NotificationRule." }, "NotificationRuleParameterChangeLog": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleParameterChangeLog", "description": "Optional rule parameter change log." } }, "description": "A single configurable value for a rule (threshold, interval, percentage), typed by parameter type." }, "Citrix.Monitor.Model.Pnaa.NotificationRuleParameterChangeLog": { "required": [ "Id", "ChangeTime", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationRuleParameterChangeLog." }, "ChangeTime": { "type": "string", "format": "date-time", "description": "When the change happened." }, "NotificationRuleId": { "type": "integer", "format": "int64", "description": "Parent rule id" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule", "description": "Parent rule." }, "NotificationRuleParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleParameter" }, "description": "List of parameters for this NotificationRule" } }, "description": "Audit-trail entry for rule parameter modifications (timestamp + snapshot of parameter values at change time)." }, "Citrix.Monitor.Model.Pnaa.NotificationRuleTarget": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationRuleTarget." }, "Name": { "type": "string", "format": "string", "description": "Name of the notification rule target." }, "NotificationRuleTargetType": { "type": "integer", "format": "int32", "description": "TargetType A string representation of the text Id that references the template in the Rule Template XML file This is not a database foreign key" }, "NotificationRuleId": { "type": "integer", "format": "int64", "description": "foreign key identifier to the NotificationRule explicitly included for PowerPivot functionality" }, "NotificationRuleSubTargetType": { "type": "integer", "format": "int32", "description": "Sub-target used to further scope the rule (NotificationRuleSubTargetType): 0=Unknown, 1=Machine, 2=DesktopGroup." }, "NotificationRuleApplyingFilterType": { "type": "integer", "format": "int32", "description": "Whether the sub-target is included or excluded (NotificationRuleApplyingFilterType): 0=Unknown, 1=Include, 2=Exclude." }, "NotificationRuleSubTargetValue": { "type": "string", "format": "string", "description": "Filter value identifying the sub-target object." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRuleTargetValues": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleTargetValue" }, "description": "List of target values for this NotificationRuleTarget" } }, "description": "A category of infrastructure objects a rule monitors; child target-values hold the object IDs." }, "Citrix.Monitor.Model.Pnaa.NotificationRuleTargetValue": { "required": [ "Id", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the NotificationRuleTargetValue" }, "Value": { "type": "string", "description": "Value portion of NotificationRuleTargetValue value pair" }, "NotificationRuleTargetId": { "type": "integer", "format": "int64", "description": "NotificationRuleTarget object with which this value is associated explicitly included for PowerPivot functionality" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "NotificationRuleTarget": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleTarget", "description": "references the NotificationRuleTarget instance to which this value belongs." } }, "description": "A single target object ID within a NotificationRuleTarget." }, "Citrix.Monitor.Model.Pnaa.NotificationSnmpConfiguration": { "required": [ "Id", "Port", "AuthPasswordProtocol", "PrivatePasswordProtocol", "Protocol", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationSnmpConfiguration." }, "HostName": { "type": "string", "description": "Server address" }, "Port": { "type": "integer", "format": "int32", "description": "Port on the SNMP trap receiver that traps are sent to." }, "Sender": { "type": "string", "description": "SNMP UserName" }, "AuthPassword": { "type": "string", "description": "Auth password" }, "PrivatePassword": { "type": "string", "description": "Privacy password" }, "AuthPasswordProtocol": { "type": "integer", "format": "int32", "description": "Auth Protocol used for encrypting" }, "PrivatePasswordProtocol": { "type": "integer", "format": "int32", "description": "Privacy protocol used for encryption" }, "EngineId": { "type": "string", "description": "SNMPv3 engine ID identifying the trap sender." }, "CommunityString": { "type": "string", "description": "community string" }, "Protocol": { "type": "integer", "format": "int32", "description": "snmp protocol" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } }, "description": "SNMP trap destination configuration (v2c community string, v3 auth/privacy passwords)." }, "Citrix.Monitor.Model.Pnaa.NotificationTarget": { "required": [ "Id", "NotificationRuleTargetType", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the NotificationTarget." }, "NotificationRuleTargetType": { "type": "integer", "format": "int32", "description": "TargetType A string representation of the text Id that references the template in the Rule Template XML file This is not a database foreign key" }, "NotificationId": { "type": "string", "format": "uuid", "description": "Foreign key to the Notification that this target belongs to. Explicitly included for PowerPivot functionality." }, "NotificationTargetValue": { "type": "string", "description": "Target Value" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Notification": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.Notification", "description": "navigation object reference to the NotificationRule." } }, "description": "The specific infrastructure object that triggered a Notification." }, "Citrix.Monitor.Model.Pnaa.NotificationWebhookProfile": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "webhook profile id" }, "Name": { "type": "string", "format": "string", "description": "Name of the webhook profile" }, "Description": { "type": "string", "format": "string", "description": "Description of the webhook profile" }, "Url": { "type": "string", "format": "string", "description": "Url of the webhook" }, "Headers": { "type": "string", "format": "string", "description": "all headers of the webhook" }, "PayloadFormat": { "type": "string", "format": "string", "description": "Payload format of the webhook" }, "MethodType": { "type": "string", "format": "string", "description": "Method Type of the webhook (post/put)" }, "Type": { "type": "integer", "format": "int32", "description": "Type of the webhook (api/webhook)" }, "Platform": { "type": "integer", "format": "int32", "description": "Type of the webhook platform (slack/msteams/servicenow/others)" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } }, "description": "Reusable webhook delivery configuration (static or custom key-value payloads)." }, "Citrix.Monitor.Model.ProbeDesktop": { "description": "Probe Desktop", "required": [ "Id", "LifecycleState", "LastModifiedDate" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the probe desktop." }, "DesktopBrokerId": { "type": "string", "description": "Desktop Broker Id" }, "DesktopName": { "type": "string", "description": "Name of the published desktop that can be targeted by desktop probes." }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Identifier of the delivery group (DesktopGroup) this desktop belongs to." }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state of the desktop (0=Active, 1=Deleted, 2=RequiresResolution, 3=Stub)." }, "LastModifiedDate": { "type": "string", "format": "date-time", "description": "Last modified Date" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The Delivery group this desktop is related to." }, "ProbeDesktops": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleDesktop" }, "description": "Contains mapping to the probe desktops" }, "ProbeLogsDesktop": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLogDesktop" }, "description": "Contains list of probe logs associated with the desktop" } } }, "Citrix.Monitor.Model.ProbeEndPoint": { "description": "ProbeEndPoint", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Unique identifier of the probe endpoint." }, "ClientAddress": { "type": "string", "format": "string", "description": "Client Address" }, "ClientName": { "type": "string", "format": "string", "description": "Display name of the Citrix Probe Agent endpoint machine." }, "Version": { "type": "string", "format": "string", "description": "Version of the Citrix Probe Agent installed on the endpoint." }, "LastActivity": { "type": "string", "format": "date-time", "description": "Timestamp of the endpoint's most recent heartbeat/activity." }, "TimezoneOffset": { "type": "integer", "format": "int32", "description": "Endpoint timezone offset from UTC, in minutes." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "ProbeRuleEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleEndPoint" }, "description": "Contains list of probe rules" }, "ProbeLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLog" }, "description": "Contains list of probe logs" }, "ProbeLogsDesktop": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLogDesktop" }, "description": "Contains list of desktop probe logs" } } }, "Citrix.Monitor.Model.ProbeLog": { "description": "A single application probe execution log; one row per application launch attempt run from a probe endpoint during an application probe.", "required": [ "Id", "ProbeStartTime", "EndPointId", "ProbeLogResult", "PendingSessionMapping", "CreatedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the probe log entry." }, "UserName": { "type": "string", "description": "User identity under which the probe was executed." }, "ProbeStartTime": { "type": "string", "format": "date-time", "description": "UTC time at which the probe run started." }, "EndPointId": { "type": "integer", "format": "int32", "description": "Identifier of the probe endpoint (ProbeEndPoint) that ran this probe." }, "RuleId": { "type": "integer", "format": "int32", "description": "Identifier of the probe rule this log belongs to; null for ad-hoc runs." }, "ApplicationId": { "type": "string", "format": "uuid", "description": "Application Id" }, "ProbeLogResult": { "type": "boolean", "description": "Probe Log Result" }, "PendingSessionMapping": { "type": "boolean", "description": "Pending Session Mapping Bit" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Identifier of the session mapped to this probe run; null until the session is mapped." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date" }, "ProbeEndPoint": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeEndPoint", "description": "Contains mapping to the probe End point." }, "ProbeRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRule", "description": "Contains mapping to the Probe Rule." }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Contains mapping to the Session." }, "Application": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Application", "description": "Contains mapping to the Application." }, "ProbeResults": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeResult" }, "description": "Contains mapping to the probe rules" } } }, "Citrix.Monitor.Model.ProbeLogDesktop": { "description": "Probe Log Desktop", "required": [ "Id", "ProbeStartTime", "EndPointId", "DesktopId", "ProbeLogResult", "PendingSessionMapping", "CreatedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the desktop probe log entry." }, "UserName": { "type": "string", "description": "User identity under which the desktop probe was executed." }, "ProbeStartTime": { "type": "string", "format": "date-time", "description": "UTC time at which the desktop probe run started." }, "EndPointId": { "type": "integer", "format": "int32", "description": "Identifier of the probe endpoint (ProbeEndPoint) that ran this desktop probe." }, "RuleId": { "type": "integer", "format": "int32", "description": "Identifier of the probe rule this log belongs to; null for ad-hoc runs." }, "DesktopId": { "type": "string", "format": "uuid", "description": "Identifier of the probe desktop (ProbeDesktop) targeted by this probe run." }, "ProbeLogResult": { "type": "boolean", "description": "Probe Log Result" }, "PendingSessionMapping": { "type": "boolean", "description": "Pending Session Mapping Bit" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Identifier of the session mapped to this probe run; null until the session is mapped." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date" }, "ProbeEndPoint": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeEndPoint", "description": "Contains mapping to the probe End point." }, "ProbeRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRule", "description": "Contains mapping to the Probe Rule." }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Contains mapping to the Session." }, "Desktop": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeDesktop", "description": "Contains mapping to the desktop." }, "ProbeResultDesktops": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeResultDesktop" }, "description": "Contains mapping to the probe rules" } } }, "Citrix.Monitor.Model.ProbeResult": { "description": "Probe Result", "required": [ "Id", "StageId", "StageResult", "StageTimeTaken", "CreatedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the probe result record." }, "ProbeLogId": { "type": "integer", "format": "int64", "description": "Application Probe Log Key" }, "StageId": { "type": "integer", "format": "int32", "description": "Identifier of the probe stage (ProbeStage) this result corresponds to." }, "StageResult": { "type": "boolean", "description": "Stage Result" }, "StageLog": { "type": "string", "description": "Diagnostic log output or error message produced during this probe stage." }, "StageTimeTaken": { "type": "integer", "format": "int32", "description": "Stage Time Taken" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date" }, "ProbeStage": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeStage", "description": "Contains mapping to the probe stage." }, "ProbeLog": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLog", "description": "Contains mapping to the probe log." } } }, "Citrix.Monitor.Model.ProbeResultDesktop": { "description": "Probe Result", "required": [ "Id", "ProbeLogId", "StageId", "StageResult", "StageTimeTaken", "CreatedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the desktop probe result record." }, "ProbeLogId": { "type": "integer", "format": "int64", "description": "Desktop Probe Log Key" }, "StageId": { "type": "integer", "format": "int32", "description": "Identifier of the probe stage (ProbeStage) this desktop probe result corresponds to." }, "StageResult": { "type": "boolean", "description": "Stage Result" }, "StageLog": { "type": "string", "description": "Diagnostic log output or error message produced during this desktop probe stage." }, "StageTimeTaken": { "type": "integer", "format": "int32", "description": "Stage Time Taken" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date" }, "ProbeStage": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeStage", "description": "Contains mapping to the probe stage." }, "ProbeLogDesktop": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLogDesktop", "description": "Contains mapping to the probe log." } } }, "Citrix.Monitor.Model.ProbeRule": { "description": "A configured probe rule that schedules automated application or desktop launch tests, defining the execution schedule, targets, and notification settings.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Unique identifier of the probe rule." }, "Name": { "type": "string", "format": "string", "description": "Display name of the probe rule." }, "Description": { "type": "string", "format": "string", "description": "Human-readable description of the probe rule." }, "ExecutionTime": { "type": "string", "format": "date-time", "description": "Execution Time" }, "ProbeType": { "type": "integer", "format": "int32", "description": "Type of probe the rule runs (for example, application vs. desktop)." }, "EmailAddress": { "type": "string", "format": "string", "description": "Email Address" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state of the probe rule (for example, active or deleted)." }, "ExecutionEndTime": { "type": "string", "format": "date-time", "description": "End Time of the probe repetition" }, "Days": { "type": "integer", "format": "int32", "description": "Days on which the scheduled probe must be run" }, "RepeatInterval": { "type": "integer", "format": "int32", "description": "Repeat interval duration of probe" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "ProbeRuleEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleEndPoint" }, "description": "Contains list of probe endpoints" }, "ProbeRuleApplications": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleApplication" }, "description": "Contains list of probe applications with the rule" }, "ProbeLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLog" }, "description": "Contains list of probe logs with the rule" }, "ProbeRuleDesktops": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleDesktop" }, "description": "Contains list of probe desktop with the rule" }, "ProbeLogsDesktop": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLogDesktop" }, "description": "Contains list of probe logs desktop with the rule" } } }, "Citrix.Monitor.Model.ProbeRuleApplication": { "description": "Probe Rule Application", "required": [ "RuleId" ], "type": "object", "properties": { "RuleId": { "type": "integer", "format": "int32", "description": "Identifier of the probe rule (ProbeRule) this application mapping belongs to." }, "ApplicationId": { "type": "string", "format": "uuid", "description": "Application Id" }, "ProbeRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRule", "description": "Contains mapping to the probe rule." }, "Application": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Application", "description": "Contains mapping to the probe application." } } }, "Citrix.Monitor.Model.ProbeRuleDesktop": { "description": "Probe Rule Desktop", "required": [ "RuleId", "DesktopId" ], "type": "object", "properties": { "RuleId": { "type": "integer", "format": "int32", "description": "Identifier of the probe rule (ProbeRule) this desktop mapping belongs to." }, "DesktopId": { "type": "string", "format": "uuid", "description": "Identifier of the probe desktop (ProbeDesktop) mapped to the rule." }, "ProbeRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRule", "description": "Contains mapping to the probe rule." }, "Desktop": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeDesktop", "description": "Contains mapping to the probe desktop." } } }, "Citrix.Monitor.Model.ProbeRuleEndPoint": { "description": "Probe Rule Target", "required": [ "RuleId", "EndPointId" ], "type": "object", "properties": { "RuleId": { "type": "integer", "format": "int32", "description": "Identifier of the probe rule (ProbeRule) this endpoint mapping belongs to." }, "EndPointId": { "type": "integer", "format": "int32", "description": "Identifier of the probe endpoint (ProbeEndPoint) mapped to the rule." }, "ProbeRule": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRule", "description": "Rule that the target is mapped to." }, "ProbeEndPoint": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeEndPoint", "description": "Rule that the end point is mapped to." } } }, "Citrix.Monitor.Model.ProbeStage": { "description": "A named stage/step within a probe run's lifecycle (for example, StorefrontReachable, IcaFileDownload, ApplicationLaunch).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Unique identifier of the probe stage; matches the ProbeStageName enum value (0=All, 1=StorefrontReachable, 2=StorefrontAuthentication, 3=StorefrontEnumeration, 4=IcaFileDownload, 5=ApplicationLaunch, 6=AnyFailure)." }, "Name": { "type": "string", "description": "Display name of the probe stage." }, "ProbeResults": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeResult" }, "description": "Contains mapping to the probe result" }, "ProbeResultsDesktop": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeResultDesktop" }, "description": "Contains mapping to the Desktop probe result" } } }, "Citrix.Monitor.Model.ProcessDataLimitedMachines": { "description": "A machine that is configured to collect and send per-process resource utilization data.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Unique identifier for the Process Data Limited Machines" }, "LastModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was modified last time" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." } } }, "Citrix.Monitor.Model.ProcessInfo": { "description": "A process instance running on a machine, with its related machine, session, and process utilization summaries.", "required": [ "ProcessKey", "ProcessId" ], "type": "object", "properties": { "ProcessKey": { "type": "integer", "format": "int32", "description": "Composite key part. Surrogate key that uniquely identifies this process instance." }, "ProcessId": { "type": "integer", "format": "int32", "description": "Operating system process identifier (PID)." }, "ProcessName": { "type": "string", "description": "Executable name of the process (e.g., \"chrome.exe\")." }, "ProcessCreationDate": { "type": "string", "format": "date-time", "description": "Date this process was created" }, "ApplicationName": { "type": "string", "description": "Published application name associated with this process, if any." }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this ProcessInfo record is associated with" }, "SessionId": { "type": "string", "format": "uuid", "description": "FK to Sessions. Null for system-level processes not tied to a user session." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine this ResourceUtilization record is associated with." }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "The session this ResourceUtilization record is associated with." }, "ProcessUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilization" }, "description": "ProcessUtilization values associated with this process" }, "ProcessUtilizationMinuteSummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilizationMinuteSummary" }, "description": "ProcessUtilizationMinuteSummary values associated with this process" }, "ProcessUtilizationHourSummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilizationHourSummary" }, "description": "ProcessUtilizationHourSummary values associated with this process" }, "ProcessUtilizationDaySummary": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessUtilizationDaySummary" }, "description": "ProcessUtilizationDaySummary values associated with this process" } } }, "Citrix.Monitor.Model.ProcessUtilization": { "description": "Per-process CPU and memory utilization readings for a sampling interval, with its related process and machine.", "required": [ "CollectedDate", "ProcessKey", "PercentCpu", "PercentMemory" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ProcessKey": { "type": "integer", "format": "int32", "description": "Composite key part. FK to Processes identifying the process instance." }, "PercentCpu": { "type": "number", "format": "double", "description": "CPU usage for this process as a percentage (0-100)." }, "PercentMemory": { "type": "number", "format": "double", "description": "Memory usage for this process as a percentage (0-100)." }, "ProcessInfo": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessInfo", "description": "The machine this ProcessUtilization record is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." } } }, "Citrix.Monitor.Model.ProcessUtilizationDaySummary": { "description": "Day level Summary table for ProcessUtilization", "required": [ "SummaryDate", "ProcessKey", "AvgPercentCpu", "PeakPercentCpu", "AvgPercentMemory", "PeakPercentMemory" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) this Summary date represent" }, "ProcessKey": { "type": "integer", "format": "int32", "description": "Composite key part. FK to Processes identifying the process instance." }, "AvgPercentCpu": { "type": "number", "format": "double", "description": "Average percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentCpu": { "type": "number", "format": "double", "description": "Peak percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "AvgPercentMemory": { "type": "number", "format": "double", "description": "Average of Memory used for given SummaryDate Eg: Lets say memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentMemory": { "type": "number", "format": "double", "description": "Peak of Memory used for given SummaryDate Eg: Lets say Memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "ProcessInfo": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessInfo", "description": "The machine this ProcessUtilizationDaySummary record is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." } } }, "Citrix.Monitor.Model.ProcessUtilizationHourSummary": { "description": "Hour level Summary table for ProcessUtilization", "required": [ "SummaryDate", "ProcessKey", "AvgPercentCpu", "PeakPercentCpu", "AvgPercentMemory", "PeakPercentMemory" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) this Summary date represent" }, "ProcessKey": { "type": "integer", "format": "int32", "description": "Composite key part. FK to Processes identifying the process instance." }, "AvgPercentCpu": { "type": "number", "format": "double", "description": "Average percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentCpu": { "type": "number", "format": "double", "description": "Peak percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "AvgPercentMemory": { "type": "number", "format": "double", "description": "Average of Memory used for given SummaryDate Eg: Lets say memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentMemory": { "type": "number", "format": "double", "description": "Peak of Memory used for given SummaryDate Eg: Lets say Memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "ProcessInfo": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessInfo", "description": "The machine this ProcessUtilizationHourSummary record is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." } } }, "Citrix.Monitor.Model.ProcessUtilizationMinuteSummary": { "description": "Minute level Summary table for ProcessUtilization", "required": [ "SummaryDate", "ProcessKey", "AvgPercentCpu", "PeakPercentCpu", "AvgPercentMemory", "PeakPercentMemory" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) this Summary date represent" }, "ProcessKey": { "type": "integer", "format": "int32", "description": "Composite key part. FK to Processes identifying the process instance." }, "AvgPercentCpu": { "type": "number", "format": "double", "description": "Average percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentCpu": { "type": "number", "format": "double", "description": "Peak percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "AvgPercentMemory": { "type": "number", "format": "double", "description": "Average of Memory used for given SummaryDate Eg: Lets say memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentMemory": { "type": "number", "format": "double", "description": "Peak of Memory used for given SummaryDate Eg: Lets say Memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "ProcessInfo": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessInfo", "description": "The machine this ProcessUtilizationMinuteSummary record is associated with." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." } } }, "Citrix.Monitor.Model.PublishedDesktopName": { "description": "Lookup table mapping published desktop IDs to their display names.", "required": [ "Id", "PublishedName" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the PublishedDesktopName" }, "PublishedName": { "type": "string", "description": "The name of the published desktop" }, "Sessions": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "description": "List of sessions for this DesktopName" } } }, "Citrix.Monitor.Model.ResourceUtilization": { "description": "New added ResourceUtilization View to union ResourceUtilization table and ResourceUtilizationViewV2 table.", "required": [ "CollectedDate", "MachineId" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Guid of machine this ResourceUtilization record is associated with" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "PercentCpu": { "type": "number", "format": "double", "description": "CPU utilization in percent" }, "UsedMemory": { "type": "number", "format": "double", "description": "Memory utilization in bytes" }, "TotalMemory": { "type": "number", "format": "double", "description": "Total memory in bytes" }, "SessionCount": { "type": "", "format": "", "description": "Number of sessions" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was inserted in the database" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was modifed in the database" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of DesktopGroup this ResourceUtilization record is associated with" }, "AvgIcaRttInMs": { "type": "", "format": "", "description": "Average ICA RTT in milliseconds" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "The machine this ResourceUtilization record is associated with." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The desktop group this ResourceUtilization record is associated with." } } }, "Citrix.Monitor.Model.ResourceUtilizationSummary": { "description": "Summary table for ResourceUtilization", "required": [ "Granularity", "MachineId", "SummaryDate" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "Granularity": { "type": "", "format": "", "description": "Granularity of this summary item in minutes (how many minutes of data included in this time slot)" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) this Summary date represent" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of DesktopGroup this ResourceUtilizationSummary record is associated with" }, "AvgPercentCpu": { "type": "number", "format": "double", "description": "Average percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentCpu": { "type": "number", "format": "double", "description": "Peak percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "AvgUsedMemory": { "type": "number", "format": "double", "description": "Average of Memory used for given SummaryDate Eg: Lets say memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakUsedMemory": { "type": "number", "format": "double", "description": "Peak of Memory used for given SummaryDate Eg: Lets say Memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Peak will be the highest value of above 10 records" }, "AvgTotalMemory": { "type": "number", "format": "double", "description": "Total Memory available with Machine" }, "TotalSessionCount": { "type": "", "format": "", "description": "Total sessions running for given SummaryDate" }, "AvgIcaRttInMs": { "type": "", "format": "", "description": "Average ICA RTT in milliseconds" }, "AvgLogOnDurationInMs": { "type": "integer", "format": "int32", "description": "Average logon duration in milliseconds" }, "UptimeInMinutes": { "type": "", "format": "", "description": "Uptime of the power managed machine in minutes" }, "UpTimeWithoutSessionInMinutes": { "type": "", "format": "", "description": "The time in minutes that machine is up without session" }, "DisconnectTimeInMinutes": { "type": "", "format": "", "description": "The time in minutes that machine has session but without connection" }, "IdleTimeInMinutes": { "type": "", "format": "", "description": "The time in minutes that session is idle" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The DesktopGroup this ResourceUtilizationSummary record is associated with." } } }, "Citrix.Monitor.Model.ServerOSDesktopSummary": { "description": "Time-windowed multi-session (Server OS) desktop usage per Delivery Group and machine.", "required": [ "Id", "SummaryDate", "PeakConcurrentInstanceCount", "TotalUsageDuration", "TotalLaunchesCount", "StartingInstanceCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the ServerOSDesktopSummary instance" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) that this summary data represents" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of the Desktop" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of the DesktopGroupId this machine belongs to." }, "PeakConcurrentInstanceCount": { "type": "integer", "format": "int32", "description": "Peak number of concurrent desktop sessions (distinct SessionKey) on this multi-session (Server OS) machine during the time slot." }, "TotalUsageDuration": { "type": "number", "format": "double", "description": "Total desktop session usage in seconds (sum of each session's active duration) on this machine for the time slot. Value is in seconds, not milliseconds." }, "TotalLaunchesCount": { "type": "integer", "format": "int32", "description": "Number of desktop sessions that started on this machine during the time slot." }, "StartingInstanceCount": { "type": "integer", "format": "int32", "description": "Number of desktop sessions already running on this machine at the start of the summary window (see SummaryDate)." }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes (how many minutes of data included in this time slot)" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine associated this session." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The session associated with the application." } } }, "Citrix.Monitor.Model.Session": { "description": "Represents a user connected to a desktop.", "required": [ "SessionKey" ], "type": "object", "properties": { "SessionKey": { "type": "string", "format": "uuid", "description": "Broker-assigned SessionKey for this Session" }, "StartDate": { "type": "string", "format": "date-time", "description": "Time the session started (logon)" }, "LogOnDuration": { "type": "integer", "format": "int32", "description": "Total log on duration for this session" }, "EndDate": { "type": "string", "format": "date-time", "description": "Time the session ended (logoff)" }, "ExitCode": { "type": "integer", "format": "int32", "description": "Session termination exit code" }, "FailureId": { "type": "integer", "format": "int64", "description": "Id of the associated Failure (null if no failure)" }, "FailureDate": { "type": "string", "format": "date-time", "description": "If the connection failed, the time the failure occurred. Otherwise, null" }, "ConnectionState": { "type": "integer", "format": "int32", "description": "Connection State for the session. See the enum ConnectionState for possible values" }, "SessionIdleTime": { "type": "string", "format": "date-time", "description": "Session idle time since" }, "ConnectionStateChangeDate": { "type": "string", "format": "date-time", "description": "Date of last connection state change" }, "LifecycleState": { "type": "integer", "format": "int32", "description": "Lifecycle state for the Session. Used internally for tracking and management. See the enum LifecycleState for possible values." }, "CurrentConnectionId": { "type": "integer", "format": "int64", "description": "Id of the connection record currently associated with this session. May be null when session is disconnected." }, "UserId": { "type": "integer", "format": "int64", "description": "Id of User entry for the user logged on to this session" }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of the Machine this session is running on." }, "SessionType": { "type": "integer", "format": "int32", "description": "Determines if this session is from an application/ desktop. See SessionType enum for possible values" }, "IsAnonymous": { "type": "boolean", "format": "boolean", "description": "Defines whether a session is anonymous or not" }, "PublishedDesktopId": { "type": "integer", "format": "int64", "description": "Id of publishedDesktopName which is used to launch this session" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Failure": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VShared.ConnectionFailureCategory", "description": "Information on how the session failed (null if no failure)." }, "CurrentConnection": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Connection", "description": "Connection record currently associated with this session." }, "User": { "$ref": "#/components/schemas/Citrix.Monitor.Model.User", "description": "User for the user logged on to this session." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Machine this session is running on." }, "Connections": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Connection" }, "description": "Connections (current and past) associated with this session." }, "ConnectionFailureLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectionFailureLog" }, "description": "Connection failures (current and past) associated with this session." }, "SessionMetrics": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionMetrics" }, "description": "SessionMetricsView values associated with this session" }, "Processes": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessInfo" }, "description": "ProcessInfo object associated with this session" }, "ApplicationInstances": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationInstance" }, "description": "Application related to this session (if SessionType is 'Application')" }, "ApplicationFaults": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationFault" }, "description": "Application faults associated wth this session" }, "ApplicationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationError" }, "description": "Application errors associated wth this session" }, "ProbeLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLog" }, "description": "Contains mapping to the probe log for that session" }, "LogOnMetrics": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LogOnMetric" }, "description": "Contains mapping to the logon metric for that session" }, "ProbeLogsDesktop": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLogDesktop" }, "description": "Contains mapping to the desktop probe log for that session" }, "SessionAutoReconnects": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionAutoReconnect" }, "description": "Contains mapping to the session auto-reconnects for that session" }, "SessionRecordingServer": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionRecordingServer", "description": "Contains mapping to the session recording for that session." }, "PublishedDesktopName": { "$ref": "#/components/schemas/Citrix.Monitor.Model.PublishedDesktopName", "description": "PublishedDesktopName." }, "SessionMetricsLatest": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionMetricsLatest", "description": "Latest metrics for that session." } } }, "Citrix.Monitor.Model.SessionActivitySummary": { "description": "POCO object for session activity consolidation", "required": [ "Id", "SummaryDate", "ConnectedSessionCount", "DisconnectedSessionCount", "ConcurrentSessionCount", "TotalLogOnDuration", "TotalLogOnCount", "Granularity", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the session summary" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Timestamp of the beginning of the time window that this summary data represents" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of the desktop group this entry is associated with" }, "ConnectedSessionCount": { "type": "integer", "format": "int32", "description": "Number of maximum connected sessions for this desktop group for the time window specified" }, "DisconnectedSessionCount": { "type": "integer", "format": "int32", "description": "Number of maximum disconnected sessions for this desktop group for the time window specified" }, "ConcurrentSessionCount": { "type": "integer", "format": "int32", "description": "Number of maximum concurrent sessions for this desktop group for the minute specified" }, "TotalLogOnDuration": { "type": "number", "format": "double", "description": "Total logon duration in milliseconds for all logons in this desktop group for the time window specified" }, "TotalLogOnCount": { "type": "integer", "format": "int32", "description": "Total number of logons in this desktop group for the time window specified" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of the time window associated with this summary item in minutes (how many minutes of data included in this record)" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The DesktopGroup this entry is associated with." } } }, "Citrix.Monitor.Model.SessionAutoReconnect": { "description": "Session Auto Reconnect class", "required": [ "Id", "SessionKey", "ConnectionId", "AutoReconnectCount", "AutoReconnectType", "EventTimestamp", "CreatedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier to store ID" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Foreign key reference to session" }, "ConnectionId": { "type": "integer", "format": "int64", "description": "Contains the Connection Id" }, "AutoReconnectCount": { "type": "integer", "format": "int32", "description": "Auto-Reconnect Count for a payload" }, "AutoReconnectType": { "type": "integer", "format": "int32", "description": "Auto-Reconnect Type" }, "EventTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp of the reconnect event" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date of the record" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Contains mapping to the session." } } }, "Citrix.Monitor.Model.SessionMetrics": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Autogenerated id for Session Metrics record" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was collected from source" }, "IcaRttMS": { "type": "integer", "format": "int32", "description": "ICA round-trip time in milliseconds (client to VDA). Healthy values are under 100 ms." }, "IcaLatency": { "type": "integer", "format": "int32", "description": "One-way ICA (session) latency in milliseconds. Null on older VDAs." }, "ClientL7Latency": { "type": "integer", "format": "int32", "description": "WClient L7 latency (WAN Latency)" }, "ServerL7Latency": { "type": "integer", "format": "int32", "description": "Server L7 latency (DC Latency)" }, "SessionId": { "type": "string", "format": "uuid", "description": "Unique identifier (GUID) of the session." }, "ConnectionState": { "type": "", "format": "", "description": "Session State" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "The session this SessionMetrics record is associated with." } }, "description": "New added SessionMetrics View to union SessionMetrics table and SessionMetricsV2 table." }, "Citrix.Monitor.Model.SessionMetricsLatest": { "description": "The most recent (current) HDX/ICA connection-quality metrics for each active session - one row per session, keyed by SessionKey and updated in place as new measurements arrive, so it always reflects the latest values. Use this entity for real-time (live) dashboards that show what sessions are experiencing right now, such as latency, round-trip time, and throughput. For the historical time-series of these metrics over a session's lifetime, query the SessionMetrics entity instead.", "required": [ "SessionKey" ], "type": "object", "properties": { "SessionKey": { "type": "string", "format": "uuid", "description": "Unique identifier (GUID) of the session." }, "ClientL7Latency": { "type": "integer", "format": "int32", "description": "Client L7 latency (WAN Latency)" }, "ClientPacketRetransmit": { "type": "integer", "format": "int32", "description": "Packet retransmits on client side connection" }, "ClientRetransmitClientDropPercent": { "type": "number", "format": "double", "description": "Client sent, dropped on client-side hop percentage" }, "ClientRetransmitServerDropPercent": { "type": "number", "format": "double", "description": "Client sent, dropped on server-side hop percentage" }, "CloudConnectorName": { "type": "string", "format": "string", "description": "Cloud Connector Name" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "DcLatency": { "type": "integer", "format": "int32", "description": "Datacenter-segment network latency in milliseconds, derived from SD-WAN. Null if no SD-WAN." }, "EdtMtu": { "type": "string", "format": "string", "description": "The Maximum Transmission Unit (MTU) of the EDT protocol" }, "GatewayIP": { "type": "string", "format": "string", "description": "IP address of the gateway if used for the session" }, "GatewayPopName": { "type": "string", "format": "string", "description": "Gateway Service PoP name" }, "GatewayType": { "type": "integer", "format": "int32", "description": "Type of gateway associated with the current session. Null = No gateway is associated 0 = Unknown 1 = Gateway 2 = GatewayService" }, "HdxConnectionType": { "type": "integer", "format": "int32", "description": "HDX connection type (HDX, HDXDirect, Rendezvous)" }, "HdxProtocolName": { "type": "string", "format": "string", "description": "The name of the HDX protocol." }, "IcaLatency": { "type": "integer", "format": "int32", "description": "One-way ICA (session) latency in milliseconds. Null on older VDAs." }, "IcaRttMS": { "type": "integer", "format": "int32", "description": "ICA Round Trip Time (RTT) in milliseconds" }, "InputFPS": { "type": "integer", "format": "int32", "description": "Input frames per second (FPS) for the session" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "OutputBandwidthAvailable": { "type": "integer", "format": "int64", "description": "Output bandwidth available for the session" }, "OutputBandwidthUsed": { "type": "integer", "format": "int64", "description": "Output bandwidth used for the session" }, "OutputFPS": { "type": "integer", "format": "int32", "description": "Output frames per second (FPS) for the session" }, "ServerL7Latency": { "type": "integer", "format": "int32", "description": "Server L7 latency (DC Latency)" }, "ServerPacketRetransmit": { "type": "integer", "format": "int32", "description": "Packet retransmits on server side connection" }, "ServerRetransmitClientDropPercent": { "type": "number", "format": "double", "description": "Server sent, dropped on client-side hop percentage" }, "ServerRetransmitServerDropPercent": { "type": "number", "format": "double", "description": "Server sent, dropped on server-side hop percentage" }, "SslProxyHost": { "type": "string", "format": "string", "description": "SSL proxy host used for this session. Null if not reported." }, "Throughput": { "type": "integer", "format": "int64", "description": "Throughput, unit: bps" }, "WanLatency": { "type": "integer", "format": "int32", "description": "WAN-segment network latency in milliseconds, derived from SD-WAN. Null if no SD-WAN." }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "GatewayPopInfo": { "$ref": "#/components/schemas/Citrix.Monitor.DataService.Model.GatewayPopInfo" } } }, "Citrix.Monitor.DataService.V4.SessionLogonMetrics": { "required": [ "SessionKey" ], "type": "object", "properties": { "SessionKey": { "type": "string", "format": "uuid", "description": "Guid of Session this metrics belongs to" }, "AppxLoadPackages": { "type": "string", "format": "string", "description": "Appx Load Packages" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Record creation timestamp (UTC)." }, "DiskCapacity": { "type": "integer", "format": "int64", "description": "The Disk Capacity in Giga bytes" }, "DiskSizeUsed": { "type": "integer", "format": "int64", "description": "The Profile Container Disk Size Used in Giga bytes" }, "DiskType": { "type": "string", "format": "string", "description": "Disk Type (VHD, VHDX)" }, "FilesCount": { "type": "integer", "format": "int32", "description": "Total Files Count" }, "GPORecords": { "type": "string", "format": "string", "description": "JSON of the Group Policy Objects (GPOs) processed during logon, including per-GPO processing times." }, "LargeFilesCount": { "type": "integer", "format": "int32", "description": "Large Files Count" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Last update timestamp (UTC)." }, "ProfileSize": { "type": "integer", "format": "int64", "description": "Profile Size in Giga bytes" }, "ProfileType": { "type": "string", "format": "string", "description": "Profile Type (FSLogix, CPM file-based, CPM container, Other)" }, "ProfileVersion": { "type": "string", "format": "string", "description": "Profile Version" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Session this logon metrics was created from." }, "GatewayPopInfo": { "$ref": "#/components/schemas/Citrix.Monitor.Model.GatewayPopInfo", "description": "Related entity, available via $expand=GatewayPopInfo." } }, "description": "Profile and logon-phase metadata captured once per session. Contains FSLogix/CPM profile details and GPO records." }, "Citrix.Monitor.Model.SessionRecordingServer": { "description": "Maps recorded sessions to the Session Recording Server that captured them.", "required": [ "SessionKey", "SessionRecordingServerName", "CreatedDate" ], "type": "object", "properties": { "SessionKey": { "type": "string", "format": "uuid", "description": "Unique identifier (GUID) of the session." }, "SessionRecordingServerName": { "type": "string", "description": "The name of the sessionRecordingServer" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "The created date of the entry" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session", "description": "Actual Session object." } } }, "Citrix.Monitor.Model.TaskLog": { "description": "Represents the task execution log", "required": [ "Id", "RunDate", "TaskCategory", "Task", "Result", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for TaskLog entry" }, "RunDate": { "type": "string", "format": "date-time", "description": "Time stamp indicating when the task was started" }, "TaskCategory": { "type": "integer", "format": "int32", "description": "Category of the task run. See the TaskCategory enum for possible values" }, "Task": { "type": "integer", "format": "int32", "description": "Numeric identifier of the specific data-management task that was run." }, "Result": { "type": "integer", "format": "int32", "description": "Result from having run the task. See the TaskResult enum for possible values" }, "ErrorMessage": { "type": "string", "description": "Empty if task ran successsfully, otherwise a string describing the error that occurred." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.User": { "description": "Represents a user in the system. A user identity that has launched sessions in the site.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the User" }, "Sid": { "type": "string", "format": "string", "description": "Security Identifier for the user." }, "Upn": { "type": "string", "format": "string", "description": "User Principal Name - has two parts: the UPN prefix (the user account name) and the UPN suffix (a DNS domain name). The parts are joined together by the at sign (@) symbol to make the complete UPN. Broker name: AssociatedUserUpns DesktopDirector name: UserUpn" }, "UserName": { "type": "string", "format": "string", "description": "Username in the form of DOMAIN\\UserName" }, "FullName": { "type": "string", "format": "string", "description": "Full name of the user." }, "Domain": { "type": "string", "format": "string", "description": "Domain the user is associated with" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Sessions": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "description": "List of past and present sessions for this User" }, "ConnectionFailureLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectionFailureLog" }, "description": "List of past and present connectionfailuress for this User" } } }, "Citrix.Monitor.Model.UserResourceUtilizationSummary": { "description": "Summary table for UserResourceUtilization", "required": [ "DesktopGroupId", "Granularity", "MachineId", "SummaryDate", "UserId" ], "type": "object", "properties": { "Granularity": { "type": "", "format": "", "description": "Granularity of this summary item in minutes (how many minutes of data included in this time slot)" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Beginning timeslot (to the minute) this Summary date represent" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of DesktopGroup this UserResourceUtilizationSummary record is associated with" }, "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "UserId": { "type": "integer", "format": "int64", "description": "User unique id" }, "AvgSessionDurationInMins": { "type": "", "format": "", "description": "Average duration of all sessions in minutes" }, "SessionType": { "type": "", "format": "", "description": "Type of session (e.g., desktop, application)" }, "PeakPercentCpu": { "type": "", "format": "", "description": "Peak percentage of CPU for given SummaryDate Eg: Lets say CPU for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "PeakPercentMemory": { "type": "", "format": "", "description": "Peak percentage of Memory for given SummaryDate Eg: Lets say memory for this machine available at times 10:00,10:01,...,10:09 Lets say summary is calculated for every 10 minutes(i.e., granularity) SummaryDate will be 10:00 and Average will be calculated for above 10 records" }, "TotalSessionCount": { "type": "", "format": "", "description": "Total sessions running for given SummaryDate" }, "Users": { "$ref": "#/components/schemas/Citrix.Monitor.Model.User", "description": "Actual User object." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine", "description": "Actual Machine object." }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup", "description": "The DesktopGroup this UserResourceUtilizationSummary record is associated with." } } }, "Citrix.Monitor.Model.VShared.ConnectionFailureCategory": { "required": [ "Id", "ConnectionFailureEnumValue", "Category", "CreatedDate", "ModifiedDate" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "ConnectionFailureEnumValue": { "type": "integer", "format": "int32", "description": "Numeric connection failure code received from the broker, identifying the specific connection failure reason." }, "Category": { "type": "integer", "format": "int32", "description": "Category of the failure code. See the ConnectionFailureType enum for possible values" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } }, "description": "ConnectionFailureCategory, grouping for Connection failure types" }, "Citrix.SpaMonitor.DomainModels.SpaMonitorServerApplication": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier (primary key) of this application-access record. This is the record identity, not the SPA application's own ApplicationId." }, "ApplicationName": { "type": "string", "format": "string", "description": "Display name of the SPA application." }, "ApplicationId": { "type": "string", "format": "string", "description": "SPA application identifier assigned by Secure Private Access. Distinct from Id, which is this record's primary key." }, "ApplicationStatus": { "type": "string", "format": "string", "description": "Access status for the application (for example \"Allowed\", \"Denied\", or \"Redirected\")." }, "ApplicationType": { "type": "string", "format": "string", "description": "Application type classification (for example a web/SaaS app or a TCP/UDP resource)." }, "MessageCode": { "type": "integer", "format": "int32", "description": "Numeric status/result code for the enumeration or launch event, from MonitorServerStatusTypes (for example 3000 = enumeration allow, 4001 = launch deny). Defaults to APP_ENUMERATION_UNKNOWN." }, "LaunchTime": { "type": "string", "format": "date-time", "description": "UTC timestamp when the application was launched. Null for enumeration-only events where no launch occurred." }, "TransactionId": { "type": "string", "format": "string", "description": "Correlation transaction ID that links related SPA events for this access." }, "AccessedUrl": { "type": "string", "format": "string", "description": "The URL or resource the user accessed for this application." }, "AllowedUrls": { "type": "string", "format": "string", "description": "Allowed URL patterns for the application, as defined by the applied access policy." }, "Policies": { "type": "string", "format": "string", "description": "Serialized SPA access policies applied to this application." }, "SecurityControls": { "type": "string", "format": "string", "description": "Security controls applied to this access (for example clipboard restriction or download block)." }, "AccessedResource": { "type": "string", "format": "string", "description": "Serialized details of the backend resource accessed during this event." }, "DataPath": { "type": "string", "format": "string", "description": "Data path used to reach the resource (for example \"Direct\", \"ViaConnector\", or \"Cloud\")." }, "FailureOriginator": { "type": "string", "format": "string", "description": "Component that originated the failure, if the access failed; otherwise empty." }, "SessionId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent SPA session (SpaSessions). Null for enumeration events." }, "EnumerationId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent SPA enumeration (SpaEnumerations). Null for session/launch events." }, "Enumeration": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerEnumeration", "description": "Related entity, available via $expand=Enumeration." }, "Session": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerSession", "description": "Related entity, available via $expand=Session." } }, "description": "Represents a single application-access event within a Secure Private Access (SPA) session: a user reaching a web/SaaS app or a TCP/UDP resource. Captures the accessed URL, applied access policy and security controls, routing, destination, and gateway/connector context, and links to its parent SPA enumeration and session." }, "Citrix.SpaMonitor.DomainModels.SpaMonitorServerEnumeration": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key of the enumeration record." }, "UserName": { "type": "string", "format": "string", "description": "Identity of the user for whom applications were enumerated." }, "UserSid": { "type": "string", "format": "string", "description": "Windows security identifier (SID) of the enumerated user." }, "UserOid": { "type": "string", "format": "string", "description": "Azure AD object identifier (OID) of the enumerated user." }, "Status": { "type": "string", "format": "string", "description": "Outcome of the enumeration, for example \"Success\" or \"Failure\"." }, "StatusCode": { "type": "integer", "format": "int32", "description": "Numeric status code for the enumeration outcome. Null when not reported." }, "TransactionId": { "type": "string", "format": "string", "description": "Correlation transaction ID that ties this enumeration to related SPA events." }, "ContextualTags": { "type": "string", "format": "string", "description": "Contextual tags derived from endpoint analysis at enumeration time." }, "DeviceName": { "type": "string", "format": "string", "description": "Name of the client device that performed the enumeration." }, "DeviceId": { "type": "string", "format": "string", "description": "Identifier of the client device that performed the enumeration." }, "DeviceIp": { "type": "string", "format": "string", "description": "Private IP address of the client device." }, "DevicePublicIp": { "type": "string", "format": "string", "description": "Public IP address of the client device." }, "GatewaySessionId": { "type": "string", "format": "string", "description": "Gateway session identifier for the enumeration." }, "GatewayName": { "type": "string", "format": "string", "description": "Name of the gateway through which the enumeration was made." }, "GatewayVip": { "type": "string", "format": "string", "description": "Virtual IP (VIP) address of the gateway." }, "CorrelationKey": { "type": "string", "format": "string", "description": "Cross-service correlation key used to join this enumeration with data from other services." }, "DeploymentType": { "type": "string", "format": "string", "description": "Deployment type of the environment: \"Cloud\" or \"Hybrid\". On-prem deployments are recorded as \"Hybrid\" (\"Onprem\" is not reported as a distinct value). Defaults to \"Cloud\"." }, "StartTime": { "type": "string", "format": "date-time", "description": "UTC time at which the enumeration started." }, "LastActiveTime": { "type": "string", "format": "date-time", "description": "UTC time of the last activity recorded for the enumeration." }, "ClientType": { "type": "string", "format": "string", "description": "Type of client used for the enumeration, for example Browser or CWA." }, "Applications": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerApplication" }, "description": "Legacy navigation collection of SPA application records linked to this enumeration through the SpaApplications.EnumerationId foreign key. Retained for backward compatibility; newer data is exposed through the EnumerationApplications navigation." } }, "description": "Represents a single Secure Private Access (SPA) resource-enumeration event, recorded when the SPA plugin lists the applications a user is entitled to before launch. Captures the user identity, client device, gateway context, status, timings, correlation key, and deployment type." }, "Citrix.SpaMonitor.DomainModels.SpaMonitorServerSession": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique Monitor-assigned identifier (primary key) for the SPA session record." }, "UserName": { "type": "string", "format": "string", "description": "User identity (user principal name or account name) of the account that established the session." }, "UserSid": { "type": "string", "format": "string", "description": "Windows security identifier (SID) of the session user. May be empty when the identity is not Windows-based." }, "UserOid": { "type": "string", "format": "string", "description": "Azure AD (Entra ID) object identifier (OID) of the session user." }, "Status": { "type": "string", "format": "string", "description": "Textual status of the session (for example, whether it is active or has ended)." }, "StatusCode": { "type": "integer", "format": "int32", "description": "Numeric status code corresponding to the session Status." }, "GatewaySessionId": { "type": "string", "format": "string", "description": "Identifier of the session as tracked by the gateway or connector." }, "GatewayAddress": { "type": "string", "format": "string", "description": "Address (host name or URL) of the gateway that fronted the session." }, "GatewayVip": { "type": "string", "format": "string", "description": "Virtual IP (VIP) address of the gateway used for the session." }, "ContextualTags": { "type": "string", "format": "string", "description": "Contextual tags derived from endpoint analysis (device posture) for the session." }, "DeviceName": { "type": "string", "format": "string", "description": "Name of the client device from which the session originated." }, "DeviceId": { "type": "string", "format": "string", "description": "Identifier of the client device from which the session originated." }, "DeviceIp": { "type": "string", "format": "string", "description": "Private (local network) IP address of the client device." }, "DevicePublicIp": { "type": "string", "format": "string", "description": "Public (internet-facing) IP address of the client device." }, "DeviceOs": { "type": "string", "format": "string", "description": "Operating system reported by the client device." }, "CebVersion": { "type": "string", "format": "string", "description": "Version of the Citrix Enterprise Browser (CEB) used for the session." }, "DomainsVisitedInternal": { "type": "string", "format": "string", "description": "Internal (corporate) domains accessed during the session." }, "DomainsVisitedExternal": { "type": "string", "format": "string", "description": "External (internet) domains accessed during the session." }, "CorrelationKey": { "type": "string", "format": "string", "description": "Cross-service correlation key used to trace this session across Citrix services. Defaults to a generated GUID." }, "DeploymentType": { "type": "string", "format": "string", "description": "Deployment type of the environment: \"Cloud\" or \"Hybrid\". On-prem deployments are recorded as \"Hybrid\" (\"Onprem\" is not reported as a distinct value). Defaults to \"Cloud\"." }, "SpaSession": { "type": "string", "format": "string", "description": "Secure Private Access (SPA) session identifier assigned by the SPA service." }, "PluginIpAddress": { "type": "string", "format": "string", "description": "IP address of the SPA plugin (client-side agent) that handled the session." }, "StoreFrontAddress": { "type": "string", "format": "string", "description": "Address of the StoreFront through which the session was launched." }, "ClientType": { "type": "string", "format": "string", "description": "Type of client used to establish the session (for example CEB or Browser)." }, "ClientVersion": { "type": "string", "format": "string", "description": "Version of the client used to establish the session." }, "StartTime": { "type": "string", "format": "date-time", "description": "UTC timestamp when the session started." }, "LastActiveTime": { "type": "string", "format": "date-time", "description": "UTC timestamp of the most recent activity recorded in the session." }, "Applications": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerApplication" }, "description": "Navigation collection of Secure Private Access (SPA) applications accessed during this session. Populate via $expand=Applications." } }, "description": "Represents a single Citrix Secure Private Access (SPA) end-user session as recorded by the Monitor service. A session covers a user accessing internal, SaaS, and TCP/UDP resources through the SPA plugin, StoreFront, and a gateway or connector, and captures user and device identity, gateway and StoreFront routing, client details, session timings, single sign-on and auto-logon outcomes, and any linked ICA session. Backs the SpaSessions OData entity set." }, "Citrix.Monitor.Model.ApplicationNameId": { "description": "Lightweight lookup mapping an application identifier string to its display name (local/uberAgent-discovered apps).", "required": [ "AppId" ], "type": "object", "properties": { "AppId": { "type": "string", "format": "string", "description": "Application Id" }, "AppName": { "type": "string", "format": "string", "description": "Application Name" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Time of creation of the application" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Time of modification of the application" }, "HistoricalApplicationLaunches": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.HistoricalApplicationLaunch" } }, "ApplicationIdDesktopGroupIdMappings": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationIdDesktopGroupIdMapping" } }, "ApplicationsUsageSummaryData": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationUsageSummaryData" } }, "ActiveApplicationLaunches": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ActiveApplicationLaunch" } } } }, "Citrix.Monitor.Model.BlockedUser": { "description": "A user blocked from launching sessions or published resources, for example after repeated connection failures or via the block-user action.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for BlockedUser" }, "UserId": { "type": "integer", "format": "int64", "description": "User id this failure is associated with" }, "PublishedResourceId": { "type": "integer", "format": "int64", "description": "PublishedResourceId this failure is associated with" }, "UnifiedResourceId": { "type": "string", "format": "string", "description": "UnifiedResourceId this failure is associated with" }, "IsBlocked": { "type": "boolean", "format": "boolean", "description": "Is the user blocked?" }, "FirstBlockedTime": { "type": "string", "format": "date-time", "description": "Time of the user first blocked" }, "UnblockedTime": { "type": "string", "format": "date-time", "description": "Time of the user unblocked" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "User": { "$ref": "#/components/schemas/Citrix.Monitor.Model.User" }, "ConnectionFailureLogs": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectionFailureLog" } } } }, "Citrix.Monitor.Model.GatewayPopInfo": { "description": "Represents a mappings between Pop ID and Pop location.", "required": [ "GatewayPopName" ], "type": "object", "properties": { "GatewayPopName": { "type": "string", "format": "string", "description": "Unique name of the Gateway Pop" }, "GatewayPopCountry": { "type": "string", "format": "string", "description": "Country of the Gateway Pop" }, "GatewayPopLocation": { "type": "string", "format": "string", "description": "Location of the Gateway Pop" }, "SessionMetricsLatest": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionMetricsLatest" } } } }, "Citrix.Monitor.Model.LocationCoordinates": { "description": "Represents geographic location data with city, country, and coordinates.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier of the location." }, "City": { "type": "string", "format": "string", "description": "Name of the city." }, "Country": { "type": "string", "format": "string", "description": "Name of the country." }, "Latitude": { "type": "number", "format": "double", "description": "Latitude coordinate." }, "Longitude": { "type": "number", "format": "double", "description": "Longitude coordinate." } } }, "Citrix.Monitor.Model.MachineCostAllocationSummary": { "description": "Represents cost and savings incurred while running a machine", "required": [ "Currency", "Granularity", "MachineId", "SummaryDate" ], "type": "object", "properties": { "SummaryDate": { "type": "string", "format": "date-time", "description": "Date time value at the start of the aggregation time window" }, "MachineId": { "type": "string", "format": "uuid", "description": "Machine ID as the Unique identifier" }, "Granularity": { "type": "string", "format": "string", "description": "Enum denoting the granularity - hour/day/month" }, "Currency": { "type": "string", "format": "string", "description": "Enum denoting the type of currency for the machine cost stored" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of desktopgroup this summary is associated with" }, "TotalComputeCost": { "type": "number", "format": "double", "description": "Total compute cost incurred" }, "TotalStorageCost": { "type": "number", "format": "double", "description": "Total storage cost incurred" }, "TotalAutoscaleComputeSavings": { "type": "number", "format": "double", "description": "Total autoscale compute savings" }, "TotalAutoscaleStorageSavings": { "type": "number", "format": "double", "description": "Total autoscale storage savings" }, "TotalEndUserComputeSavings": { "type": "number", "format": "double", "description": "Total end user compute savings" }, "TotalEndUserStorageSavings": { "type": "number", "format": "double", "description": "Total end user storage savings" }, "LastPowerOffActionType": { "type": "string", "format": "string", "description": "Enum denoting the last power off action type" }, "LastPowerOffActionReason": { "type": "string", "format": "string", "description": "Enum denoting the last power off action reason" }, "CostSourceType": { "type": "string", "format": "string", "description": "Enum denoting the source of cost used for aggregation" }, "UptimeInMinutes": { "type": "integer", "format": "int32", "description": "Uptime of the machine in minutes" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" } } }, "Citrix.Monitor.Model.MachineDiagnosticAlerts": { "description": "Machine Diagnostic Insights Alerts Entity Class", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the machine diagnostic alert." }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of the Machine this insight belongs to" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of Delivery Group this machine belongs to" }, "Type": { "type": "integer", "format": "int32", "description": "Type of insight for a machine" }, "Status": { "type": "integer", "format": "int32", "description": "Lifecycle state for the Insight. Used internally for data management." }, "LastReannouncementTime": { "type": "string", "format": "date-time", "description": "Last time this was reannounced" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" } } }, "Citrix.Monitor.Model.MachineDiagnosticInsights": { "description": "Machine Diagnostic Insights Entity Class", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "description": "Unique identifier of the machine diagnostic insight." }, "MachineId": { "type": "string", "format": "uuid", "description": "Guid of the Machine this insight belongs to" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of Delivery Group this machine belongs to" }, "IsBlackhole": { "type": "boolean", "format": "boolean", "description": "Indicates whether the machine is in a Blackhole state i.e. continuously failing to launch sessions" }, "IsZombie": { "type": "boolean", "format": "boolean", "description": "Indicates whether the single session machine is in a Zombie state i.e. have an active session but not allowing session to migrate to different endpoint" }, "IsOverloaded": { "type": "boolean", "format": "boolean", "description": "Indicates whether the machine is in an Overloaded state i.e. sustained high CPU and Memory usage" }, "ConsecutiveFailuresCount": { "type": "integer", "format": "int32", "description": "Consecutive connection failures count for the machine" }, "ZombieFailuresCount": { "type": "integer", "format": "int32", "description": "Zombie connection failures count for the machine" }, "IsCPUSpike": { "type": "boolean", "format": "boolean", "description": "Indicates whether the machine has been marked Overloaded because of sustained CPU spikes" }, "IsMemorySpike": { "type": "boolean", "format": "boolean", "description": "Indicates whether the machine has been marked Overloaded because of sustained Memory spikes" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" } } }, "Citrix.Monitor.Model.MachinePowerActionLog": { "description": "Log of power actions initiated on a machine (initiator, action type, reason, completion state).", "required": [ "MachineId" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Foreign key to the Machines entity - the machine the power action targets." }, "ActionId": { "type": "integer", "format": "int64", "description": "Identifier of the power action this log entry records. Together with MachineId it uniquely identifies the action." }, "ActionType": { "type": "string", "format": "string", "description": "Type of power action performed, stored as the broker PowerActionTypeCode value: 0=Unknown, 1=PowerOn, 2=PowerOff, 3=Shutdown, 4=Reset, 5=Restart, 6=Suspend, 7=Resume." }, "ActionReason": { "type": "string", "format": "string", "description": "Reason code indicating why the power action was triggered (for example administrator, Autoscale, or scheduled power management)." }, "FailureReason": { "type": "", "format": "", "description": "Failure reason code recorded when the power action fails. Null if the action succeeded or is still in progress." }, "ActionStartDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when the power action started. Null if only the completion event has been recorded." }, "ActionEndDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when the power action completed. Null while the action is still in progress." }, "LastPoweredOnDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when the machine was last powered on at the time of this action." }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this log entry was last updated." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" } } }, "Citrix.Monitor.Model.MachineSpec": { "description": "Represents the specs of machines", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Unique identifier for machine spec entry" }, "CloudProvider": { "type": "string", "format": "string", "description": "Cloud Provider" }, "CloudRegion": { "type": "string", "format": "string", "description": "Cloud Region" }, "VmSeries": { "type": "string", "format": "string", "description": "Cloud VM series or size family of the machine (for example, an Azure VM series such as \"Standard_D2s_v3\")." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date" }, "MachineCosts": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineCost" } } } }, "Citrix.Monitor.Model.MonthlyCostSummary": { "description": "Represents historical data of total cost, savings and unique users for a month", "required": [ "Currency", "SummaryDate" ], "type": "object", "properties": { "SummaryDate": { "type": "string", "format": "date-time", "description": "Date time value at the start of the aggregation time window" }, "Currency": { "type": "string", "format": "string", "description": "Enum denoting the type of currency" }, "TotalCost": { "type": "number", "format": "double", "description": "Total cost incurred across all delivery groups" }, "TotalSavings": { "type": "number", "format": "double", "description": "Total savings across all delivery groups" }, "TotalUniqueUsers": { "type": "integer", "format": "int32", "description": "Total unique users" } } }, "Citrix.Monitor.Model.SessionAccessDenied": { "description": "deviceTRUST-initiated access-denial events where a session was blocked due to endpoint policy violation.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for SessionAccessDenied" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Guid of session associated with the access denied entry" }, "ConnectionId": { "type": "integer", "format": "int64", "description": "Id of the connection record associated with this access denied entry." }, "UserId": { "type": "integer", "format": "int64", "description": "User Id this access denied entry is associated with" }, "TransactionId": { "type": "string", "format": "uuid", "description": "Transaction ID associated with the connection" }, "DeviceName": { "type": "string", "format": "string", "description": "Device name that is denied access" }, "DeviceOs": { "type": "string", "format": "string", "description": "Device OS that is denied access" }, "DeviceClientVersion": { "type": "string", "format": "string", "description": "deviceTRUST client version" }, "Context": { "type": "string", "format": "string", "description": "deviceTRUST context list acted by an Action" }, "ActionName": { "type": "string", "format": "string", "description": "deviceTRUST action name that is executed" }, "Title": { "type": "string", "format": "string", "description": "The message title displayed to the user" }, "Message": { "type": "string", "format": "string", "description": "The message displayed to the user" }, "Timeout": { "type": "integer", "format": "int32", "description": "The timeout period that the message is displayed to the user" }, "DeniedDate": { "type": "string", "format": "date-time", "description": "The time when the access was denied to a session" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "Connection": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Connection" }, "User": { "$ref": "#/components/schemas/Citrix.Monitor.Model.User" } } }, "Citrix.Monitor.Model.UserMachineLogSummary": { "description": "Represents logs for session launched by a user on a machine", "required": [ "MachineId", "SummaryDate", "UserId" ], "type": "object", "properties": { "SummaryDate": { "type": "string", "format": "date-time", "description": "Date time value at the start of the aggregation time window" }, "UserId": { "type": "integer", "format": "int64", "description": "Id of User entry for the user logged on" }, "MachineId": { "type": "string", "format": "uuid", "description": "Machine ID as the Unique identifier" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" } } }, "Citrix.Monitor.Model.ApplicationPerformanceMetrics": { "description": "Per-application performance metrics from uberAgent on VDAs (CPU, memory, disk, input delay, network latency, page faults).", "required": [ "CollectedDay", "Id" ], "type": "object", "properties": { "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "Id": { "type": "integer", "format": "int64", "description": "Auto-generated identifier for the record. Part of the composite key together with CollectedDay." }, "CollectedDate": { "type": "string", "format": "date-time", "description": "UTC date and time when the metrics were collected." }, "SessionKey": { "type": "string", "format": "uuid", "description": "Identifier of the session the application ran in. Null when the metrics are not tied to a specific session." }, "MachineId": { "type": "string", "format": "uuid", "description": "Identifier of the VDA machine the application ran on." }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Identifier of the delivery group (desktop group) the machine belongs to. Null when the machine is not in a delivery group." }, "UserId": { "type": "integer", "format": "int64", "description": "Identifier of the user running the application. Null for system-level processes." }, "UserName": { "type": "string", "format": "string", "description": "Name of the user running the application." }, "AppId": { "type": "string", "format": "string", "description": "Application identifier string (stable key for the application)." }, "AppName": { "type": "string", "format": "string", "description": "Display name of the application." }, "IsPublished": { "type": "boolean", "format": "boolean", "description": "True when the application is published (delivered through Citrix); false for local or unpublished applications." }, "Processes": { "type": "string", "format": "string", "description": "Comma-separated list of process names that make up the application." }, "CPUUsagePercent": { "type": "number", "format": "double", "description": "Average CPU usage over the collection interval, as a percentage. Null when not reported." }, "MemoryUsagePercent": { "type": "number", "format": "double", "description": "Average memory usage over the collection interval, as a percentage. Null when not reported." }, "DiskIops": { "type": "number", "format": "double", "description": "Average disk I/O rate over the collection interval, in IOPS (I/O operations per second). Null when not reported." }, "DiskLatency": { "type": "number", "format": "double", "description": "Average disk latency over the collection interval, in milliseconds. Null when not reported." }, "InputDelay": { "type": "number", "format": "double", "description": "Average user input delay over the collection interval, in milliseconds. Null when not reported." }, "PageFaultsPS": { "type": "number", "format": "double", "description": "Average page fault rate over the collection interval, in page faults per second. Null when not reported." }, "WorkingSetMB": { "type": "number", "format": "double", "description": "Average working set (physical memory in use) over the collection interval, in megabytes (MB). Null when not reported." }, "NetworkLatency": { "type": "number", "format": "double", "description": "Per-window weighted average send latency (ms). Populated from UAApplicationPerformanceMetrics.AvgNetworkLatency for older VDAs; derived as SumSendLatencyDurationMs / SumSendLatencyCount by the processor for newer VDAs that emit raw sums instead of a pre-averaged value." }, "CollectedDay": { "type": "integer", "format": "int32", "description": "Day of the month (1-31) when the data was collected. Part of the composite key and used for table partitioning." }, "P95CPUPercent": { "type": "number", "format": "double", "description": "95th-percentile CPU usage over the collection interval, as a percentage. Null when there are insufficient samples." }, "P95MemoryUsage": { "type": "number", "format": "double", "description": "95th-percentile memory usage over the collection interval, as a percentage. Null when there are insufficient samples." }, "P95InputDelay": { "type": "number", "format": "double", "description": "95th-percentile user input delay over the collection interval, in milliseconds. Null when there are insufficient samples." } } }, "Citrix.Monitor.Model.CcMetrics": { "description": "Cloud Connector health metrics (Windows service statuses and connectivity failure details).", "required": [ "AgentId", "CollectedDate" ], "type": "object", "properties": { "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this data is collected from" }, "FetchId": { "type": "string", "format": "uuid", "description": "FetchId to join this component specific data with generic resource utilization data" }, "CitrixClxMtpService": { "type": "integer", "format": "int32", "description": "Citrix Connection Lease Exchange Service" }, "CitrixClxMtpServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Connection Lease Exchange Service" }, "CitrixCdfCaptureService": { "type": "integer", "format": "int32", "description": "Citrix CDF Capture Service" }, "CitrixCdfCaptureServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix CDF Capture Service" }, "NSCloudGatewayService": { "type": "integer", "format": "int32", "description": "Citrix NetScaler Cloud Gateway" }, "NSCloudGatewayServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix NetScaler Cloud Gateway" }, "ADProviderService": { "type": "integer", "format": "int32", "description": "Citrix AD Provider" }, "ADProviderServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix AD Provider" }, "AgentDiscoveryService": { "type": "integer", "format": "int32", "description": "Citrix Agent Discovery" }, "AgentDiscoveryServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Agent Discovery" }, "AgentLoggerService": { "type": "integer", "format": "int32", "description": "Citrix Agent Logger" }, "AgentLoggerServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Agent Logger" }, "CredentialProviderService": { "type": "integer", "format": "int32", "description": "Citrix Credential Provider" }, "CredentialProviderServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Credential Provider" }, "WebRelayProviderService": { "type": "integer", "format": "int32", "description": "Citrix WebRelay Provider" }, "WebRelayProviderServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix WebRelay Provider" }, "HighAvailabilityService": { "type": "integer", "format": "int32", "description": "Citrix High Availability Service" }, "HighAvailabilityServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix High Availability Service" }, "RemoteHCLServerService": { "type": "integer", "format": "int32", "description": "Citrix Remote HCL Server" }, "RemoteHCLServerServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Remote HCL Server" }, "RemoteBrokerProviderService": { "type": "integer", "format": "int32", "description": "Citrix Remote Broker Provider" }, "RemoteBrokerProviderServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Remote Broker Provider" }, "AgentWatchDogService": { "type": "integer", "format": "int32", "description": "Citrix Cloud Services Agent WatchDog" }, "AgentWatchDogServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Cloud Services Agent WatchDog" }, "ConfigSyncService": { "type": "integer", "format": "int32", "description": "Citrix Config Synchronizer Service" }, "ConfigSyncServiceConnectivityFailures": { "type": "string", "format": "string", "description": "Connectivity result errors reported for Citrix Config Synchronizer Service" }, "LastBootTime": { "type": "string", "format": "date-time", "description": "Last time the Cloud Connector was rebooted" }, "Version": { "type": "string", "format": "string", "description": "Version of the Cloud Connector installed" } } }, "Citrix.Monitor.Model.ConnectorApplianceChildService": { "description": "Health snapshot of an individual service running on a Connector Appliance, linked to a parent ConnectorApplianceMetrics record.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Auto-generated primary key of the child-service record." }, "ConnectorApplianceMetricsId": { "type": "integer", "format": "int64", "description": "Identifier of the parent ConnectorApplianceMetrics snapshot this service belongs to." }, "Service": { "type": "string", "format": "string", "description": "Name of the service running on the Connector Appliance." }, "HealthStatus": { "type": "string", "format": "string", "description": "Result of the service health check (for example, healthy or unhealthy)." }, "HealthErrorDescription": { "type": "string", "format": "string", "description": "Description of the health-check error, when the service is unhealthy." }, "ConnectivityStatus": { "type": "string", "format": "string", "description": "Result of the service connectivity check." }, "ConnectivityErrorDescription": { "type": "string", "format": "string", "description": "Description of the connectivity error, when the connectivity check failed." }, "IsRunning": { "type": "boolean", "format": "boolean", "description": "True when the service is currently running; false otherwise. Null when unknown." }, "Version": { "type": "string", "format": "string", "description": "Version of the service." }, "ConnectorApplianceMetrics": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceMetrics" } } }, "Citrix.Monitor.Model.ConnectorApplianceMetrics": { "description": "Health and inventory snapshot of a Citrix Cloud Connector Appliance, captured at a point in time. Covers status, software version, network addressing, Active Directory and domain-join state, and disk capacity.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Auto-generated primary key of the snapshot record." }, "ConnectorId": { "type": "string", "format": "uuid", "description": "Unique identifier of the Connector Appliance." }, "ConnectorName": { "type": "string", "format": "string", "description": "Friendly name of the Connector Appliance." }, "ConnectorType": { "type": "string", "format": "string", "description": "Type or category of the Connector Appliance." }, "ResourceLocationId": { "type": "string", "format": "string", "description": "Identifier of the resource location the Connector Appliance belongs to." }, "Version": { "type": "string", "format": "string", "description": "Software version running on the Connector Appliance." }, "Status": { "type": "string", "format": "string", "description": "Overall health status of the Connector Appliance (for example, whether it is healthy or reporting issues)." }, "LastBootTime": { "type": "string", "format": "date-time", "description": "UTC date and time when the Connector Appliance last booted. Null when unknown." }, "PublicIPv4": { "type": "string", "format": "string", "description": "Public IPv4 address of the Connector Appliance." }, "PrivateIP": { "type": "string", "format": "string", "description": "Private (internal) IP address of the Connector Appliance." }, "ConfiguredForAD": { "type": "boolean", "format": "boolean", "description": "True when the Connector Appliance is configured for Active Directory; false otherwise. Null when unknown." }, "DomainJoined": { "type": "string", "format": "string", "description": "Domain-join status of the Connector Appliance, as a text value (for example, the joined domain name(s) or a status message)." }, "DiskSpaceTotal": { "type": "number", "format": "double", "description": "Total disk capacity of the Connector Appliance, in gigabytes (GB). Null when not reported." }, "CollectedTime": { "type": "string", "format": "date-time", "description": "UTC date and time when this snapshot was collected from the Connector Appliance." }, "CreatedTime": { "type": "string", "format": "date-time", "description": "UTC date and time when this record was created in the Monitor database." }, "ChildServices": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceChildService" } }, "ProxyDetails": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceProxyDetail" } } } }, "Citrix.Monitor.Model.ConnectorApplianceProxyDetail": { "description": "Proxy configuration entry for a Connector Appliance, linked to a parent ConnectorApplianceMetrics record.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Auto-generated primary key of the proxy-detail record." }, "ConnectorApplianceMetricsId": { "type": "integer", "format": "int64", "description": "Identifier of the parent ConnectorApplianceMetrics snapshot this proxy entry belongs to." }, "FQDN": { "type": "string", "format": "string", "description": "Fully qualified domain name (FQDN) of the proxy server." }, "Port": { "type": "integer", "format": "int32", "description": "Network port used to reach the proxy. Null when not set." }, "Authentication": { "type": "string", "format": "string", "description": "Authentication type used for the proxy connection." }, "ConnectorApplianceMetrics": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceMetrics" } } }, "Citrix.Monitor.Model.DdcMetrics": { "description": "Delivery Controller (DDC) health metrics (broker service, license state, DB connectivity, certificate validity).", "required": [ "AgentId", "CollectedDate" ], "type": "object", "properties": { "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this data is collected from" }, "FetchId": { "type": "string", "format": "uuid", "description": "FetchId to join this component specific data with generic resource utilization data" }, "SiteName": { "type": "string", "format": "string", "description": "Name of the Citrix site this Delivery Controller belongs to." }, "BrokerServiceStatus": { "type": "integer", "format": "int32", "description": "Citrix Broker Service" }, "LicenseServerConnectivityStatus": { "type": "integer", "format": "int32", "description": "License Server Connectivity" }, "LicenseServerName": { "type": "string", "format": "string", "description": "Hostname of the license server used by this Delivery Controller." }, "LicensesState": { "type": "integer", "format": "int32", "description": "Licenses Status" }, "SiteDatabaseConnectivityStatus": { "type": "integer", "format": "int32", "description": "Site Database Connectivity" }, "MonitorDatabaseConnectivityStatus": { "type": "integer", "format": "int32", "description": "Monitor Database Connectivity" }, "IisCertValidity": { "type": "integer", "format": "int32", "description": "IIS Certificate Validity" }, "IsIisChainValid": { "type": "boolean", "format": "boolean", "description": "IIS certificate Chain Validity" }, "LastBootTime": { "type": "string", "format": "date-time", "description": "Last time the Store Front was rebooted" }, "UseLas": { "type": "boolean", "format": "boolean", "description": "Whether the License Activation Service (LAS) feature is enabled for this site." }, "LasEntitlementExpiryDate": { "type": "string", "format": "date-time", "description": "Date when the LAS entitlement expires." }, "LasActivationLastReached": { "type": "string", "format": "date-time", "description": "The last time the License Server established a connection to LAS to import new license files." }, "LasActivationExpiry": { "type": "string", "format": "date-time", "description": "Date when the DDC's LAS activation expires, as reported by the Broker." }, "LasActivationStatus": { "type": "integer", "format": "int32", "description": "DDC activation status reported by the Broker. Stored as the integer value of LasActivationStatus." }, "LasConnectionStatus": { "type": "integer", "format": "int32", "description": "Connection status between the License Server and LAS as reported by the Broker. Stored as the integer value of LasConnectionStatus." } } }, "Citrix.Monitor.Model.DirectorUIThresholdConfiguration": { "description": "A configurable warning and critical threshold for a metric shown in the Citrix Director UI. Thresholds drive color-coding and alerting when a metric's value crosses the configured levels.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier (primary key) for this threshold configuration." }, "DataSource": { "type": "string", "format": "string", "description": "Identifier of the data source that supplies the metric this threshold applies to." }, "MetricName": { "type": "string", "format": "string", "description": "Name of the metric that this threshold is evaluated against." }, "Name": { "type": "string", "format": "string", "description": "Display name of this threshold configuration." }, "Description": { "type": "string", "format": "string", "description": "Human-readable description of what this threshold represents." }, "Unit": { "type": "string", "format": "string", "description": "Unit of measurement of the metric this threshold applies to (for example, percent or ms)." }, "IsEnabled": { "type": "boolean", "format": "boolean", "description": "Whether this threshold is active. When true, the metric is evaluated against the configured warning and critical values." }, "CriticalThreshold": { "type": "number", "format": "double", "description": "Current critical threshold value in effect. Null when no critical level is configured." }, "WarningThreshold": { "type": "number", "format": "double", "description": "Current warning threshold value in effect. Null when no warning level is configured." }, "DefaultCriticalThreshold": { "type": "number", "format": "double", "description": "Product-supplied default critical threshold value. Null when no default is defined." }, "DefaultWarningThreshold": { "type": "number", "format": "double", "description": "Product-supplied default warning threshold value. Null when no default is defined." }, "IsSystemDefault": { "type": "boolean", "format": "boolean", "description": "Whether this threshold is system-provided (true) rather than user-defined (false)." }, "UpdatedBy": { "type": "string", "format": "string", "description": "Identifier of the user who last changed this threshold configuration." }, "Type": { "type": "string", "format": "string", "description": "Threshold type derived from the default values: Predefined when product defaults exist, otherwise Custom." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.EndpointSecurityEvents": { "description": "Security events reported from client endpoints via Citrix Workspace App or deviceTRUST.", "required": [ "SessionKey" ], "type": "object", "properties": { "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" }, "AdditionalData": { "type": "string", "format": "string", "description": "Additional data in JSON or other structured format" }, "ComponentType": { "type": "string", "format": "string", "description": "Component type (e.g., AppProtection)" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Record creation timestamp" }, "CwaVersion": { "type": "string", "format": "string", "description": "Citrix Workspace App version" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Desktop group identifier associated with the VDA to which the Endpoint is connected" }, "DeviceName": { "type": "string", "format": "string", "description": "Endpoint device identifier" }, "EventTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the event occurred" }, "EventType": { "type": "string", "format": "string", "description": "Event type (e.g., screenCapture, keyLogger, recall)" }, "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the endpoint security event" }, "IpAddress": { "type": "string", "format": "string", "description": "IP address of the endpoint" }, "OsVersion": { "type": "string", "format": "string", "description": "Operating system version" }, "PartitionDay": { "type": "integer", "format": "int32", "description": "Month from EventTimestamp * 100 + Day for table partitioning" }, "PayloadType": { "type": "integer", "format": "int32", "description": "Payload type (e.g., Detected, Protected)" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Session key - foreign key reference to Session table" }, "UserName": { "type": "string", "format": "string", "description": "User name associated with the event" } } }, "Citrix.Monitor.Model.MachineInventoryMetrics": { "description": "Current-state hardware and OS inventory for a VDA machine (one row per machine).", "required": [ "MachineId" ], "type": "object", "properties": { "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Gets or sets the last-seen timestamp for this machine's inventory. Updated on every VDA report by the upsert processor." }, "CPUName": { "type": "string", "format": "string", "description": "Gets or sets the CPU name." }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Gets or sets the unique identifier for the desktop group." }, "HwBiosVersion": { "type": "string", "format": "string", "description": "Gets or sets the BIOS version (Windows only)." }, "HwManufacturer": { "type": "string", "format": "string", "description": "Gets or sets the hardware manufacturer." }, "HwModel": { "type": "string", "format": "string", "description": "Gets or sets the hardware model." }, "MachineId": { "type": "string", "format": "uuid", "description": "Gets or sets the unique identifier for the machine. Primary key -- one inventory row per machine." }, "OsArchitecture": { "type": "string", "format": "string", "description": "Gets or sets the OS architecture." }, "OsBuild": { "type": "integer", "format": "int32", "description": "Gets or sets the OS build number (Windows only)." }, "OsBuildString": { "type": "string", "format": "string", "description": "Gets or sets the OS build string (macOS/Linux only)." }, "OsName": { "type": "string", "format": "string", "description": "Gets or sets the operating system name." }, "OsSpName": { "type": "string", "format": "string", "description": "Gets or sets the service pack name (Windows only)." }, "OsSpVersion": { "type": "integer", "format": "int32", "description": "Gets or sets the service pack version (Windows only)." }, "OsType": { "type": "string", "format": "string", "description": "Gets or sets the OS type (e.g., Client, Server, Terminal Server)." }, "OsUpdateBuildRevision": { "type": "integer", "format": "int32", "description": "Gets or sets the OS Update Build Revision (Windows only)." }, "OsVersion": { "type": "string", "format": "string", "description": "Gets or sets the operating system version." }, "RAMSizeGB": { "type": "number", "format": "double", "description": "Gets or sets the RAM size in GB." } } }, "Citrix.Monitor.Model.MachinePowerActionStatus": { "description": "Represents Machine Power Action Status events triggered by external systems like AlertEngine, Citrix Aidrien, etc.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for MachinePowerActionStatus" }, "ActionId": { "type": "integer", "format": "int64", "description": "Action Id returned by the broker" }, "MachineId": { "type": "string", "format": "uuid", "description": "Foreign key reference to Machine table" }, "RequestId": { "type": "string", "format": "uuid", "description": "Unique request identifier for tracking the power action request" }, "TriggeredBy": { "type": "integer", "format": "int32", "description": "Indicates who triggered the power action (AlertEngine, Citrix Aidrien, etc.)" }, "ActionType": { "type": "integer", "format": "int32", "description": "Type of power action (PowerOn, PowerOff, Shutdown, etc.)" }, "ActionFailureReason": { "type": "integer", "format": "int32", "description": "Failure reason if the action failed" }, "ActionStartDate": { "type": "string", "format": "date-time", "description": "Start date of the power action" }, "ActionEndDate": { "type": "string", "format": "date-time", "description": "End date of the power action" }, "ActionStatus": { "type": "integer", "format": "int32", "description": "Current status of the power action (Triggered, Successful, Failed, Timeout)" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.MachineTag": { "description": "A tag association linking a machine to a tag (composite key of MachineId and TagId).", "required": [ "MachineId", "TagId" ], "type": "object", "properties": { "TagId": { "type": "integer", "format": "int32", "description": "Composite key part. Foreign key to the associated Tag." }, "MachineId": { "type": "string", "format": "uuid", "description": "Composite key part. Foreign key to the associated Machine." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "Tag": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Tag" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.Pnaa.ActionSummary": { "description": "Outcome of a remediation action executed in response to an alert (per-target success/failure/skip counts).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the ActionSummary" }, "NotificationLogId": { "type": "string", "format": "uuid", "description": "Foreign key to NotificationLog" }, "ActionRequestId": { "type": "string", "format": "uuid", "description": "Action request identifier" }, "SourceType": { "type": "integer", "format": "int32", "description": "Source type of the action." }, "ActionFamily": { "type": "integer", "format": "int32", "description": "Family of the action." }, "ActionType": { "type": "integer", "format": "int32", "description": "Type of the action." }, "Status": { "type": "integer", "format": "int32", "description": "Status of the action" }, "TotalTargetCount": { "type": "integer", "format": "int32", "description": "Total number of targets for this action" }, "SuccessTargetCount": { "type": "integer", "format": "int32", "description": "Number of targets that completed successfully" }, "FailedTargetCount": { "type": "integer", "format": "int32", "description": "Number of targets that completed as failed" }, "SkippedTargetCount": { "type": "integer", "format": "int32", "description": "Number of targets that were skipped" }, "SkippedTargets": { "type": "string", "format": "string", "description": "Details of skipped targets" }, "NotificationLog": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationLog" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.PvsMetrics": { "description": "Provisioning Services (PVS) metrics reported for a machine.", "required": [ "AgentId", "CollectedDate" ], "type": "object", "properties": { "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this data is collected from" }, "FetchId": { "type": "string", "format": "uuid", "description": "FetchId to join this component specific data with generic resource utilization data" }, "SoapServiceStatus": { "type": "integer", "format": "int32", "description": "PVS Soap Service status" }, "StreamServiceStatus": { "type": "integer", "format": "int32", "description": "PVS Stream Service status" }, "TftpServiceStatus": { "type": "integer", "format": "int32", "description": "PVS TFTP service status" }, "PxeServiceStatus": { "type": "integer", "format": "int32", "description": "PVS PXE service status" }, "RejectedLoginCountDeviceNotFound": { "type": "integer", "format": "int32", "description": "Rejected login count for device not found" }, "RejectedLoginCountvDiskNA": { "type": "integer", "format": "int32", "description": "Rejected login count for vDisk not available" }, "RejectedLoginCountServerBusy": { "type": "integer", "format": "int32", "description": "Rejected login count for server busy" }, "RejectedLoginCountServerNAForvDisk": { "type": "integer", "format": "int32", "description": "Rejected login count for server not available for vDisk" }, "TotalTargetLoginAttempts": { "type": "integer", "format": "int32", "description": "Total target login attempts" }, "TotalTargetReconnectCount": { "type": "integer", "format": "int32", "description": "Total target reconnect count" }, "DeviceCountActive": { "type": "integer", "format": "int32", "description": "Device Count Active" }, "DatabaseConnectivityStatus": { "type": "integer", "format": "int32", "description": "Component Type for the agent." }, "LicenseServerConnectivityStatus": { "type": "integer", "format": "int32", "description": "Component Type for the agent." } } }, "Citrix.Monitor.Model.ReconnectSummary": { "description": "Hourly and daily rollup of session reconnect durations, broken down by phase, with a per-phase count used to compute correct averages across rollups.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Time stamp associated with this summary data" }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Guid of DesktopGroup this summary is associated with" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" }, "TotalDuration": { "type": "integer", "format": "int64", "description": "Sum of all reconnect durations" }, "TotalCount": { "type": "integer", "format": "int32", "description": "Count of Total reconnects" }, "BrokeringDuration": { "type": "integer", "format": "int64", "description": "Sum of all brokering durations" }, "BrokeringCount": { "type": "integer", "format": "int32", "description": "Count of the Brokering durations" }, "VMStartDuration": { "type": "integer", "format": "int64", "description": "Sum of all VM Start durations" }, "VMPowerOnDuration": { "type": "integer", "format": "int64", "description": "Sum of all VM power on durations" }, "VMRegistrationDuration": { "type": "integer", "format": "int64", "description": "Sum of all VM registration durations" }, "VMStartCount": { "type": "integer", "format": "int32", "description": "Count of all VM Start durations" }, "InteractiveDuration": { "type": "integer", "format": "int64", "description": "Sum of all Interactive durations" }, "InteractiveCount": { "type": "integer", "format": "int32", "description": "Count of all Interactive durations" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes Size of the time windows in minutes for this summary" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.ResourceUtilizationSummaryLatest": { "description": "Latest resource-utilization summary per machine, retained for the 1-hour, 2-hour, 24-hour, and 7-day windows.", "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Autogenerated ID" }, "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "Granularity": { "type": "integer", "format": "int32", "description": "Granularity of this summary item in minutes" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "AvgPercentCpu": { "type": "number", "format": "double", "description": "Average percentage of CPU for given granularity" }, "AvgDiskLatency": { "type": "number", "format": "double", "description": "Average Seconds (\\PhysicalDisk(*)\\Avg. Disk sec/Transfer)" }, "AvgDiskIops": { "type": "number", "format": "double", "description": "Average Transfers per second (\\PhysicalDisk(*)\\Disk Transfers/sec)" }, "AvgCPURelativeFrequencyPercent": { "type": "number", "format": "double", "description": "Average actual CPU frequency as a Percentage of the base frequency" }, "AvgIdlenessPercent": { "type": "number", "format": "double", "description": "Status of the idle timer expressed as a percentage. 100% = system is completely idle (screen saver/display off)" }, "AvgRAMUsagePercent": { "type": "number", "format": "double", "description": "Average RAM usage in percent" }, "AvgNetUtilizationPercent": { "type": "number", "format": "double", "description": "Average Network utilization in percent" }, "AvgPagefileUsagePercent": { "type": "number", "format": "double", "description": "Average Pagefile usage in percent" }, "AvgPercentGPU": { "type": "number", "format": "double", "description": "Average GPU utilization in percent" }, "AvgDiskUsagePercent": { "type": "number", "format": "double", "description": "Average Disk Usage memory usage in percent" }, "AvgProfileDiskUsagePercent": { "type": "number", "format": "double", "description": "Average Profile Disk Usage in percent" }, "AvgLoadIndexPercent": { "type": "number", "format": "double", "description": "Average Load Index for given granularity" } } }, "Citrix.Monitor.Model.ResourceUtilizationSummaryLatestMapping": { "description": "Mapping of the latest resource-utilization summary per granularity to each machine.", "required": [ "MachineId" ], "type": "object", "properties": { "MachineId": { "type": "string", "format": "uuid", "description": "Machine unique id" }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" }, "Latest1HourRusId": { "type": "integer", "format": "int64", "description": "Foreign key to ResourceUtilizationSummary Id for latest 1 hour data" }, "Latest1HourRus": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummaryLatest" }, "Latest2HoursRusId": { "type": "integer", "format": "int64", "description": "Foreign key to ResourceUtilizationSummary Id for latest 2 hours data" }, "Latest2HoursRus": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummaryLatest" }, "Latest1DayRusId": { "type": "integer", "format": "int64", "description": "Foreign key to ResourceUtilizationSummary Id for latest 1 day data" }, "Latest1DayRus": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummaryLatest" }, "Latest7DaysRusId": { "type": "integer", "format": "int64", "description": "Foreign key to ResourceUtilizationSummary Id for latest 7 days data" }, "Latest7DaysRus": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummaryLatest" } } }, "Citrix.Monitor.Model.ServiceContinuityMetrics": { "description": "Detailed per-device metrics for the Service Continuity feature, including device readiness, app and desktop availability, client-side lease sync status, and related data.", "required": [ "CollectedDate", "CollectedDay", "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Autogenerated unique identifier for ServiceContinuityMetrics record." }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date and time when this metric was collected from the source." }, "CollectedDay": { "type": "integer", "format": "int32", "description": "Day component of CollectedDate (1-31) for table partitioning. Used for partition key in MonitorData_PS_DayOfMonth partition scheme." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created date time of this record (UTC time, yyyy-MM-dd HH:mm:ss.SS)." }, "DeviceId": { "type": "string", "format": "string", "description": "Unique identifier of the device/endpoint. Nullable to support scenarios where device ID may not be available." }, "UserName": { "type": "string", "format": "string", "description": "User name associated with the Service Continuity metrics. Required field for tracking per-user metrics." }, "UserOid": { "type": "string", "format": "string", "description": "User Object Identifier (OID) from identity provider. Nullable to support various authentication scenarios." }, "EventId": { "type": "string", "format": "string", "description": "The unique message identifier from the event envelope (top-level id field). Nullable as this field is not guaranteed to be present in all event types." }, "AccessMethod": { "type": "string", "format": "string", "description": "Access method used by the user (e.g., Native, Browser, etc.)." }, "OSType": { "type": "string", "format": "string", "description": "Operating system type of the endpoint (e.g., Windows, macOS, iOS, Android)." }, "BrowserName": { "type": "string", "format": "string", "description": "Browser name used for access (e.g., Safari, Chrome, Microsoft Edge, Firefox). Nullable as not all access methods use a browser." }, "OSVersion": { "type": "string", "format": "string", "description": "Operating system version of the endpoint. Nullable as version information may not always be available." }, "ClientType": { "type": "string", "format": "string", "description": "Client type used for access (e.g., Citrix Workspace App, Browser). Nullable to support various client scenarios." }, "CWAVersion": { "type": "string", "format": "string", "description": "Citrix Workspace App version. Nullable as not all clients provide version information. For browser events, this is the CWA version from the payload (if reported)." }, "ExtensionAvailable": { "type": "boolean", "format": "boolean", "description": "Indicates whether the browser extension is available for Service Continuity. True when installed, false when not, or null for non-hybrid (native CWA) access." }, "ShieldEnabled": { "type": "boolean", "format": "boolean", "description": "Indicates whether Shield (security feature) is enabled. Null when the field is absent from the event payload." }, "StoreConfigUrl": { "type": "string", "format": "string", "description": "Store configuration URL used by the client. Required field for tracking store-specific metrics." }, "ClSyncFailures": { "type": "integer", "format": "int32", "description": "Number of client-side lease synchronization failures. Nullable as sync may not have occurred yet." }, "ClSyncLastSuccess": { "type": "string", "format": "date-time", "description": "Timestamp of the last successful client-side lease synchronization. Nullable if no successful sync has occurred." }, "ClSyncTriggers": { "type": "integer", "format": "int32", "description": "Number of client-side lease synchronization triggers/attempts. Nullable as sync may not have been triggered yet." }, "TotalApps": { "type": "integer", "format": "int32", "description": "Total number of applications available to the user. Nullable because older CWA versions (e.g. some Mac releases) may omit this field. A null value indicates that this data was not provided by the client (for example, by an older CWA version)." }, "LeasableApps": { "type": "integer", "format": "int32", "description": "Number of applications that support leasing (offline availability). Nullable because older CWA versions (e.g. some Mac releases) may omit this field. A null value indicates that this data was not provided by the client (for example, by an older CWA version)." }, "TotalDesktops": { "type": "integer", "format": "int32", "description": "Total number of desktops available to the user. Nullable because older CWA versions (e.g. some Mac releases) may omit this field. A null value indicates that this data was not provided by the client (for example, by an older CWA version)." }, "LeasableDesktops": { "type": "integer", "format": "int32", "description": "Number of desktops that support leasing (offline availability). Nullable because older CWA versions (e.g. some Mac releases) may omit this field. A null value indicates that this data was not provided by the client (for example, by an older CWA version)." }, "TotalLeaseFiles": { "type": "integer", "format": "int32", "description": "Total number of lease files present on the client. Nullable as this information may not be available in all scenarios." }, "TotalExpiredFiles": { "type": "integer", "format": "int32", "description": "Total number of expired lease files on the client. Nullable as this information may not be available in all scenarios." }, "Readiness": { "type": "boolean", "format": "boolean", "description": "Indicates whether the device is ready for Service Continuity. True when all prerequisites are met, false otherwise." } } }, "Citrix.Monitor.Model.SessionPerformanceSummary": { "description": "Consolidated per-session performance summary.", "required": [ "SessionKey", "CollectedDay" ], "type": "object", "properties": { "SessionKey": { "type": "string", "format": "uuid", "description": "Session key (GUID) that this performance summary is associated with" }, "SummaryDate": { "type": "string", "format": "date-time", "description": "Summary date (UTC) for this performance summary" }, "CollectedDay": { "type": "integer", "format": "int32", "description": "Day of month (1-31) used for partitioning" }, "SessionScore": { "type": "number", "format": "double", "description": "Overall session performance score" }, "CPUUsageScore": { "type": "number", "format": "double", "description": "CPU usage performance score" }, "RAMScore": { "type": "number", "format": "double", "description": "RAM usage performance score" }, "DiskIOScore": { "type": "number", "format": "double", "description": "Disk I/O performance score" }, "LogonDurationScore": { "type": "number", "format": "double", "description": "Logon duration performance score" }, "ProtocolLatencyScore": { "type": "number", "format": "double", "description": "Protocol latency performance score" }, "InputDelayScore": { "type": "number", "format": "double", "description": "Input delay performance score" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date when this record was created (UTC)" } } }, "Citrix.Monitor.Model.SessionScoreMetricsBulkInsertModel": { "description": "Aggregated session performance (score) metrics collected from uberAgent for a session.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Autogenerated id for SessionScoreMetrics record" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Session Key - Guid of session this SessionScoreMetrics record is associated with" }, "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was collected from source" }, "SumSessionCPUUsagePercent": { "type": "number", "format": "double", "description": "Sum of session CPU usage percent for a session on the VDA." }, "SumSessionMemoryUsagePercent": { "type": "number", "format": "double", "description": "Sum of session memory usage percent for a session on the VDA." }, "SumSessionIOLatencyMs": { "type": "number", "format": "double", "description": "Sum of session I/O latency in milliseconds for a session on the VDA." }, "SumSessionIOCount": { "type": "integer", "format": "int32", "description": "Sum of session I/O count for a session on the VDA." }, "SumSessionRpLatencyMs": { "type": "number", "format": "double", "description": "Sum of session routing protocol latency in milliseconds for a session on the VDA." }, "SessionDetailCount": { "type": "integer", "format": "int32", "description": "Sum of session detail count for a session on the VDA." }, "SumSessionInputDelaySumMs": { "type": "number", "format": "double", "description": "Sum of session input delay in milliseconds for a session on the VDA." }, "SumSessionInputDelayCount": { "type": "integer", "format": "int32", "description": "Sum of session input delay count for a session on the VDA." }, "SessionTotalLogonTimeMs": { "type": "number", "format": "double", "description": "The total logon time for the session, in milliseconds." }, "CollectedDay": { "type": "integer", "format": "int32", "description": "Day component of CollectedDate (1-31) for table partitioning" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Created Date time of this record (UTC time, yyyy-MM-dd HH:mm:ss.SSS)" } } }, "Citrix.Monitor.Model.SfMetrics": { "description": "StoreFront (SF) health metrics.", "required": [ "AgentId", "CollectedDate" ], "type": "object", "properties": { "CollectedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this data is collected from" }, "FetchId": { "type": "string", "format": "uuid", "description": "FetchId to join this component specific data with generic resource utilization data" }, "DomainServiceStatus": { "type": "integer", "format": "int32", "description": "Component Type for the agent." }, "CredentialWalletStatus": { "type": "integer", "format": "int32", "description": "Component Type for the agent." }, "PeerResolutionServiceStatus": { "type": "integer", "format": "int32", "description": "Component Type for the agent." }, "W3ServiceStatus": { "type": "integer", "format": "int32", "description": "Component Type for the agent." }, "IcaCertValidity": { "type": "integer", "format": "int32", "description": "ICA Signing Certificate Validity" }, "IisCertValidity": { "type": "integer", "format": "int32", "description": "IIS Certificate Validity" }, "IsIcaChainValid": { "type": "boolean", "format": "boolean", "description": "ICA signing certificate Chain Validity" }, "IsIisChainValid": { "type": "boolean", "format": "boolean", "description": "IIS certificate Chain Validity" }, "BaseURLStatusCode": { "type": "integer", "format": "int32", "description": "Status Code returned by the base URL" }, "LastBootTime": { "type": "string", "format": "date-time", "description": "Last time the Store Front was rebooted" }, "Version": { "type": "string", "format": "string", "description": "Version of the SF installed" }, "ServerLatencyDetails": { "type": "string", "format": "string", "description": "Server Latency Details" }, "StoreAndFarmDetails": { "type": "string", "format": "string", "description": "Details of the Store and Farm configurations" }, "ServerGroupDetails": { "type": "string", "format": "string", "description": "Details of the Store Front Server Group" }, "InternalBeacon": { "type": "string", "format": "string", "description": "Internal Beacon" }, "ExternalBeacons": { "type": "string", "format": "string", "description": "External Beacons" } } }, "Citrix.Monitor.Model.SpaPreLaunchLoginActivity": { "description": "Represents a Google Chrome Enterprise (CEP) pre-launch login event stored in the SpaGoogleLoginActivity table.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key." }, "GoogleCustomerId": { "type": "string", "format": "string", "description": "Google Workspace customer ID." }, "UserEmail": { "type": "string", "format": "string", "description": "User email address." }, "GoogleDeviceId": { "type": "string", "format": "string", "description": "Google device ID." }, "ChromeProfileId": { "type": "string", "format": "string", "description": "Chrome profile ID." }, "DeviceType": { "type": "string", "format": "string", "description": "Device type." }, "DeviceName": { "type": "string", "format": "string", "description": "Device name." }, "OSVersion": { "type": "string", "format": "string", "description": "Device OS version." }, "Hostname": { "type": "string", "format": "string", "description": "Device hostname." }, "IpAddress": { "type": "string", "format": "string", "description": "Login source IP." }, "EventType": { "type": "string", "format": "string", "description": "Login event type." }, "LoginType": { "type": "string", "format": "string", "description": "Login method type." }, "LoginChallengeMethods": { "type": "string", "format": "string", "description": "MFA challenge methods used." }, "LoginFailureType": { "type": "string", "format": "string", "description": "Failure type if login failed." }, "IsSuspicious": { "type": "boolean", "format": "boolean", "description": "True if flagged as suspicious by Google." }, "LoginTime": { "type": "string", "format": "date-time", "description": "UTC when login occurred." }, "UpdateTime": { "type": "string", "format": "date-time", "description": "UTC when record was last updated." } } }, "Citrix.Monitor.Model.StackMonitoring.DirectorAgentRegistrationStateHistory": { "description": "History of registration state changes for a Director agent.", "required": [ "AgentId", "StartTime" ], "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this state history belongs to" }, "State": { "type": "integer", "format": "int32", "description": "State after transition completed" }, "StartTime": { "type": "string", "format": "date-time", "description": "Start Time when this transition started" }, "EndTime": { "type": "string", "format": "date-time", "description": "End Time when this transition completed" }, "Action": { "type": "integer", "format": "int32", "description": "Whether its an install or upgrade action" }, "Attempt": { "type": "integer", "format": "int32", "description": "Attempt number for this transition" }, "ErrorCode": { "type": "integer", "format": "int32", "description": "Error code if the transition errored out" }, "ErrorMessage": { "type": "string", "format": "string", "description": "Error message if the transition errored out" } } }, "Citrix.Monitor.Model.StackMonitoring.Pvs": { "description": "A Provisioning Services (PVS) record for a machine, capturing the PVS server identity and configuration that links a Director agent to a PVS farm and site.", "required": [ "AgentId" ], "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid", "description": "ID for the agent this data is collected from" }, "FarmId": { "type": "string", "format": "uuid", "description": "Farm ID for the farm that this PVS server is part of" }, "FarmName": { "type": "string", "format": "string", "description": "Farm name for the farm that this PVS server is part of" }, "SiteId": { "type": "string", "format": "uuid", "description": "PVS Site ID for the site that this PVS server is part of" }, "SiteName": { "type": "string", "format": "string", "description": "PVS Site Name for the site that this PVS server is part of" }, "LastBootTime": { "type": "string", "format": "date-time", "description": "PVS Server Last Boot Time" }, "PvsVersionNumber": { "type": "integer", "format": "int32", "description": "The PVS version number" }, "PvsVersion": { "type": "string", "format": "string", "description": "The PVS version" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.Survey": { "description": "Employee Experience Survey definition and configuration. Lifecycle (Scheduled / Active / Expired / Disabled / Deleted) is derived from IsDeleted, IsEnabled, StartDate and EndDate; there is no Status column.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Identity primary key of the Survey row." }, "Name": { "type": "string", "format": "string", "description": "Administrator-supplied display name (max 128 chars)." }, "Description": { "type": "string", "format": "string", "description": "Optional administrator-supplied description (max 256 chars)." }, "IsDeleted": { "type": "boolean", "format": "boolean", "description": "True when the survey has been soft-deleted; it is then hidden from admin listings and never presented to end users." }, "IsEnabled": { "type": "boolean", "format": "boolean", "description": "Administrator enable/disable toggle; a disabled survey is paused (no new presentations) regardless of its scheduled window." }, "CreatedBy": { "type": "string", "format": "string", "description": "Identity of the administrator who created the survey." }, "LastModifiedBy": { "type": "string", "format": "string", "description": "Identity of the administrator who last modified the survey; initially set to the same value as CreatedBy." }, "StartDate": { "type": "string", "format": "date-time", "description": "Inclusive start of the survey activation window (UTC)." }, "EndDate": { "type": "string", "format": "date-time", "description": "Exclusive end of the survey activation window (UTC); must be strictly greater than StartDate." }, "UserSurveyStartTime": { "type": "string", "format": "string", "description": "Optional inclusive start of the per-user time-of-day window in which the survey may be presented, as a 24-hour \"HH:mm\" string (e.g. \"09:00\"). Must be set together with UserSurveyEndTime or left null." }, "UserSurveyEndTime": { "type": "string", "format": "string", "description": "Optional exclusive end of the per-user time-of-day window in which the survey may be presented, as a 24-hour \"HH:mm\" string (e.g. \"11:30\"). Must be strictly greater than UserSurveyStartTime when both are set." }, "IntroMessageEnabled": { "type": "boolean", "format": "boolean", "description": "True when an introduction message is shown before the first invitation; requires IntroMessageText to be populated." }, "IntroMessageText": { "type": "string", "format": "string", "description": "Introduction message body (max 128 chars). Required when IntroMessageEnabled is true." }, "RemindLaterEnabled": { "type": "boolean", "format": "boolean", "description": "True when end users may defer the survey (\"Remind me later\")." }, "SnoozeDurationDays": { "type": "integer", "format": "int32", "description": "Number of days to wait between successive snooze prompts (1 - 30, default 2)." }, "RepeatDisplayCount": { "type": "integer", "format": "int32", "description": "Maximum number of times the survey may be re-displayed to a single user (1 - 10, default 3)." }, "DismissEnabled": { "type": "boolean", "format": "boolean", "description": "True when end users may dismiss the survey without answering." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Row creation timestamp." }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Last modification timestamp." }, "Scopes": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyScope" } }, "Questions": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyQuestion" } }, "Responses": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyResponse" } } } }, "Citrix.Monitor.Model.SurveyAnswer": { "description": "One Rating or Choice answer row. Free-text answers are stored separately in SurveyAnswerFreetext.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity primary key of the SurveyAnswer row." }, "ResponseId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent SurveyResponse." }, "QuestionId": { "type": "integer", "format": "int64", "description": "Foreign key to the SurveyQuestion being answered." }, "AnswerValue": { "type": "integer", "format": "int32", "description": "Numeric answer value: rating point for Rating questions, or OptionValue for Choice questions. One row per selected option for MultipleChoice." }, "Response": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyResponse" }, "Question": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyQuestion" } } }, "Citrix.Monitor.Model.SurveyAnswerFreetext": { "description": "One free-text answer row (FreeText question type only), stored separately from SurveyAnswer. AnswerText is capped at 128 characters.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity primary key of the SurveyAnswerFreetext row." }, "ResponseId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent SurveyResponse." }, "QuestionId": { "type": "integer", "format": "int64", "description": "Foreign key to the SurveyQuestion being answered." }, "AnswerText": { "type": "string", "format": "string", "description": "Free-text answer body (max 128 chars)." }, "Response": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyResponse" }, "Question": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyQuestion" } } }, "Citrix.Monitor.Model.SurveyDGScope": { "description": "One Delivery-Group GUID value belonging to a SurveyScope whose ScopeType is DG.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity primary key of the SurveyDGScope row." }, "ScopeId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent SurveyScope header row." }, "Value": { "type": "string", "format": "uuid", "description": "Delivery-Group GUID that this row contributes to the parent scope." }, "Scope": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyScope" } } }, "Citrix.Monitor.Model.SurveyOptionQuestionValues": { "description": "One selectable option for a SingleChoice / MultipleChoice SurveyQuestion.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Identity primary key of the SurveyOptionQuestionValues row." }, "QuestionId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent SurveyQuestion." }, "OptionText": { "type": "string", "format": "string", "description": "Display text for the option (max 64 chars)." }, "OptionOrder": { "type": "integer", "format": "int32", "description": "1-based ordinal position of this option within its question." }, "OptionValue": { "type": "integer", "format": "int32", "description": "Numeric value persisted to AnswerValue when this option is selected." }, "Question": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyQuestion" } } }, "Citrix.Monitor.Model.SurveyQuestion": { "description": "A single question belonging to a Survey.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity primary key of the SurveyQuestion row." }, "SurveyId": { "type": "integer", "format": "int32", "description": "Foreign key to the parent Survey." }, "QuestionText": { "type": "string", "format": "string", "description": "Question prompt shown to the end user (max 256 chars)." }, "QuestionType": { "type": "integer", "format": "int32", "description": "Kind of question (Rating / SingleChoice / MultipleChoice / FreeText) which determines where the answer is stored and which configuration fields apply. Stored as the byte value of SurveyQuestionType. Exposed as a primitive (not the enum) so the legacy OData v3 / WCF Data Services endpoints can model it; cast to SurveyQuestionType in code. See the ConnectionState pattern on Session for the same convention." }, "DisplayOrder": { "type": "integer", "format": "int32", "description": "1-based ordinal position of this question within its survey." }, "IsRequired": { "type": "boolean", "format": "boolean", "description": "When true, the end user cannot submit the survey without answering this question." }, "RatingMinValue": { "type": "integer", "format": "int32", "description": "Inclusive lower bound of the rating scale; required for Rating, otherwise null." }, "RatingMaxValue": { "type": "integer", "format": "int32", "description": "Inclusive upper bound of the rating scale; required for Rating and must be greater than RatingMinValue." }, "Survey": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Survey" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyOptionQuestionValues" } } } }, "Citrix.Monitor.Model.SurveyResponse": { "description": "One presentation of a Survey to a user; tracks lifecycle (Shown, Submitted, Dismissed, Snoozed) and references back to the answers (SurveyAnswer, SurveyAnswerFreetext).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity primary key of the SurveyResponse row." }, "SurveyId": { "type": "integer", "format": "int32", "description": "Foreign key to the parent Survey." }, "ConnectionId": { "type": "integer", "format": "int64", "description": "Connection on which the survey was presented; logical reference to MonitorData.Connection (no DB FK - Connection grooms independently)." }, "UserId": { "type": "integer", "format": "int64", "description": "User to whom the survey was presented; logical reference to MonitorData.User. Unique together with SurveyId." }, "MachineId": { "type": "string", "format": "uuid", "description": "Machine on which the survey was presented; logical reference to MonitorData.Machine (no DB FK - Machine grooms independently)." }, "UserDisplayName": { "type": "string", "format": "string", "description": "Snapshot of the user's display name at the time of presentation (max 256 chars)." }, "SurveySubmittedDate": { "type": "string", "format": "date-time", "description": "Timestamp at which the user submitted answers; required when Status = Submitted." }, "Status": { "type": "integer", "format": "int32", "description": "Current lifecycle state of this presentation. Stored as the byte value of SurveyResponseStatus. Exposed as a primitive (not the enum) so the legacy OData v3 / WCF Data Services endpoints can model it; cast to SurveyResponseStatus in code." }, "SnoozeCount": { "type": "integer", "format": "int32", "description": "Number of times the user has snoozed this survey (incremented on each \"Remind me later\" choice)." }, "SurveyLastShownDate": { "type": "string", "format": "date-time", "description": "Timestamp at which the survey was most recently shown to the user; used together with SnoozeDurationDays to schedule the next prompt." }, "Survey": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Survey" }, "Answers": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyAnswer" } }, "FreetextAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyAnswerFreetext" } } } }, "Citrix.Monitor.Model.SurveyScope": { "description": "A single targeting rule (DG or Tag) attached to a Survey. The GUID values for DG scopes are stored in SurveyDGScope.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity primary key of the SurveyScope row." }, "SurveyId": { "type": "integer", "format": "int32", "description": "Foreign key to the parent Survey." }, "ScopeType": { "type": "integer", "format": "int32", "description": "Discriminator that selects which child value table holds the matching items (DG -> SurveyDGScope, Tag -> SurveyTagScope, etc.). Stored as the byte value of SurveyScopeType. Exposed as a primitive (not the enum) so the legacy OData v3 / WCF Data Services endpoints can model it; cast to SurveyScopeType in code." }, "IsExcluded": { "type": "boolean", "format": "boolean", "description": "When true, the matching items represent an exclusion list; otherwise they represent an inclusion list." }, "Cohort": { "type": "integer", "format": "int32", "description": "Dynamic-membership marker. Null = explicit list in DGScopes. Stored as the byte value of SurveyScopeCohort. Exposed as a primitive (not the enum) so the legacy OData v3 / WCF Data Services endpoints can model it; cast to SurveyScopeCohort in code." }, "Survey": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Survey" }, "DGScopes": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyDGScope" } } } }, "Citrix.Monitor.Model.Tag": { "description": "A tag definition that can be applied to machines, delivery groups, or applications for filtering and policy targeting.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "Primary key. Unique identifier for the tag." }, "BrokerTagId": { "type": "integer", "format": "int32", "description": "Broker Tag ID" }, "TagName": { "type": "string", "format": "string", "description": "Tag name (for example, \"GPU-Enabled\" or \"Finance-Dept\")." }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Date this object was created" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Date this object was updated or modified" } } }, "Citrix.Monitor.Model.UCAppsOptimizationSummary": { "description": "Unified Communications app optimization status within a session (HDX-optimized media offload vs fallback).", "required": [ "SessionKey", "AppName" ], "type": "object", "properties": { "Session": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" }, "AppName": { "type": "string", "format": "string", "description": "Application name" }, "AppVersion": { "type": "string", "format": "string", "description": "Application version" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "Record creation date" }, "Id": { "type": "integer", "format": "int64", "description": "Unique identifier for the summary record" }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "Record modification date" }, "PluginManagerName": { "type": "string", "format": "string", "description": "Plugin Manager name" }, "PluginManagerStatus": { "type": "boolean", "format": "boolean", "description": "Plugin Manager status" }, "PluginManagerVersion": { "type": "string", "format": "string", "description": "Plugin Manager version" }, "PluginStatus": { "type": "boolean", "format": "boolean", "description": "Plugin status" }, "PluginVersion": { "type": "string", "format": "string", "description": "Plugin version" }, "SessionKey": { "type": "string", "format": "uuid", "description": "Session ID as the foreign key" }, "State": { "type": "integer", "format": "int32", "description": "State of the optimization" }, "VirtualChannelAllowList": { "type": "boolean", "format": "boolean", "description": "Virtual Channel Allow List status" }, "VirtualChannelStatus": { "type": "boolean", "format": "boolean", "description": "Virtual Channel status" } } }, "Citrix.Monitor.Model.VdaAdvisorDataPoint": { "description": "One data point captured during a VdaCollectionRun. DataPointKey is a free-form string, so newer VDAs can introduce new data points without a controller code change.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key for the data point." }, "RunId": { "type": "integer", "format": "int64", "description": "Foreign key to the parent VdaCollectionRun (VdaCollectionRuns entity)." }, "DataPointKey": { "type": "string", "format": "string", "description": "Data point identifier (e.g. \"Citrix.Policy.AppliedPolicies\"). Free-form NVARCHAR so newer VDAs can ship unknown keys without a DDC code change." }, "Status": { "type": "integer", "format": "int32", "description": "0 = Ok, 1 = Error, 2 = Skipped." }, "ValueFormat": { "type": "string", "format": "string", "description": "Format hint (e.g. \"json\", \"string\", \"int\", \"bool\")." }, "Value": { "type": "string", "format": "string", "description": "Opaque to the DDC; consumers interpret based on DataPointKey." }, "ErrorMessage": { "type": "string", "format": "string", "description": "Populated only when Status is Error." }, "Run": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VdaCollectionRun" } } }, "Citrix.Monitor.Model.VdaCollectionRun": { "description": "One execution of the VDA generic collection pipeline for a single machine. Aggregates the data points collected during that run via DataPoints.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key for the collection run." }, "MachineId": { "type": "string", "format": "uuid", "description": "Foreign key to the Machines entity - the machine this run collected data from." }, "StartedAt": { "type": "string", "format": "date-time", "description": "UTC timestamp when the collection run started." }, "CollectorVersion": { "type": "string", "format": "string", "description": "Version of the VDA Advisor collector that produced this run." }, "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "DataPoints": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VdaAdvisorDataPoint" } } } }, "Citrix.Monitor.Model.VdaHealthMetrics": { "description": "Health status metrics for a VDA machine, including Windows service states (one row per machine).", "required": [ "MachineId" ], "type": "object", "properties": { "Machine": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" }, "DesktopGroup": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" }, "DesktopServiceStatus": { "type": "integer", "format": "int32", "description": "Desktop Service Status" }, "ICAServiceStatus": { "type": "integer", "format": "int32", "description": "ICA Service Status" }, "GroupPolicyEngineServiceStatus": { "type": "integer", "format": "int32", "description": "Group Policy Engine Service Status" }, "ProfileManagementServiceStatus": { "type": "integer", "format": "int32", "description": "Profile Management Service Status" }, "MSFTRDSLicenseServiceStatus": { "type": "integer", "format": "int32", "description": "MSFTRDSLicense Service Status" }, "WEMAgentServiceStatus": { "type": "integer", "format": "int32", "description": "WEM Agent Service Status" }, "RemoteDesktopServiceStatus": { "type": "integer", "format": "int32", "description": "Remote Desktop Service Status" }, "UberAgentServiceStatus": { "type": "integer", "format": "int32", "description": "Status of the uberAgent monitoring service on this machine (WindowsServiceStatus)." }, "PvsVDiskName": { "type": "string", "format": "string", "description": "PVS vDisk Name associated with this machine" }, "CreatedDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this health metrics record was created." }, "ModifiedDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this health metrics record was last updated." }, "MachineId": { "type": "string", "format": "uuid", "description": "Primary key. Foreign key to the Machines entity." }, "DesktopGroupId": { "type": "string", "format": "uuid", "description": "Foreign key to the DesktopGroups entity (delivery group the machine belongs to). Null if not assigned." } } }, "Citrix.SpaMonitor.DomainModels.SpaEnumerationApplication": { "description": "An application that appears in a Policy.Evaluation.Enumeration event. ApplicationId is the business identifier string (GUID).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Internal database ID (primary key)." }, "EnumerationId": { "type": "integer", "format": "int64", "description": "Enumeration ID (foreign key to SpaEnumerations)." }, "ApplicationId": { "type": "string", "format": "string", "description": "Application identifier (business key, not a foreign key). This is a string identifier like a GUID, not a reference to SpaApplications.Id." }, "ApplicationName": { "type": "string", "format": "string", "description": "Display name of the application listed in the enumeration." }, "ApplicationStatus": { "type": "string", "format": "string", "description": "Access status of the application, for example \"Allowed\" or \"Denied\"." }, "ApplicationType": { "type": "string", "format": "string", "description": "Classification of the application type." }, "MessageCode": { "type": "integer", "format": "int32", "description": "Status or error message code for this application entry." }, "LaunchTime": { "type": "string", "format": "date-time", "description": "UTC launch time; for enumeration records this reflects when the record was created. Null when not set." }, "TransactionId": { "type": "string", "format": "string", "description": "Correlation transaction ID that ties this entry to related SPA events." }, "AccessedUrl": { "type": "string", "format": "string", "description": "URL the user accessed for this application." }, "AllowedUrls": { "type": "string", "format": "string", "description": "Allowed URL patterns from policy, stored as JSON." }, "Policies": { "type": "string", "format": "string", "description": "SPA policies applied to this application, stored as JSON." }, "SecurityControls": { "type": "string", "format": "string", "description": "Security controls applied to this application, stored as JSON." }, "AppPayloadHash": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "16-byte payload hash for change detection. Computed from all enumeration application fields to enable efficient change detection and reduce LOG IO and DATA IO during updates." }, "Enumeration": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerEnumeration" } } }, "Citrix.SpaMonitor.DomainModels.SpaLatencyMetrics": { "description": "Client-device-side network latency and link telemetry for Citrix Secure Private Access (SPA). Captures CDN ping latency, gateway latency, and connection characteristics such as ISP, interface type, signal strength, and link speed.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key. Auto-incrementing identity column." }, "CollectedDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this metrics row was collected." }, "DeviceId": { "type": "string", "format": "string", "description": "Identifier of the client device that reported the measurements." }, "DeviceName": { "type": "string", "format": "string", "description": "Name of the client device that reported the measurements." }, "PublicIPv4": { "type": "string", "format": "string", "description": "Public IPv4 address of the client device. Nullable." }, "SpaServerIp": { "type": "string", "format": "string", "description": "IPv4 address of the SPA server the client device connected to. Nullable." }, "CdnDestinationFQDN": { "type": "string", "format": "string", "description": "FQDN of the CDN endpoint used for the ping measurement. Nullable." }, "CdnPingLatency": { "type": "number", "format": "double", "description": "Round-trip ping latency from the client device to the CDN endpoint, in milliseconds. Nullable." }, "CDNPingCollectedTime": { "type": "string", "format": "date-time", "description": "UTC timestamp when the CDN ping latency was measured." }, "IsCorporateNetwork": { "type": "boolean", "format": "boolean", "description": "True if the client device was on the corporate network when the measurements were taken." }, "InterfaceType": { "type": "integer", "format": "int32", "description": "Network interface type of the client connection (for example WiFi or Ethernet), encoded as a byte." }, "ISPName": { "type": "string", "format": "string", "description": "Name of the client's internet service provider (ISP). Nullable." }, "IntranetIPv4": { "type": "string", "format": "string", "description": "Intranet (private) IPv4 address of the client device. Nullable." }, "SignalStrength": { "type": "number", "format": "double", "description": "WiFi signal strength of the client connection. Nullable; populated only for wireless interfaces." }, "LinkSpeedInMbps": { "type": "number", "format": "double", "description": "Network link speed of the client connection, in megabits per second (Mbps). Nullable." }, "GatewayName": { "type": "string", "format": "string", "description": "Name of the gateway used to reach the SPA application." }, "GatewayLatency": { "type": "number", "format": "double", "description": "Round-trip latency from the client device to the gateway, in milliseconds. Nullable." }, "GatewayLatencyCollectedTime": { "type": "string", "format": "date-time", "description": "UTC timestamp when the gateway latency was measured." }, "GatewayType": { "type": "integer", "format": "int32", "description": "Routing path used to reach the SPA application, which determines how gateway latency is measured: 0 = SpaService, 1 = OnPremGateway, 2 = DirectApp. See the GatewayType enum." }, "CollectedDay": { "type": "integer", "format": "int32", "description": "Day of month (1-31) derived from CollectedDate; used as the table partitioning key." } } }, "Citrix.SpaMonitor.DomainModels.SpaMonitorConnectorApplianceAppServerMetrics": { "description": "Reachability metrics from a Citrix Secure Private Access (SPA) Connector Appliance to a backend application server, including round-trip time and the resolved backend host.", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key. Auto-incrementing identity column." }, "CollectedDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this metrics row was collected." }, "ConnectorId": { "type": "string", "format": "uuid", "description": "Unique identifier (GUID) of the connector appliance." }, "ConnectorName": { "type": "string", "format": "string", "description": "Name of the connector appliance." }, "ResourceLocationId": { "type": "string", "format": "uuid", "description": "Identifier (GUID) of the resource location the connector appliance belongs to." }, "EventTime": { "type": "string", "format": "date-time", "description": "UTC timestamp of the measurement event as reported by the connector appliance." }, "ServerIp": { "type": "string", "format": "string", "description": "IP address of the backend application server that was probed." }, "Host": { "type": "string", "format": "string", "description": "Backend host (FQDN or hostname) the connector resolved before probing the server IP. Nullable; older connectors that do not emit this field store NULL." }, "RttInMsec": { "type": "number", "format": "double", "description": "Round-trip time from the connector appliance to the backend application server, in milliseconds. A value of -1 indicates the server was unreachable." }, "GatewayFqdn": { "type": "string", "format": "string", "description": "FQDN of the gateway. NULL for cloud rows; non-NULL for hybrid deployments (typical)." }, "GatewaySiteFqdn": { "type": "string", "format": "string", "description": "FQDN of the gateway site. NULL for cloud rows; optional for hybrid deployments (populated only when GSLB resolves to multiple sites)." } } }, "Citrix.SpaMonitor.DomainModels.SpaMonitorConnectorApplianceMetrics": { "description": "Per-Connector-Appliance network latency metrics for Citrix Secure Private Access (SPA), measuring round-trip time from a connector appliance to its gateway point of presence (PoP).", "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Primary key. Auto-incrementing identity column." }, "CollectedDate": { "type": "string", "format": "date-time", "description": "UTC timestamp when this metrics row was collected." }, "ConnectorId": { "type": "string", "format": "uuid", "description": "Unique identifier (GUID) of the connector appliance." }, "ConnectorName": { "type": "string", "format": "string", "description": "Name of the connector appliance." }, "ResourceLocationId": { "type": "string", "format": "uuid", "description": "Identifier (GUID) of the resource location the connector appliance belongs to." }, "EventTime": { "type": "string", "format": "date-time", "description": "UTC timestamp of the measurement event as reported by the connector appliance." }, "GatewayPopName": { "type": "string", "format": "string", "description": "Name of the gateway point of presence (PoP) the connector appliance probed." }, "PublicIp": { "type": "string", "format": "string", "description": "Public IP address of the connector appliance. Nullable." }, "RttInMsec": { "type": "number", "format": "double", "description": "Round-trip time from the connector appliance to the gateway PoP, in milliseconds." }, "RttProbeIntervalInSec": { "type": "integer", "format": "int32", "description": "Interval between round-trip-time probes, in seconds." } } }, "ApplicationActivitySummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationInstanceSummary" } } } }, "ApplicationErrorsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationError" } } } }, "ApplicationFaultsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationFault" } } } }, "ApplicationInstancesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationInstance" } } } }, "ApplicationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Application" } } } }, "AutoScalePredictionsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.AutoScalePrediction" } } } }, "CatalogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Catalog" } } } }, "CloudConnectorServiceStatusGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.CloudConnectorServiceStatus" } } } }, "ComponentResourceUtilizationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ComponentResourceUtilization" } } } }, "ConnectionFailureCategoriesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VShared.ConnectionFailureCategory" } } } }, "ConnectionFailureLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectionFailureLog" } } } }, "ConnectionsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Connection" } } } }, "DesktopGroupsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopGroup" } } } }, "DesktopOSDesktopSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DesktopOSDesktopSummary" } } } }, "DirectorAgentGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DirectorAgent" } } } }, "EndpointMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.EndpointMetrics" } } } }, "FailureLogSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.FailureLogSummary" } } } }, "HotfixesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Hotfix" } } } }, "HypervisorsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Hypervisor" } } } }, "LhcReportGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LhcReport" } } } }, "LoadIndexSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LoadIndexSummary" } } } }, "LoadIndexesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LoadIndex" } } } }, "LogOnMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LogOnMetric" } } } }, "LogOnSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LogOnSummary" } } } }, "MachineCostSavingsSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineCostSavingsSummary" } } } }, "MachineCostsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineCost" } } } }, "MachineFailureLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineFailureLog" } } } }, "MachineHotfixLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineHotfixLog" } } } }, "MachineMetricGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineMetric" } } } }, "MachineMetricSummaryGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineMetricDaySummary" } } } }, "MachineSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineSummary" } } } }, "MachinesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Machine" } } } }, "NotificationActionEmailsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationActionEmail" } } } }, "NotificationEmailAddressesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationEmailAddress" } } } }, "NotificationEmailServerConfigurationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationEmailServerConfiguration" } } } }, "NotificationRuleActionsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleAction" } } } }, "NotificationRuleGroupsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleGroup" } } } }, "NotificationRuleParameterChangeLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleParameterChangeLog" } } } }, "NotificationRuleParametersGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleParameter" } } } }, "NotificationRuleTargetValuesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleTargetValue" } } } }, "NotificationRuleTargetsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRuleTarget" } } } }, "NotificationRulesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationRule" } } } }, "NotificationSnmpConfigurationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationSnmpConfiguration" } } } }, "NotificationTargetsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationTarget" } } } }, "NotificationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.Notification" } } } }, "NotificationsLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationLog" } } } }, "ProbeDesktopGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeDesktop" } } } }, "ProbeEndpointsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeEndPoint" } } } }, "ProbeLogDesktopGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLogDesktop" } } } }, "ProbeLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeLog" } } } }, "ProbeResultDesktopGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeResultDesktop" } } } }, "ProbeResultsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeResult" } } } }, "ProbeRuleApplicationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleApplication" } } } }, "ProbeRuleDesktopGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleDesktop" } } } }, "ProbeRuleEndpointsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRuleEndPoint" } } } }, "ProbeRulesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeRule" } } } }, "ProbeStagesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProbeStage" } } } }, "ProcessDataLimitedMachinesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ProcessDataLimitedMachines" } } } }, "PublishedDesktopNamesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.PublishedDesktopName" } } } }, "ResourceUtilizationGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilization" } } } }, "ResourceUtilizationSummaryGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummary" } } } }, "ServerOSDesktopSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ServerOSDesktopSummary" } } } }, "SessionActivitySummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionActivitySummary" } } } }, "SessionAutoReconnectsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionAutoReconnect" } } } }, "SessionMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionMetrics" } } } }, "SessionMetricsLatestGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionMetricsLatest" } } } }, "SessionRecordingServersGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionRecordingServer" } } } }, "SessionLogonMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.DataService.V4.SessionLogonMetrics" } } } }, "SessionsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Session" } } } }, "SpaApplicationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerApplication" } } } }, "SpaEnumerationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerEnumeration" } } } }, "SpaSessionsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorServerSession" } } } }, "TaskLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.TaskLog" } } } }, "UsersGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.User" } } } }, "ActiveApplicationLaunchesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ActiveApplicationLaunch" } } } }, "ApplicationIdDesktopGroupIdMappingsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationIdDesktopGroupIdMapping" } } } }, "ApplicationNameIdsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationNameId" } } } }, "ApplicationsUsageSummaryDataGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationUsageSummaryData" } } } }, "BlockedUsersGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.BlockedUser" } } } }, "GatewayPopInfoGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.GatewayPopInfo" } } } }, "HistoricalApplicationLaunchesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.HistoricalApplicationLaunch" } } } }, "LocationCoordinatesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.LocationCoordinates" } } } }, "MachineCostAllocationSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineCostAllocationSummary" } } } }, "MachineDiagnosticAlertsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineDiagnosticAlerts" } } } }, "MachineDiagnosticInsightsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineDiagnosticInsights" } } } }, "MachinePowerActionLogsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachinePowerActionLog" } } } }, "MachineSpecsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineSpec" } } } }, "MonthlyCostSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MonthlyCostSummary" } } } }, "NotificationWebhookProfilesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.NotificationWebhookProfile" } } } }, "SessionAccessDeniedGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionAccessDenied" } } } }, "UserMachineLogSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.UserMachineLogSummary" } } } }, "UserResourceUtilizationSummaryGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.UserResourceUtilizationSummary" } } } }, "ActionSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Pnaa.ActionSummary" } } } }, "ApplicationPerformanceMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ApplicationPerformanceMetrics" } } } }, "CcMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.CcMetrics" } } } }, "ConnectorApplianceChildServicesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceChildService" } } } }, "ConnectorApplianceMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceMetrics" } } } }, "ConnectorApplianceProxyDetailsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ConnectorApplianceProxyDetail" } } } }, "DdcMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DdcMetrics" } } } }, "DirectorAgentRegistrationStateHistoryGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.StackMonitoring.DirectorAgentRegistrationStateHistory" } } } }, "DirectorUIThresholdConfigurationGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.DirectorUIThresholdConfiguration" } } } }, "EndpointSecurityEventsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.EndpointSecurityEvents" } } } }, "MachineInventoryMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineInventoryMetrics" } } } }, "MachinePowerActionStatusesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachinePowerActionStatus" } } } }, "MachineTagsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.MachineTag" } } } }, "PvsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.StackMonitoring.Pvs" } } } }, "PvsMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.PvsMetrics" } } } }, "ReconnectSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ReconnectSummary" } } } }, "ResourceUtilizationSummaryLatestMappingGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ResourceUtilizationSummaryLatestMapping" } } } }, "ServiceContinuityMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.ServiceContinuityMetrics" } } } }, "SessionPerformanceSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionPerformanceSummary" } } } }, "SessionScoreMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SessionScoreMetricsBulkInsertModel" } } } }, "SfMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SfMetrics" } } } }, "SpaConnectorApplianceAppServerMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorConnectorApplianceAppServerMetrics" } } } }, "SpaConnectorApplianceMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaMonitorConnectorApplianceMetrics" } } } }, "SpaEnumerationApplicationsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaEnumerationApplication" } } } }, "SpaGoogleLoginActivitiesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SpaPreLaunchLoginActivity" } } } }, "SpaLatencyMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.SpaMonitor.DomainModels.SpaLatencyMetrics" } } } }, "SurveyAnswerFreetextsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyAnswerFreetext" } } } }, "SurveyAnswersGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyAnswer" } } } }, "SurveyDGScopesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyDGScope" } } } }, "SurveyOptionQuestionValuesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyOptionQuestionValues" } } } }, "SurveyQuestionsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyQuestion" } } } }, "SurveyResponsesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyResponse" } } } }, "SurveyScopesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.SurveyScope" } } } }, "SurveysGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Survey" } } } }, "TagsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.Tag" } } } }, "UCAppsOptimizationSummariesGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.UCAppsOptimizationSummary" } } } }, "VdaAdvisorDataPointsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VdaAdvisorDataPoint" } } } }, "VdaCollectionRunsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VdaCollectionRun" } } } }, "VdaHealthMetricsGet200ApplicationJsonResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.Monitor.Model.VdaHealthMetrics" } } } } }, "securitySchemes": { "BearerAuth": { "type": "apiKey", "description": "Cloud auth token", "name": "Authorization", "in": "header", "scheme": "CWSAuth", "bearerFormat": "CWSAuth Bearer=ey1..." } } }, "security": [ { "BearerAuth": [] } ] }