diff --git a/docs/changetracker/8.1/integration/api/api-reference.mdx b/docs/changetracker/8.1/integration/api/api-reference.mdx new file mode 100644 index 0000000000..0cf6fab01d --- /dev/null +++ b/docs/changetracker/8.1/integration/api/api-reference.mdx @@ -0,0 +1,16 @@ +--- +title: API Reference +description: Interactive reference for all ChangeTracker Hub API endpoints +sidebar_position: 25 +--- + +import BrowserOnly from '@docusaurus/BrowserOnly'; + + + {() => { + window.location.replace('/docs/changetracker/8_1/integration/api/reference'); + return null; + }} + + +Redirecting to the [ChangeTracker Hub API Reference](/docs/changetracker/8_1/integration/api/reference)… diff --git a/docs/changetracker/8.1/integration/api/overview.md b/docs/changetracker/8.1/integration/api/overview.md index c853040d0c..fa70d44917 100644 --- a/docs/changetracker/8.1/integration/api/overview.md +++ b/docs/changetracker/8.1/integration/api/overview.md @@ -12,15 +12,21 @@ Netwrix Change Tracker provides a comprehensive REST API that allows customers t All API endpoints require authentication. See [Authentication](/docs/changetracker/8.1/integration/api/authentication.md) for an example script. +## API Reference + +For a complete interactive reference of all Netwrix Change Tracker Hub API endpoints, see the [Netwrix Change Tracker Hub API Reference](/docs/changetracker/8_1/integration/api/reference). The Netwrix Change Tracker Hub (the central management server) generates this reference directly from its OpenAPI 3.0 spec, covering all available endpoints with request/response schemas. + +The raw OpenAPI 3.0 spec (YAML) is also [available for download](/openapi/changetracker-hub-8.1.yaml). + ## Available Endpoints The following API endpoints are available in Netwrix Change Tracker: -- [Agents](/docs/changetracker/8.1/integration/api/agents.md) – Pull data on agent statuses, configurations, and group memberships using the agentsRanked endpoint. This API allows you to retrieve detailed information about all agents in your environment, including their group memberships and applied tracking templates. +- [Agents](/docs/changetracker/8.1/integration/api/agents.md) – Pull data on agent statuses, configurations, and group memberships using the agentsRanked endpoint. Use this API to retrieve detailed information about all agents in your environment, including their group memberships and applied tracking templates. -- [Register Agents](/docs/changetracker/8.1/integration/api/register-agents.md) – Normally used by agents to register with the Hub, but this API allows you to register proxied devices to be accessed through a proxy agent. +- [Register Agents](/docs/changetracker/8.1/integration/api/register-agents.md) – Agents normally use this API to register with the Hub, but you can also use it to register proxied devices accessed through a proxy agent. -- [Credentials](/docs/changetracker/8.1/integration/api/credentials.md) – Manage authentication credentials used by ChangeTracker to connect to various systems and services. This API provides endpoints for creating, retrieving, updating, and deleting credentials for different credential types including Shell, Database, FTP, Cloud, ESX, ITSM, and Splunk. +- [Credentials](/docs/changetracker/8.1/integration/api/credentials.md) – Manage authentication credentials that ChangeTracker uses to connect to various systems and services. This API provides endpoints for creating, retrieving, updating, and deleting credentials for different credential types including Shell, Database, FTP, Cloud, ESX, ITSM, and Splunk. ## API Usage Best Practices @@ -38,7 +44,7 @@ When working with the ChangeTracker API, consider the following best practices: ## Example Usage -Below is a simple example of how to use the API with PowerShell: +The following example shows how to use the API with PowerShell: ```powershell # Set up a session variable for the Admin user @@ -64,4 +70,4 @@ $requestBody = @{ $result = Invoke-RestMethod -Method Post -ContentType application/json -Uri $uri -WebSession $myWebSession -Body $requestBody ``` -For more detailed information about each API endpoint, please refer to the specific API documentation pages linked above. +See the [Available Endpoints](#available-endpoints) section for documentation pages covering each API endpoint. diff --git a/docs/endpointprotector/admin/API Logs/apispecification.md b/docs/endpointprotector/admin/API Logs/apispecification.md new file mode 100644 index 0000000000..18b17d66b5 --- /dev/null +++ b/docs/endpointprotector/admin/API Logs/apispecification.md @@ -0,0 +1,548 @@ +--- +title: "Logs REST API Specification" +description: "Complete endpoint reference for the EPP Logs REST API including request parameters, response fields, and examples" +sidebar_position: 40 +--- + +# Logs REST API Specification + +**Version:** 1.0 +**Base URL:** `https:///api/logs/` +**Protocol:** HTTPS only (TLS 1.2+) +**Content-Type:** `application/json` + +## Authentication + +All requests require authentication via one of these methods (in order of preference): + +| Method | Format | Example | +|---|---|---| +| X-Api-Key header | `X-Api-Key: ` | `X-Api-Key: abc123def456` | +| Bearer token | `Authorization: Bearer ` | `Authorization: Bearer abc123def456` | +| Query parameter | `?api_key=` | `?api_key=abc123def456` | + +API keys are validated against the `api_key` database table. The associated user must be active in `sf_guard_user`. + +If no API key is provided or validated, the API falls back to checking for an active Symfony session cookie (useful when calling the API from the EPP web interface). + +Unauthenticated requests receive: + +```json +{ + "success": false, + "error": { + "code": 401, + "message": "Missing API key. Provide via X-Api-Key header or api_key query parameter." + } +} +``` + +## Common parameters + +All list endpoints support the following query parameters. + +### Pagination + +| Parameter | Type | Default | Description | +|---|---|---|---| +| `page` | integer | 1 | Page number (1-based) | +| `per_page` | integer | 50 | Items per page (max: 200) | + +### Sorting + +| Parameter | Type | Default | Description | +|---|---|---|---| +| `sort_by` | string | `id` | Column to sort by (must be a valid column for the endpoint) | +| `sort_order` | string | `DESC` | Sort direction: ASC or DESC | + +### Date filtering + +| Parameter | Type | Format | Description | +|---|---|---|---| +| `start_date` | string | `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS` | Return records on or after this date | +| `end_date` | string | `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS` | Return records on or before this date | + +The date field used for filtering varies by endpoint (documented per endpoint below). + +### Text search + +| Parameter | Type | Description | +|---|---|---| +| `search` | string | Full-text search across all filterable columns (uses LIKE matching) | + +## Response format + +**Success (single resource)** + +```json +{ + "success": true, + "data": { + "id": "1", + "name": "Example", + "created_at": "2025-01-15 10:30:00" + } +} +``` + +**Success (list with pagination)** + +```json +{ + "success": true, + "data": [ + { "id": "1", "name": "Example 1" }, + { "id": "2", "name": "Example 2" } + ], + "meta": { + "page": 1, + "per_page": 50, + "total": 128, + "total_pages": 3 + } +} +``` + +**Error** + +```json +{ + "success": false, + "error": { + "code": 404, + "message": "Resource not found" + } +} +``` + +## Error handling + +| HTTP Code | Meaning | +|---|---| +| 200 | Success | +| 400 | Bad request (invalid parameters) | +| 401 | Unauthorized (missing or invalid API key) | +| 404 | Resource not found | +| 405 | Method not allowed (only GET is supported) | +| 429 | Rate limit exceeded | +| 500 | Internal server error | + +## Endpoints + +### Event Logs + +Core device control event logs from the `log` table, joined with `event`, `clientmachine`, `clientuser`, `clientdevice`, and `devicetype` tables. + +**GET /event-logs** + +Date field: `eventtime` + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `start_date` | string | Return records on or after this date | +| `end_date` | string | Return records on or before this date | +| `machine_name` | string | Filter by machine name (partial match) | +| `client_name` | string | Filter by client name (partial match) | + +Response fields: + +| Field | Source | Description | +|---|---|---| +| `id` | `log.id` | Log entry ID | +| `machine_id` | `log.machine_id` | Machine ID | +| `machine_name` | `clientmachine.name` | Computer name (resolved via JOIN) | +| `machine_ip` | `clientmachine.ip` | Computer IP address (resolved via JOIN) | +| `client_id` | `log.client_id` | Client user ID | +| `client_username` | `clientuser.username` | Username (resolved via JOIN) | +| `device_type_id` | `log.device_type_id` | Device type ID | +| `device_type_name` | `devicetype.name` | Device type name, e.g. "USB Storage" (resolved via JOIN) | +| `device_id` | `log.device_id` | Device ID | +| `device_name` | `clientdevice.name` | Device name (resolved via JOIN) | +| `event_id` | `log.event_id` | Event ID | +| `event_name` | `event.name` | Event name (resolved via JOIN) | +| `eventtime` | `log.eventtime` | Event timestamp — server time (UTC) | +| `eventtimelocal` | `log.eventtimelocal` | Event timestamp — client local time | +| `filename` | `log.filename` | File name involved | +| `filesize` | `log.filesize` | File size in bytes | +| `filetype_extension` | `log.filetype_extension` | File extension | +| `filenameduplicate` | `log.filenameduplicate` | Duplicate file name | +| `filehash` | `log.filehash` | File hash (MD5) | +| `created_at` | `log.created_at` | Record creation timestamp | +| `created_by` | `log.created_by` | Record creator | + +Example: + +```bash +GET /api/logs/event-logs?machine_name=WORKSTATION&start_date=2025-01-01&per_page=10 +``` + +**GET /event-logs/(id)** + +Returns a single event log entry by ID with the same fields as the list endpoint. + +### Device Control Logs + +Online device tracking logs from the `olog` table, joined with `event`, `devicetype`, `clientmachine`, and `clientdevice` tables. + +**GET /device-control-logs** + +Date field: `eventtime` + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `start_date` | string | Return records on or after this date | +| `end_date` | string | Return records on or before this date | +| `machine_name` | string | Filter by machine name (partial match) | +| `client_name` | string | Filter by client name (partial match) | + +Response fields: + +| Field | Source | Description | +|---|---|---| +| `id` | `olog.id` | Log entry ID | +| `loclogid` | `olog.loclogid` | Local log ID | +| `machine_id` | `olog.machine_id` | Machine ID | +| `machine_name` | `olog.machine_name` | Computer name (denormalized) | +| `ip` | `olog.ip` | Computer IP address (denormalized) | +| `domain` | `olog.domain` | Computer domain | +| `client_id` | `olog.client_id` | Client user ID | +| `client_name` | `olog.client_name` | Username (denormalized) | +| `device_type_id` | `olog.device_type_id` | Device type ID | +| `device_type_name` | `devicetype.name` | Device type name (resolved via JOIN) | +| `device_id` | `olog.device_id` | Device ID | +| `device_name` | `olog.device_name` | Device name (denormalized) | +| `event_id` | `olog.event_id` | Event ID | +| `event_name` | `event.name` | Event name (resolved via JOIN) | +| `machine_serial_number` | `clientmachine.serial_number` | Machine serial number (resolved via JOIN) | +| `device_serial_number` | `clientdevice.serialno` | Device serial number (resolved via JOIN) | +| `eventtime` | `olog.eventtime` | Event timestamp — server time (UTC) | +| `eventtimelocal` | `olog.eventtimelocal` | Event timestamp — client local time | +| `nrfiles` | `olog.nrfiles` | Number of files | +| `alert_flag` | `olog.alert_flag` | Alert flag | +| `filename` | `olog.filename` | File name | +| `filetype` | `olog.filetype` | File type | +| `os_type` | `olog.os_type` | OS type | +| `timestamp` | `olog.timestamp` | Unix timestamp | +| `department_id` | `olog.department_id` | Department ID | + +**GET /device-control-logs/(id)** + +Returns a single device control log entry by ID with the same fields as the list endpoint. + +### Alert Statuses + +**GET /alert-statuses/(id)** + +Returns a single alert status entry by ID. + +Response fields: `id`, `alert_type`, `log_id`, `alert_id`, `status`, `email`, `timestamp` + +### System Alerts + +**GET /system-alerts** + +Lists system alerts, joined with `sys_event` for event names. + +Response fields: `id`, `name`, `sys_event_id`, `event_name` + +**GET /system-alert-logs** + +Lists system alert log entries, joined with `sys_event` for event names. + +Date field: `created_at` + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `start_date` | string | Return records on or after this date | +| `end_date` | string | Return records on or before this date | + +Response fields: `id`, `sys_alert_name`, `sys_event_id`, `sys_event_opt_id`, `created_at`, `event_name` + +### Content Filtering (CAP) Logs + +Content-Aware Protection logs and alerts, joined with `event` table for event names. + +**GET /content-filtering-logs** + +Date field: `eventtime` + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `start_date` | string | Return records on or after this date | +| `end_date` | string | Return records on or before this date | +| `machine_name` | string | Filter by machine name (partial match) | +| `client_name` | string | Filter by client name (partial match) | + +Response fields: `id`, `loclogid`, `event_id`, `machine_id`, `machine_name`, `ip`, `domain`, `client_id`, `client_name`, `destination_type`, `destination`, `filename`, `content_policy`, `content_policy_type`, `item_type`, `matched_item`, `item_details`, `eventtime`, `eventtimelocal`, `alert_flag`, `nr_reports`, `filesize`, `filehash`, `os_type`, `department_id`, `justification`, `event_name` + +:::note +Hash columns (`loghash`, `loghasht`, etc.) are excluded from list responses for performance. Use the detail endpoint to retrieve all fields. +::: + +**GET /content-filtering-logs/(id)** + +Returns a single content filtering log with all fields (including hash columns and `event_name`). + +**GET /content-filtering-alerts** + +Lists content filtering alert definitions, joined with `event` for event names. + +Date field: `created_at` + +Filters: `event_id`, `content_policy`, `department_id` + +Response fields: `id`, `name`, `department_id`, `group_id`, `machine_id`, `client_id`, `content_policy`, `event_id`, `old_alert`, `created_at`, `created_by_user_id`, `event_name` + +**GET /content-filtering-alerts/(id)** + +Returns a single content filtering alert by ID with event name. + +### Mobile Management Logs + +**GET /mobile-management-logs** + +Date field: `eventtime` + +Filters: `mm_device_id`, `action_ck`, `result_code` + +Response fields: `id`, `mm_device_id`, `action_ck`, `action`, `result_code`, `error_code`, `error_message`, `latitude`, `longitude`, `altitude`, `loctime`, `locqual`, `other`, `short_address`, `long_address`, `eventtime` + +**GET /mobile-management-alerts** + +Lists mobile management alert definitions. + +Filters: `mm_device_id`, `mm_event_id` + +Response fields: `id`, `name`, `mm_device_type_id`, `mm_device_id`, `mm_event_id` + +**GET /mobile-management-alert-logs** + +Date field: `created_at` + +Filters: `mm_device_type_id`, `mm_device_id`, `mm_event_id` + +Response fields: `id`, `mm_alert_name`, `mm_device_type_id`, `mm_device_id`, `mm_event_id`, `created_at` + +### EasyLock Logs + +**GET /easylock-alert-logs** + +Date field: `created_at` + +Filters: `el_alert_name`, `el_event_name`, `el_client_name`, `el_device_machine`, `el_device_username`, `sent` + +Response fields: `id`, `el_alert_name`, `el_event_name`, `el_client_name`, `el_device_name`, `el_device_description`, `el_ip`, `el_device_vid`, `el_device_pid`, `el_device_serial`, `el_device_machine`, `el_device_username`, `sent`, `sent_at`, `created_at` + +**GET /easylock-send-alert-logs** + +Lists EasyLock send alert log entries, joined with `el_event` for event names. + +Filters: `event_id`, `machine_id`, `user_id`, `status`, `alert_flag` + +Response fields: `id`, `event_id`, `machine_id`, `user_id`, `group_id`, `status`, `alert_flag`, `description`, `event_name` + +### Data at Rest + +**GET /data-rest-alerts/(id)** + +Returns a single Data-at-Rest alert with event name. + +Response fields: `id`, `name`, `dr_event_id`, `event_name` + +### SCIM Logs + +**GET /scim-logs** + +Lists SCIM API log entries. + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `http_method` | string | Filter by HTTP method (GET, POST, etc.) | +| `endpoint` | string | Filter by API endpoint path | +| `status_code` | string | Filter by HTTP status code | +| `actor` | string | Filter by actor/user | +| `operation` | string | Filter by SCIM operation | +| `resource_type` | string | Filter by resource type (User, Group, etc.) | + +Response fields: `id`, `timestamp`, `request_id`, `http_method`, `endpoint`, `status_code`, `actor`, `operation`, `resource_type`, `external_id`, `duration_ms`, `ip_address`, `user_agent`, `bulk_request_id`, `operation_index` + +:::note +`request_body` and `response_body` are excluded from list responses. Use the detail endpoint. +::: + +**GET /scim-logs/(id)** + +Returns a single SCIM log entry including `request_body` and `response_body`. + +### Authentication Logs + +**GET /auth-logs** + +Lists user authentication attempt logs, joined with `sf_guard_user` for usernames. + +Date field: `created_at` + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `user_id` | integer | Filter by user ID | +| `ip` | string | Filter by IP address (partial match) | +| `block` | integer | Filter by block status | + +Response fields: `id`, `user_id`, `ip`, `number_attempts`, `block`, `created_at`, `expire_at`, `username` + +### Export Logs + +**GET /export-logs/(id)** + +Returns a single export log entry including the `description` field. + +Response fields: `id`, `name`, `log_type`, `status`, `date`, `from_date`, `to_date`, `partitions`, `export_type`, `sf_guard_user_id`, `description` + +### Admin Actions + +**GET /admin-actions** + +Lists administrator action audit trail entries, joined with `sf_guard_user` for usernames. + +Date field: `created_at` + +Filters: + +| Parameter | Type | Description | +|---|---|---| +| `user_id` | integer | Filter by admin user ID | +| `section` | string | Filter by section (e.g. "Device Control") | +| `log_type` | string | Filter by log type | +| `operation` | string | Filter by operation performed | +| `search` | string | Search across section, log_type, operation, and username | + +Response fields: `id`, `user_id`, `created_at`, `section`, `log_type`, `operation`, `username` + +:::note +`before_desc` and `after_desc` LONGTEXT fields are excluded from list responses for performance. +::: + +## Usage examples + +**List recent device control logs for a specific machine** + +```bash +curl -s -k \ + -H "X-Api-Key: YOUR_API_KEY" \ + "https://epp-server/api/logs/device-control-logs?machine_name=WORKSTATION&sort_by=eventtime&sort_order=DESC&per_page=10" +``` + +**Get content filtering logs for a date range** + +```bash +curl -s -k \ + -H "X-Api-Key: YOUR_API_KEY" \ + "https://epp-server/api/logs/content-filtering-logs?start_date=2025-01-01&end_date=2025-01-31&content_policy=PCI" +``` + +**Get a specific event log entry** + +```bash +curl -s -k \ + -H "X-Api-Key: YOUR_API_KEY" \ + "https://epp-server/api/logs/event-logs/12345" +``` + +## Database tables reference + +| Endpoint Group | Primary Table | Joined Tables | +|---|---|---| +| Event Logs | `log` | `event`, `clientmachine`, `clientuser`, `clientdevice`, `devicetype` | +| Device Control | `olog` | `event`, `devicetype`, `clientmachine`, `clientdevice` | +| Alert Statuses | `alert_status` | — | +| System Alerts | `sys_alert`, `sys_alert_log` | `sys_event` | +| Content Filtering | `cf_log`, `cf_alert` | `event` | +| Mobile Management | `mm_log`, `mm_alert`, `mm_alert_log` | — | +| EasyLock | `el_alert_log`, `el_send_alert_log` | `el_event` | +| Data at Rest | `dr_alert` | `dr_event` | +| SCIM Logs | `scim_log` | — | +| Auth Logs | `sf_guard_log` | `sf_guard_user` | +| Export Logs | `export_log_list` | — | +| Admin Actions | `admin_action` | `sf_guard_user` | + +## Rate limiting + +The API enforces two independent rate limits using a fixed-window counter: + +1. **Global limit** — caps total requests across all users combined (server protection) +2. **Per-user limit** — caps requests per authenticated user or IP (fairness) + +Both checks happen on every request. Whichever limit triggers first returns a 429 response. + +### Configuration + +Rate limit parameters are configured in `api_config.php`: + +| Parameter | Type | Default | Description | +|---|---|---|---| +| `rate_limit_enabled` | boolean | `true` | Enable or disable all rate limiting | +| `rate_limit_global_requests` | integer | 200 | Max requests per window across all users | +| `rate_limit_global_window` | integer | 60 | Global window in seconds | +| `rate_limit_user_requests` | integer | 60 | Max requests per window per user | +| `rate_limit_user_window` | integer | 60 | Per-user window in seconds | + +With defaults: 200 requests/minute globally, 60 requests/minute per user. + +### Response headers + +Every API response includes per-user rate limit headers: + +| Header | Description | +|---|---| +| `X-RateLimit-Limit` | Per-user maximum requests per window | +| `X-RateLimit-Remaining` | Per-user requests remaining in the current window | +| `X-RateLimit-Reset` | Unix timestamp when the per-user window resets | + +### Rate limit exceeded (429) + +When the per-user limit is exceeded: + +```json +{ + "success": false, + "error": { + "code": 429, + "message": "Rate limit exceeded. Maximum 60 requests per 60 seconds." + } +} +``` + +When the global limit is exceeded: + +```json +{ + "success": false, + "error": { + "code": 429, + "message": "Global rate limit exceeded. Maximum 200 requests per 60 seconds across all users." + } +} +``` + +The response also includes a `Retry-After` header (in seconds) indicating when the client may retry. + +## CORS + +The API includes CORS headers allowing cross-origin requests from any origin. The OPTIONS preflight response includes: + +- `Access-Control-Allow-Origin: *` +- `Access-Control-Allow-Methods: GET, OPTIONS` +- `Access-Control-Allow-Headers: Content-Type, X-Api-Key, Authorization` +- `Access-Control-Max-Age: 86400` diff --git a/docs/endpointprotector/admin/API Logs/logrestapi.md b/docs/endpointprotector/admin/API Logs/logrestapi.md new file mode 100644 index 0000000000..72f04577b7 --- /dev/null +++ b/docs/endpointprotector/admin/API Logs/logrestapi.md @@ -0,0 +1,306 @@ +--- +title: "Logs REST API" +description: "Query Endpoint Protector log data over HTTPS for integrations and reporting" +sidebar_position: 10 +--- + +# Logs REST API + +## Overview + +The Logs REST API provides a read-only interface to query Endpoint Protector logs and audit trails over HTTPS in JSON format. Use it for: + +- SIEM ingestion and SOC workflows +- Custom reporting dashboards +- Incident investigations and audits +- Automation and integrations with internal tools + +:::info +The Logs REST API is read-only. It supports GET (and OPTIONS for CORS preflight). Other methods return 405 Method Not Allowed. +::: + +## Base URL and protocol + +- Base URL: `https:///api/logs/` +- HTTPS only (TLS 1.2+) +- Content-Type: `application/json` + +## Authentication + +All requests require authentication using an API key: + +| Method | Header / Format | Example | +|---|---|---| +| Recommended | `X-Api-Key: ` | `X-Api-Key: abc123...` | +| Alternative | `Authorization: Bearer ` | `Authorization: Bearer abc123...` | +| Alternative | Query parameter | `?api_key=abc123...` | + +:::note +When called from the Endpoint Protector web interface, the API can also use an active server session cookie. For external integrations, always use an API key. +::: + +## Quick start + +**1) List supported endpoints (discovery)** + +```bash +curl -s \ + -H "X-Api-Key: YOUR_API_KEY" \ + "https:///api/logs/endpoints" +``` + +:::note +If your Endpoint Protector server uses a self-signed certificate, add `-k` to the curl command to ignore TLS verification. For production environments, use a certificate trusted by your clients instead. +::: + +**2) Query recent Device Control logs** + +```bash +curl -s \ + -H "X-Api-Key: YOUR_API_KEY" \ + "https:///api/logs/device-control-logs?sort_by=eventtime&sort_order=DESC&per_page=10" +``` + +## Common query parameters + +Most list endpoints support the following parameters. + +### Pagination + +| Parameter | Type | Default | Notes | +|---|---|---|---| +| `page` | integer | 1 | 1-based | +| `per_page` | integer | 50 | Max 200 | + +### Sorting + +| Parameter | Type | Default | +|---|---|---| +| `sort_by` | string | `id` | +| `sort_order` | string | `DESC` (ASC or DESC) | + +### Date filtering + +| Parameter | Format | Notes | +|---|---|---| +| `start_date` | `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS` | inclusive | +| `end_date` | `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS` | inclusive | + +:::note +The date field used for filtering depends on the endpoint (documented in each endpoint section below). +::: + +### Text search + +| Parameter | Type | Notes | +|---|---|---| +| `search` | string | LIKE matching across filterable fields | + +## Response format + +**Success (single resource)** + +```json +{ + "success": true, + "data": { + "id": "1" + } +} +``` + +**Success (list with pagination)** + +```json +{ + "success": true, + "data": [ + { "id": "1" }, + { "id": "2" } + ], + "meta": { + "page": 1, + "per_page": 50, + "total": 128, + "total_pages": 3 + } +} +``` + +**Error** + +```json +{ + "success": false, + "error": { + "code": 401, + "message": "Missing API key. Provide via X-Api-Key header or api_key query parameter." + } +} +``` + +## HTTP status codes + +| Code | Meaning | +|---|---| +| 200 | Success | +| 400 | Invalid parameters | +| 401 | Missing/invalid API key | +| 404 | Resource not found | +| 405 | Method not allowed (GET-only) | +| 429 | Rate limit exceeded | +| 500 | Internal error | + +--- + +## Logs REST API Technical Reference + +### Discovery + +**GET /endpoints** + +Returns API name/version and a list of supported routes for the current server build. + +### Event Logs + +Core device control event logs. + +**GET /event-logs** + +Date field: `eventtime` + +Filters (in addition to common params): +- `machine_name` (partial match) +- `client_name` (partial match) + +**GET /event-logs/(id)** + +Returns a single event log entry by ID. + +### Device Control Logs + +Online device tracking logs. + +**GET /device-control-logs** + +Date field: `eventtime` + +Filters (in addition to common params): +- `machine_name` (partial match) +- `client_name` (partial match) + +**GET /device-control-logs/(id)** + +Returns a single device control log entry by ID. + +### Alert Statuses + +**GET /alert-statuses/(id)** + +Returns a single alert status entry by ID. + +### System Alerts + +**GET /system-alerts** + +Lists system alert definitions. + +**GET /system-alert-logs** + +Lists system alert log entries. Date field: `created_at` + +### Content Filtering (CAP) + +**GET /content-filtering-logs** + +Lists Content Aware Protection logs. Date field: `eventtime` + +Common filters include: +- `machine_name` +- `client_name` + +**GET /content-filtering-logs/(id)** + +Returns a single log entry (includes fields excluded from list responses for performance). + +**GET /content-filtering-alerts** + +Lists content filtering alert definitions. + +**GET /content-filtering-alerts/(id)** + +Returns a single alert definition. + +### Mobile Management + +**GET /mobile-management-logs** + +Date field: `eventtime` + +**GET /mobile-management-alerts** + +Lists mobile management alert definitions. + +**GET /mobile-management-alert-logs** + +Date field: `created_at` + +### EasyLock (Enforced Encryption) + +**GET /easylock-alert-logs** + +Date field: `created_at` + +**GET /easylock-send-alert-logs** + +Lists EasyLock send alert log entries. + +### Data at Rest (eDiscovery) + +**GET /data-rest-alerts/(id)** + +Returns a single Data-at-Rest alert entry by ID. + +### SCIM Provisioning Logs + +**GET /scim-logs** + +Lists SCIM API request logs. + +**GET /scim-logs/(id)** + +Returns a single SCIM log entry including request/response bodies. + +### Authentication Logs + +**GET /auth-logs** + +Lists authentication attempt logs. Date field: `created_at` + +### Export Logs + +**GET /export-logs/(id)** + +Returns a single export job log entry by ID. + +### Admin Actions + +**GET /admin-actions** + +Lists administrator actions performed in the console. Date field: `created_at` + +## Rate limiting + +The API enforces rate limiting to protect the server and ensure fair usage. When exceeded, the API returns: + +- HTTP 429 +- `Retry-After` header +- `X-RateLimit-*` headers describing the remaining request budget + +## CORS + +CORS is enabled to support browser-based integrations: + +- `Access-Control-Allow-Origin: *` +- `Access-Control-Allow-Methods: GET, OPTIONS` +- `Access-Control-Allow-Headers: Content-Type, X-Api-Key, Authorization` diff --git a/docs/endpointprotector/admin/appliance.md b/docs/endpointprotector/admin/appliance.md index fd94e34959..3e5e190740 100644 --- a/docs/endpointprotector/admin/appliance.md +++ b/docs/endpointprotector/admin/appliance.md @@ -360,6 +360,8 @@ The standard format for the Device Control fields is as follows: - [Date/Time(Client)] - [Date/Time(Server UTC)] - [Date/Time(Client UTC)] +- [Shadow Exists] +- [Repository Type] #### Content Aware Protection @@ -395,6 +397,9 @@ The standard format for the Content Aware Protection fields is as follows: - [Date/Time(Client)] - [Date/Time(Server UTC)] - [Date/Time(Client UTC)] +- [Certificate State] +- [Shadow Exists] +- [Repository Type] #### E-Discovery diff --git a/docs/endpointprotector/admin/cap_module/cappolicies.md b/docs/endpointprotector/admin/cap_module/cappolicies.md index ae12951fa2..52647c4aec 100644 --- a/docs/endpointprotector/admin/cap_module/cappolicies.md +++ b/docs/endpointprotector/admin/cap_module/cappolicies.md @@ -175,7 +175,10 @@ To distinguish OneDrive for Business from OneDrive, enable Deep Packet Inspectio ::: :::warning -After an EPP Server upgrade, if your CAP policy Exit points are configured by selecting a whole category, edit the policy and review the application list to ensure any newly added apps are included. Click **Save** to push the updated configuration to EPP Clients. +If your policy uses **All Applications** and new applications are introduced in a server update, +those applications will appear as selected but won't be enforced until the policy is re-saved. +After upgrading, open any affected CAP policies and save them to apply monitoring to newly +added applications. ::: diff --git a/docs/endpointprotector/admin/dc_module/globalsettings.md b/docs/endpointprotector/admin/dc_module/globalsettings.md index 920d3ef60c..c24b2d776b 100644 --- a/docs/endpointprotector/admin/dc_module/globalsettings.md +++ b/docs/endpointprotector/admin/dc_module/globalsettings.md @@ -247,6 +247,8 @@ Select from the drop-down list a client mode to define the Endpoint Protector C - Not display system tray notifications - Apply all set rights and settings as per their configuration + When Hidden Icon mode is selected, the **Show notifications in Hidden Icon mode** setting becomes available under the Client Mode section. This setting is disabled by default. Enable it to allow client notifications to be displayed while the Endpoint Protector Client icon remains hidden. + 6. Silent - this mode is similar to Normal mode, except that pop-up notifications are not visible to the user. @@ -901,10 +903,10 @@ On the Global > Computer > User Settings page, configure the following settings **Step 1 –** Enable **Debug Mode** from the DEBUG logging section. **Step 2 –** Click and select an option on the **set logs level** (None, Error, Warning, -Informational, Debug) drop down. +Informational, Debug) drop down. For new deployments, the default level is **Error**. **Step 3 –** For Error, Warning, Informational, and Debug log levels select **obfuscate sensitive -data**. +data**. For new deployments, **Obfuscate Sensitive Data** is enabled by default. **Step 4 –** **Save.** diff --git a/docs/endpointprotector/admin/denylistsallowlists/NDCClassification.png b/docs/endpointprotector/admin/denylistsallowlists/NDCClassification.png index 01a4715d25..001189e5ed 100644 Binary files a/docs/endpointprotector/admin/denylistsallowlists/NDCClassification.png and b/docs/endpointprotector/admin/denylistsallowlists/NDCClassification.png differ diff --git a/docs/endpointprotector/admin/denylistsallowlists/denylists.md b/docs/endpointprotector/admin/denylistsallowlists/denylists.md index 1875b98e51..2a2e262cc2 100644 --- a/docs/endpointprotector/admin/denylistsallowlists/denylists.md +++ b/docs/endpointprotector/admin/denylistsallowlists/denylists.md @@ -401,30 +401,40 @@ future releases. ![Confguration for Microsoft Information Protection (MIP) ](mipclassification.webp) + ## NDC Classification -This section covers the use of and integration with Netwrix Data Classification, including classification within Content Aware Protection and eDiscovery policies. +This section covers the use of and integration with Netwrix Data Classification (NDC), including classification within Content Aware Protection and eDiscovery policies. -Netwrix Data Classification is a tool designed to help organizations manage and protect their data more effectively by identifying, categorizing, and tagging data based on predefined policies. It assists in understanding where sensitive and valuable data resides, how it is being used, and who has access to it. The primary goals of data classification include enhancing data security, optimizing data management, ensuring compliance with regulations, and facilitating informed decision-making. +Netwrix Data Classification helps organizations identify, categorize, and tag data based on predefined policies. With NDC, you can understand where sensitive data resides, how it is used, and who has access to it, which supports data security, regulatory compliance, and informed decision-making. -Starting with the 25.12 release, Endpoint Protector allows direct label definition for Content Aware -Protection and eDiscovery policies via the Endpoint Protector Server interface. +Starting with the 25.12 release, Endpoint Protector allows direct NDC label definition for Content Aware Protection and eDiscovery policies through the Endpoint Protector Server interface, so you do not need to build custom dictionaries to recognize labeled files. + +![Configuration for Netwrix Data Classification](NDCClassification.png) -The Endpoint Protector Server offers the option to define custom labels for policy use like for ex. "ex. Confidential" in: -- keywords field -- document label custom field -- both +### Configure an NDC label -This flexibility allows administrators to avoid creating custom dictionaries to recognize labeled files. +Each NDC entry in a denylist defines a single classification to match against Office document properties. Configure the following fields: -NDC labels can be used along other CAP conditions, including content-aware and label-aware data scanning. This enables granular control over data protection based on NDC data classifications. +- **Name** — the name of the denylist entry. +- **Description** — an optional description of the entry. +- **NDC name property value** — the **Field Name** value defined in NDC. NDC stores this as a custom property name in the Office document. Obtain the value from your NDC administrator. +- **NDC label value** — the label value assigned in NDC. NDC stores this as a custom property value in the Office document. Obtain the value from your NDC administrator. +- **Look for** — controls which properties Endpoint Protector scans. See [Look for options](#look-for-options) for the behavior of each choice. :::note -Label names can be obtained from the NDC administrator. Consider using the exact label definition, such as 'Confidential|Internal' to narrow detection. +Each NDC entry is uniquely identified by the combination of **NDC name property value** and **NDC label value**. You can configure multiple entries that share the same property name with different label values — for example, `Sensitivity = Confidential` and `Sensitivity = Restricted`. ::: -![Confguration for Netwrix Data Classification](NDCClassification.png) +### Look for options + +Use the **Look for** field to control how Endpoint Protector matches the classification on a scanned document: + +- **NDC name property value** — scans only after the NDC name property value is defined, and ignores all other properties. The **NDC label value** field can be left empty. +- **NDC label value** — scans only after the NDC label value is defined, and ignores all other properties. The **NDC name property value** field can be left empty. +- **Both NDC name property + label value** — scans for both the NDC name property and the corresponding label value, as configured. +- **Keywords** — scans only for the NDC label in the **Keywords** document property, which supports alternative NDC label detection. :::note -The NDC labeling feature is supported only on EPP Clients version 2605.x.x.x and later. +The NDC labeling feature is supported only on Endpoint Protector Client version 2605.x.x.x and later. ::: \ No newline at end of file diff --git a/docs/endpointprotector/admin/reports.md b/docs/endpointprotector/admin/reports.md index 1a21dd230f..801d56bf79 100644 --- a/docs/endpointprotector/admin/reports.md +++ b/docs/endpointprotector/admin/reports.md @@ -110,9 +110,11 @@ following information: ![Count – the number of matched items](matcheditemscount.webp) +Use the **Show/Hide Columns** dropdown to customize which columns are visible in the report. The **Date/Time(Client UTC)** column is available in this dropdown but is hidden by default. + From the Filters section, check the **Include old logs prior to 5.7** upgrade option from the filter section to include all logs in your searches. If the option is not selected, the filters will apply -only to the new structure of logs. +only to the new structure of logs. The **Date/Time(Client UTC)** field is also available as a filter option. ![Content Aware Protection Filters](capfilters.webp) @@ -132,7 +134,7 @@ You can export Content Aware Logs as an Excel, PDF, or CSV or create and export report as a CSV or XLSX file. Excel/PDF/CSV – situated above the Content Aware Reports list, this will export only the default -columns +columns. The **Date/Time(Client UTC)** column is included in exports when selected via Show/Hide Columns. ![Export Content Aware Reports](exportreports.webp) diff --git a/docs/endpointprotector/admin/systemconfiguration/OAuthMailSettings.png b/docs/endpointprotector/admin/systemconfiguration/OAuthMailSettings.png new file mode 100644 index 0000000000..314f74cf1c Binary files /dev/null and b/docs/endpointprotector/admin/systemconfiguration/OAuthMailSettings.png differ diff --git a/docs/endpointprotector/admin/systemconfiguration/mailserverlogs.png b/docs/endpointprotector/admin/systemconfiguration/mailserverlogs.png new file mode 100644 index 0000000000..1efa34874a Binary files /dev/null and b/docs/endpointprotector/admin/systemconfiguration/mailserverlogs.png differ diff --git a/docs/endpointprotector/admin/systemconfiguration/mailsettings.md b/docs/endpointprotector/admin/systemconfiguration/mailsettings.md new file mode 100644 index 0000000000..5d6a537bce --- /dev/null +++ b/docs/endpointprotector/admin/systemconfiguration/mailsettings.md @@ -0,0 +1,150 @@ +--- +title: "Mail Settings" +description: "Configure email server settings and OAuth 2.0 authentication for Microsoft Exchange Online" +sidebar_position: 35 +--- + +![OAuth Email Settings](OAuthMailSettings.png) + + +# Mail Settings + +From this section, you can configure the email server settings that Endpoint Protector uses to send notifications, alerts, and test emails. + +## E-mail Authorization Required + +When **OAuth** is selected as the E-mail Authentication Type, authorization is required to complete the email setup. Click **Sign In** to grant Endpoint Protector access to send emails on your behalf. + +## Administrator E-mail + +The test email is sent to the address configured for your administrator account. If no email address is set, the message *"There is no e-mail defined for your Administrator Account. You must setup the e-mail address from System Administrators > Edit info"* is displayed. + +To set an email address, go to **System Configuration** > **System Administrators** and select **Edit info**. + +## E-mail Server Settings + +Configure the email server that Endpoint Protector uses to send notifications and alerts. + +:::note +An active Internet connection is required to use this feature. +::: + +### E-mail Authentication Type + +Use the **E-mail Authentication Type** dropdown to select how Endpoint Protector authenticates with the email server: + +- **Basic** — standard username and password authentication. Supports native and SMTP email types, with TLS 1.3. +- **OAuth** — OAuth 2.0 authentication for Microsoft Exchange Online. Use this option to comply with Microsoft's deprecation of Basic Auth for SMTP AUTH. + +### Basic authentication + +When **Basic** is selected, configure the following fields: + +- E-mail Type — select **Native** or **SMTP** +- Hostname +- SMTP Port +- Username +- Password + +### OAuth authentication + +When **OAuth** is selected, configure the following fields: + +- **E-mail Type** — SMTP (read-only) +- **E-mail Provider** — Microsoft (read-only) +- **Hostname** — recommended: `smtp.office365.com` +- **SMTP Port** — recommended: `587` +- **Username** +- **Tenant ID** +- **Application (Client) ID** +- **Client Secret Value** +- **Redirect URI** — must match the redirect URI registered in your Microsoft Azure application + +After filling in all fields, click **Sign In** to complete OAuth authorization. + +:::note +The redirect URI saved in Mail Settings must exactly match the redirect URI registered in your Microsoft Azure application. +::: + +### Microsoft Azure prerequisites + +OAuth is supported for Microsoft Exchange Online. Your subscription must be one of the following: + +- Microsoft 365 Business Basic, Standard, or Premium +- Office 365 E1, E3, or E5 +- Microsoft 365 E3 or E5 +- Exchange Online Plan 1 or 2 + +**Step 1 –** In the Microsoft Admin Center, go to **Users** > **Active Users**, select the user, and then go to **Mail** > **Manage email apps**. Enable **Authenticated SMTP**. + +**Step 2 –** In Microsoft Azure, go to your app **Overview** > **Manage** > **Redirect URIs**. Click **Add a platform**, select **Web**, and enter the redirect URI (for example, `https://192.168.0.2/index.php`). + +**Step 3 –** Go to **Client Credentials** > **Client Secrets**. Create a new client secret and copy the value. + +**Step 4 –** Go to **API Permissions** > **Add a permission** > **Microsoft Graph** > **Delegated Permissions**. Select **SMTP.Send** and **offline_access**, then click **Grant admin consent** for the selected permissions. + + +## Mail Server Logs + +From the **Mail Server Logs** tab you can review the errors captured when Endpoint Protector tries to send a message through the configured email server. Use this view to troubleshoot delivery failures directly from the UI instead of opening a shell on the appliance. + +Access the logs from **System Configuration** > **Mail Settings** > **Mail Server Logs** tab. + +### Log columns + +| Column | Description | +|---|---| +| Authentication Type | Whether the send attempt used **Basic** or **OAuth** authentication | +| Status | Status of the captured event (currently `error` for all entries) | +| Log Message | Human-readable error, including the SMTP return code or OAuth error code reported by the server | +| Registered at | Server timestamp when the error was captured | +| Mail Settings | Click the row to expand and review the mail server configuration in effect at the time of the error | + +### What gets logged + +The tab captures the following error categories when encountered during a send attempt: + +- **DNS / hostname resolution failures** — for example, *Could not resolve hostname `smtp.office365.com`* +- **Connection timeouts** — for example, *Connection timed out after 30 seconds while connecting to `smtp.office365.com:587`* +- **TLS/SSL handshake failures** — for example, *TLS handshake failed - peer certificate validation error* +- **SMTP server return codes** — including authentication failures (`535`), invalid recipients (`550`), service throttling (`421`), and policy rejections (`554`) +- **OAuth errors** — Microsoft Azure error codes such as `AADSTS50011` (redirect URI mismatch), `AADSTS700082` (refresh token expired), and `AADSTS7000215` (invalid client secret) + +### Row details + +Click any row to expand it and review the **Mail Settings** snapshot that was active at the time of the error. The snapshot includes: + +- **Basic** entries — Hostname, SMTP Port, Username, Encryption Type +- **OAuth** entries — Hostname, SMTP Port, Username, Tenant ID, Application (Client) ID, Redirect URI + +:::note +The Client Secret and the OAuth access and refresh tokens are never written to the logs. +::: + +### Supplemental log files + +Errors are also written to log files on the appliance for additional context and for cases not captured by the UI: + +| Scenario | Log file | +|---|---| +| OAuth errors and SMTP errors over SSL/TLS | `/var/eppfiles/epp_logger/epp_mail.log` | +| Basic authentication using SMTP with TLS 1.3 | `/var/log/mail.log` | + +:::note +Basic authentication errors that occur over SMTP with TLS 1.3 are written only to `/var/log/mail.log` and are not shown in the Mail Server Logs tab. To review those errors, open the file directly on the appliance. +::: + + +## UI messages + +The following messages are displayed during email configuration and testing: + +| Situation | Message | +|---|---| +| Test email sent successfully | A test e-mail was sent to `
` | +| No administrator email configured | There is no e-mail defined for your Administrator Account. You must setup the e-mail address from System Administrators > Edit info | +| Test email failed to send | Failed to send the test e-mail! Please verify if the E-mail Server Settings are correct! | +| OAuth authorization failed | Email authorization failed! Please check the provided credentials and try again! | +| Settings saved successfully | Changes have been saved! | +| OAuth authorization completed | Your email has been verified. Authorization complete! | +| Error saving settings | Cannot execute command! An error occurred! | diff --git a/docs/endpointprotector/admin/systemconfiguration/systemsettings.md b/docs/endpointprotector/admin/systemconfiguration/systemsettings.md index bf0e8a9787..d9e4ca3f8d 100644 --- a/docs/endpointprotector/admin/systemconfiguration/systemsettings.md +++ b/docs/endpointprotector/admin/systemconfiguration/systemsettings.md @@ -508,22 +508,11 @@ the System Administrators section. ## E-mail Server Settings -![E-mail Server Settings](mailserversettings.webp) - -Manage Email server settings based on the email type you use - native or SMTP. - -:::note -To enable this feature, you need an Internet connection. +:::warning +The E-mail Server Settings have been moved to a new section. Go to **System Configuration** > **[Mail Settings](/docs/endpointprotector/admin/systemconfiguration/mailsettings.md)** to configure email server settings and authentication. ::: - -Manage email server settings based on your email type—native or SMTP, with support for TLS 1.3. - -![E-mail Server Settings](mailserversettingstwo.webp) - -![E-mail Server Settings](mailserversettingsthree.webp) - -### Proxy Server Settings +## Proxy Server Settings Configure Proxy server settings by managing the following: diff --git a/docs/endpointprotector/admin/systemmaintenance/backup.md b/docs/endpointprotector/admin/systemmaintenance/backup.md index 967331eca3..e0d8998beb 100644 --- a/docs/endpointprotector/admin/systemmaintenance/backup.md +++ b/docs/endpointprotector/admin/systemmaintenance/backup.md @@ -16,6 +16,31 @@ The System Backup feature allows you to create and manage comprehensive backups Using the web interface or administrative console, you can perform backups, restore previous versions, and set up automatic routines to ensure your data is consistently protected. +### Migration readiness checklist (preflight validation) + +Before creating a migration backup and restoring it on a new Endpoint Protector Server, validate the +items below to avoid failed imports/restores. + +#### Source appliance (current server) +- Ensure you can successfully create a **System Backup v2 (Migration)** and that you securely save + the **System Backup Key** (required for restore). +- Download any **previous System Backups** or **Audit Log Backups** you want to keep (these are not + preserved through the migration process). +- Confirm the resulting backup file is within the supported size limits (see note below). If it is not, + contact Customer Support before proceeding. + +#### Target appliance (new server) +- Deploy the new Endpoint Protector Server on a **newer version** than the source (migration restore + is intended for a newer server version). +- Ensure the new appliance has enough free disk space for the restore operation (backup file + temporary restore data). +- Plan the cutover: after restore, **power off the old appliance** and **reassign its IP** to the new one so + existing clients reconnect. + +:::warning +If your migration involves upgrading the server from a pre-5206 version to 5.7.0.0, database partitions +must be enabled prior to the upgrade. Contact Customer Support for assistance. +::: + ### Creating a System Backup v2 (Migration) You can create a new migration backup from the System Maintenance, System Backup v2 section. diff --git a/docs/endpointprotector/admin/systemmaintenance/overview.md b/docs/endpointprotector/admin/systemmaintenance/overview.md index e5ff6ad608..0182c139d3 100644 --- a/docs/endpointprotector/admin/systemmaintenance/overview.md +++ b/docs/endpointprotector/admin/systemmaintenance/overview.md @@ -102,6 +102,8 @@ The Backup export CSV file will differ based on the Endpoint Protector Server v - For Endpoint Protector 5.7.0.0, reports, only one file containing all threats discovered, separated by an underscore +When backing up Content Aware logs, the export includes the **Date/Time(Client UTC)** field. + :::warning The audit log backups feature allows you to create copies and/or dumps of logs and file shadows into an export file, either manually or on a scheduled basis. Please note that the initial storage location for these export files is not suitable for long-term storage. It is essential that administrators download and store these files in secure locations to ensure their safety. In SaaS environments, be aware that export files may be lost during the upgrade process, so regular downloading and secure storage are crucial. ::: diff --git a/docs/endpointprotector/install/virtualappliance/setupwizard.md b/docs/endpointprotector/install/virtualappliance/setupwizard.md index f84fdb11fe..92a5e02b07 100644 --- a/docs/endpointprotector/install/virtualappliance/setupwizard.md +++ b/docs/endpointprotector/install/virtualappliance/setupwizard.md @@ -55,3 +55,7 @@ As mentioned before, starting with version 2509, only the manual configuration o **Step 4 –** Select **Apply**. The virtual appliance is now accessible from the configured IP Address. (e.g., https:// 192.168.7.94). + +:::note +E-mail Server Settings are no longer configured in the setup wizard. To configure email server settings and authentication, go to **System Configuration** > **[Mail Settings](/docs/endpointprotector/admin/systemconfiguration/mailsettings.md)** after completing the initial setup. +::: diff --git a/docusaurus.config.js b/docusaurus.config.js index e6747669b3..fd34daeb78 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -68,6 +68,23 @@ const config = { }, }), ], + [ + 'redocusaurus', + { + specs: [ + { + id: 'changetracker-hub-8-1', + spec: 'static/openapi/changetracker-hub-8.1.yaml', + route: '/docs/changetracker/8_1/integration/api/reference', + }, + ], + theme: { + options: { + scrollYOffset: '.navbar', + }, + }, + }, + ], ], plugins: [ diff --git a/package-lock.json b/package-lock.json index 5a9a634099..5eb5476574 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,6 +23,7 @@ "react": "^18.3.1", "react-dom": "^18.3.1", "react-typed": "^2.0.12", + "redocusaurus": "^2.5.0", "serve": "^10.0.2" }, "devDependencies": { @@ -4338,6 +4339,27 @@ "tslib": "^2.4.0" } }, + "node_modules/@emotion/is-prop-valid": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@emotion/is-prop-valid/-/is-prop-valid-1.4.0.tgz", + "integrity": "sha512-QgD4fyscGcbbKwJmqNvUMSE02OsHUa+lAWKdEUIJKgqe5IwRSKd7+KhibEWdaKwgjLj0DRSHA9biAIqGBk05lw==", + "license": "MIT", + "dependencies": { + "@emotion/memoize": "^0.9.0" + } + }, + "node_modules/@emotion/memoize": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/@emotion/memoize/-/memoize-0.9.0.tgz", + "integrity": "sha512-30FAj7/EoJ5mwVPOWhAyCX+FPfMDrVecJAM+Iw9NRoSl4BBAQeqj4cApHHUXOVvIPgLVDsCFoz/hGD+5QQD1GQ==", + "license": "MIT" + }, + "node_modules/@exodus/schemasafe": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@exodus/schemasafe/-/schemasafe-1.3.0.tgz", + "integrity": "sha512-5Aap/GaRupgNx/feGBwLLTVv8OQFfv3pq2lPRzPg9R+IOBnDgghTGW7l7EuVXOvg5cc/xSAlRW8rBrjIC3Nvqw==", + "license": "MIT" + }, "node_modules/@hapi/hoek": { "version": "9.3.0", "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", @@ -4998,6 +5020,18 @@ "url": "https://paulmillr.com/funding/" } }, + "node_modules/@nodable/entities": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@nodable/entities/-/entities-2.1.0.tgz", + "integrity": "sha512-nyT7T3nbMyBI/lvr6L5TyWbFJAI9FTgVRakNoBqCD+PmID8DzFrrNdLLtHMwMszOtqZa8PAOV24ZqDnQrhQINA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/nodable" + } + ], + "license": "MIT" + }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -5228,6 +5262,78 @@ "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", "license": "MIT" }, + "node_modules/@redocly/ajv": { + "version": "8.18.3", + "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.18.3.tgz", + "integrity": "sha512-l42u0of3hY98sN2A+M4qTX1O/KrpgGH32Hu9kP2GtHyD5Dfqq86PKFLe5dwaD8DEnNmlOlll2BAmeEtf0DaySg==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@redocly/config": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.6.3.tgz", + "integrity": "sha512-hGWJgCsXRw0Ow4rplqRlUQifZvoSwZipkYnt11e3SeH1Eb23VUIDBcRuaQOUqy1wn0eevXkU2GzzQ8fbKdQ7Mg==", + "license": "MIT" + }, + "node_modules/@redocly/openapi-core": { + "version": "1.16.0", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.16.0.tgz", + "integrity": "sha512-z06h+svyqbUcdAaePq8LPSwTPlm6Ig7j2VlL8skPBYnJvyaQ2IN7x/JkOvRL4ta+wcOCBdAex5JWnZbKaNktJg==", + "license": "MIT", + "dependencies": { + "@redocly/ajv": "^8.11.0", + "@redocly/config": "^0.6.0", + "colorette": "^1.2.0", + "https-proxy-agent": "^7.0.4", + "js-levenshtein": "^1.1.6", + "js-yaml": "^4.1.0", + "lodash.isequal": "^4.5.0", + "minimatch": "^5.0.1", + "node-fetch": "^2.6.1", + "pluralize": "^8.0.0", + "yaml-ast-parser": "0.0.43" + }, + "engines": { + "node": ">=14.19.0", + "npm": ">=7.0.0" + } + }, + "node_modules/@redocly/openapi-core/node_modules/brace-expansion": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.0.tgz", + "integrity": "sha512-TN1kCZAgdgweJhWWpgKYrQaMNHcDULHkWwQIspdtjV4Y5aurRdZpjAqn6yX3FPqTA9ngHCc4hJxMAMgGfve85w==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@redocly/openapi-core/node_modules/colorette": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", + "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==", + "license": "MIT" + }, + "node_modules/@redocly/openapi-core/node_modules/minimatch": { + "version": "5.1.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.9.tgz", + "integrity": "sha512-7o1wEA2RyMP7Iu7GNba9vc0RWWGACJOCZBJX2GJWip0ikV+wcOsgVuY9uE8CPiyQhkGFSlhuSkZPavN7u1c2Fw==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/@rsdoctor/client": { "version": "0.4.13", "resolved": "https://registry.npmjs.org/@rsdoctor/client/-/client-0.4.13.tgz", @@ -7325,6 +7431,15 @@ "node": ">= 10.0.0" } }, + "node_modules/agent-base": { + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz", + "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==", + "license": "MIT", + "engines": { + "node": ">= 14" + } + }, "node_modules/aggregate-error": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", @@ -8032,6 +8147,12 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "license": "MIT" + }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -8063,6 +8184,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/camelize": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/camelize/-/camelize-1.0.1.tgz", + "integrity": "sha512-dU+Tx2fsypxTgtLoE36npi3UqcjSSMNYfkqgmoEhtZrraP5VWq0K7FkWVTYa8eMPtnU/G2txVsfdCJTn9uzpuQ==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/caniuse-api": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", @@ -8284,6 +8414,12 @@ "node": ">=8" } }, + "node_modules/classnames": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz", + "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==", + "license": "MIT" + }, "node_modules/clean-css": { "version": "5.3.3", "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-5.3.3.tgz", @@ -8520,6 +8656,57 @@ "integrity": "sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==", "license": "ISC" }, + "node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/cliui/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/cliui/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, "node_modules/clone-deep": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", @@ -9065,6 +9252,15 @@ "node": ">=4" } }, + "node_modules/css-color-keywords": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/css-color-keywords/-/css-color-keywords-1.0.0.tgz", + "integrity": "sha512-FyyrDHZKEjXDpNJYvVsV960FiqQyXc/LlYmsxl2BcdMb2WPx0OGRVgTg55rPSyLSNMqP52R9r8geSp7apN3Ofg==", + "license": "ISC", + "engines": { + "node": ">=4" + } + }, "node_modules/css-declaration-sorter": { "version": "7.4.0", "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.4.0.tgz", @@ -9268,6 +9464,17 @@ "url": "https://github.com/sponsors/fb55" } }, + "node_modules/css-to-react-native": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/css-to-react-native/-/css-to-react-native-3.2.0.tgz", + "integrity": "sha512-e8RKaLXMOFii+02mOlqwjbD00KSEKqblnpO9e++1aXS1fPQOpS1YoqdVHBqPjHNoxeF2mimzVqawm2KCbEdtHQ==", + "license": "MIT", + "dependencies": { + "camelize": "^1.0.0", + "css-color-keywords": "^1.0.0", + "postcss-value-parser": "^4.0.2" + } + }, "node_modules/css-tree": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz", @@ -9452,9 +9659,9 @@ "license": "CC0-1.0" }, "node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==", + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", "license": "MIT" }, "node_modules/cytoscape": { @@ -10006,6 +10213,11 @@ } } }, + "node_modules/decko": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decko/-/decko-1.2.0.tgz", + "integrity": "sha512-m8FnyHXV1QX+S1cl+KPFDIl6NMkxtKsy6+U/aYyjrOqWMuwAwYWu7ePqrsUHtDR5Y8Yk2pi/KIDSgF+vT4cPOQ==" + }, "node_modules/decode-named-character-reference": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz", @@ -10271,6 +10483,243 @@ "node": ">=6" } }, + "node_modules/docusaurus-plugin-redoc": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-redoc/-/docusaurus-plugin-redoc-2.5.0.tgz", + "integrity": "sha512-44sDhuXvItHnUuPdKswF3cRhiN5UW3YZxmMBsQLSfCYKcYr9tgWF2qvDfQoZO9i1DwpaYbIZ/RKMrSgny/iWYA==", + "license": "MIT", + "dependencies": { + "@redocly/openapi-core": "1.16.0", + "redoc": "2.4.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@docusaurus/utils": "^3.6.0" + } + }, + "node_modules/docusaurus-plugin-redoc/node_modules/eventemitter3": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.4.tgz", + "integrity": "sha512-mlsTRyGaPBjPedk6Bvw+aqbsXDtoAyAzm5MO7JgU+yVRyMQ5O8bD4Kcci7BS85f93veegeCPkL8R4GLClnjLFw==", + "license": "MIT" + }, + "node_modules/docusaurus-plugin-redoc/node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "license": "MIT", + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, + "node_modules/docusaurus-plugin-redoc/node_modules/redoc": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/redoc/-/redoc-2.4.0.tgz", + "integrity": "sha512-rFlfzFVWS9XJ6aYAs/bHnLhHP5FQEhwAHDBVgwb9L2FqDQ8Hu8rQ1G84iwaWXxZfPP9UWn7JdWkxI6MXr2ZDjw==", + "license": "MIT", + "dependencies": { + "@redocly/openapi-core": "^1.4.0", + "classnames": "^2.3.2", + "decko": "^1.2.0", + "dompurify": "^3.0.6", + "eventemitter3": "^5.0.1", + "json-pointer": "^0.6.2", + "lunr": "^2.3.9", + "mark.js": "^8.11.1", + "marked": "^4.3.0", + "mobx-react": "^9.1.1", + "openapi-sampler": "^1.5.0", + "path-browserify": "^1.0.1", + "perfect-scrollbar": "^1.5.5", + "polished": "^4.2.2", + "prismjs": "^1.29.0", + "prop-types": "^15.8.1", + "react-tabs": "^6.0.2", + "slugify": "~1.4.7", + "stickyfill": "^1.1.1", + "swagger2openapi": "^7.0.8", + "url-template": "^2.0.8" + }, + "engines": { + "node": ">=6.9", + "npm": ">=3.0.0" + }, + "peerDependencies": { + "core-js": "^3.1.4", + "mobx": "^6.0.4", + "react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "styled-components": "^4.1.1 || ^5.1.1 || ^6.0.5" + } + }, + "node_modules/docusaurus-plugin-redoc/node_modules/styled-components": { + "version": "6.4.1", + "resolved": "https://registry.npmjs.org/styled-components/-/styled-components-6.4.1.tgz", + "integrity": "sha512-ADu2dF53esUzzM4I0ewxhxFtsDd6v4V6dNkg3vG0iFKhnt06sJneTZnRvujAosZwW0XD58IKgGMQoqri4wHRqg==", + "license": "MIT", + "peer": true, + "dependencies": { + "@emotion/is-prop-valid": "1.4.0", + "css-to-react-native": "3.2.0", + "csstype": "3.2.3", + "stylis": "4.3.6" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/styled-components" + }, + "peerDependencies": { + "css-to-react-native": ">= 3.2.0", + "react": ">= 16.8.0", + "react-dom": ">= 16.8.0", + "react-native": ">= 0.68.0" + }, + "peerDependenciesMeta": { + "css-to-react-native": { + "optional": true + }, + "react-dom": { + "optional": true + }, + "react-native": { + "optional": true + } + } + }, + "node_modules/docusaurus-theme-redoc": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/docusaurus-theme-redoc/-/docusaurus-theme-redoc-2.5.0.tgz", + "integrity": "sha512-ykLmnnvE20Im3eABlIpUnXnT2gSHVAjgyy2fU2G8yecu7zqIE+G/SiBpBg/hrWMUycL31a8VSG7Ehkf3pg1u+A==", + "license": "MIT", + "dependencies": { + "@redocly/openapi-core": "1.16.0", + "clsx": "^1.2.1", + "lodash": "^4.17.21", + "mobx": "^6.12.4", + "postcss": "^8.4.45", + "postcss-prefix-selector": "^1.16.1", + "redoc": "2.4.0", + "styled-components": "^6.1.11" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@docusaurus/theme-common": "^3.6.0", + "webpack": "^5.0.0" + } + }, + "node_modules/docusaurus-theme-redoc/node_modules/clsx": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", + "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/docusaurus-theme-redoc/node_modules/eventemitter3": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.4.tgz", + "integrity": "sha512-mlsTRyGaPBjPedk6Bvw+aqbsXDtoAyAzm5MO7JgU+yVRyMQ5O8bD4Kcci7BS85f93veegeCPkL8R4GLClnjLFw==", + "license": "MIT" + }, + "node_modules/docusaurus-theme-redoc/node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "license": "MIT", + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, + "node_modules/docusaurus-theme-redoc/node_modules/redoc": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/redoc/-/redoc-2.4.0.tgz", + "integrity": "sha512-rFlfzFVWS9XJ6aYAs/bHnLhHP5FQEhwAHDBVgwb9L2FqDQ8Hu8rQ1G84iwaWXxZfPP9UWn7JdWkxI6MXr2ZDjw==", + "license": "MIT", + "dependencies": { + "@redocly/openapi-core": "^1.4.0", + "classnames": "^2.3.2", + "decko": "^1.2.0", + "dompurify": "^3.0.6", + "eventemitter3": "^5.0.1", + "json-pointer": "^0.6.2", + "lunr": "^2.3.9", + "mark.js": "^8.11.1", + "marked": "^4.3.0", + "mobx-react": "^9.1.1", + "openapi-sampler": "^1.5.0", + "path-browserify": "^1.0.1", + "perfect-scrollbar": "^1.5.5", + "polished": "^4.2.2", + "prismjs": "^1.29.0", + "prop-types": "^15.8.1", + "react-tabs": "^6.0.2", + "slugify": "~1.4.7", + "stickyfill": "^1.1.1", + "swagger2openapi": "^7.0.8", + "url-template": "^2.0.8" + }, + "engines": { + "node": ">=6.9", + "npm": ">=3.0.0" + }, + "peerDependencies": { + "core-js": "^3.1.4", + "mobx": "^6.0.4", + "react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "styled-components": "^4.1.1 || ^5.1.1 || ^6.0.5" + } + }, + "node_modules/docusaurus-theme-redoc/node_modules/styled-components": { + "version": "6.4.1", + "resolved": "https://registry.npmjs.org/styled-components/-/styled-components-6.4.1.tgz", + "integrity": "sha512-ADu2dF53esUzzM4I0ewxhxFtsDd6v4V6dNkg3vG0iFKhnt06sJneTZnRvujAosZwW0XD58IKgGMQoqri4wHRqg==", + "license": "MIT", + "dependencies": { + "@emotion/is-prop-valid": "1.4.0", + "css-to-react-native": "3.2.0", + "csstype": "3.2.3", + "stylis": "4.3.6" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/styled-components" + }, + "peerDependencies": { + "css-to-react-native": ">= 3.2.0", + "react": ">= 16.8.0", + "react-dom": ">= 16.8.0", + "react-native": ">= 0.68.0" + }, + "peerDependenciesMeta": { + "css-to-react-native": { + "optional": true + }, + "react-dom": { + "optional": true + }, + "react-native": { + "optional": true + } + } + }, "node_modules/dom-converter": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", @@ -10599,6 +11048,12 @@ "node": ">= 0.4" } }, + "node_modules/es6-promise": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-3.3.1.tgz", + "integrity": "sha512-SOp9Phqvqn7jtEUxPWdWfWoLmyt2VaJ6MpvP9Comy1MceMXqE6bxvaTu4iaxpYYPzhny28Lc+M87/c2cPK6lDg==", + "license": "MIT" + }, "node_modules/esast-util-from-estree": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", @@ -11094,6 +11549,12 @@ "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", "license": "MIT" }, + "node_modules/fast-safe-stringify": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz", + "integrity": "sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA==", + "license": "MIT" + }, "node_modules/fast-uri": { "version": "3.0.6", "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.6.tgz", @@ -11125,11 +11586,47 @@ "integrity": "sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==", "license": "MIT" }, - "node_modules/fastq": { - "version": "1.20.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", - "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", - "license": "ISC", + "node_modules/fast-xml-builder": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/fast-xml-builder/-/fast-xml-builder-1.1.5.tgz", + "integrity": "sha512-4TJn/8FKLeslLAH3dnohXqE3QSoxkhvaMzepOIZytwJXZO69Bfz0HBdDHzOTOon6G59Zrk6VQ2bEiv1t61rfkA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/NaturalIntelligence" + } + ], + "license": "MIT", + "dependencies": { + "path-expression-matcher": "^1.1.3" + } + }, + "node_modules/fast-xml-parser": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.7.2.tgz", + "integrity": "sha512-P7oW7tLbYnhOLQk/Gv7cZgzgMPP/XN03K02/Jy6Y/NHzyIAIpxuZIM/YqAkfiXFPxA2CTm7NtCijK9EDu09u2w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/NaturalIntelligence" + } + ], + "license": "MIT", + "dependencies": { + "@nodable/entities": "^2.1.0", + "fast-xml-builder": "^1.1.5", + "path-expression-matcher": "^1.5.0", + "strnum": "^2.2.3" + }, + "bin": { + "fxparser": "src/cli/cli.js" + } + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "license": "ISC", "dependencies": { "reusify": "^1.0.4" } @@ -11391,6 +11888,12 @@ } } }, + "node_modules/foreach": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.6.tgz", + "integrity": "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg==", + "license": "MIT" + }, "node_modules/form-data": { "version": "4.0.5", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.5.tgz", @@ -11501,6 +12004,15 @@ "node": ">=6.9.0" } }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, "node_modules/get-east-asian-width": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.3.0.tgz", @@ -12330,6 +12842,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/http2-client": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/http2-client/-/http2-client-1.3.5.tgz", + "integrity": "sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA==", + "license": "MIT" + }, "node_modules/http2-wrapper": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", @@ -12343,6 +12861,19 @@ "node": ">=10.19.0" } }, + "node_modules/https-proxy-agent": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", + "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", + "license": "MIT", + "dependencies": { + "agent-base": "^7.1.2", + "debug": "4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/human-signals": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", @@ -12950,6 +13481,15 @@ "@sideway/pinpoint": "^2.0.0" } }, + "node_modules/js-levenshtein": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz", + "integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -13001,6 +13541,15 @@ "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", "license": "MIT" }, + "node_modules/json-pointer": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.2.tgz", + "integrity": "sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw==", + "license": "MIT", + "dependencies": { + "foreach": "^2.0.4" + } + }, "node_modules/json-schema-traverse": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", @@ -13482,6 +14031,13 @@ "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", "license": "MIT" }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", + "deprecated": "This package is deprecated. Use require('node:util').isDeepStrictEqual instead.", + "license": "MIT" + }, "node_modules/lodash.memoize": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", @@ -13602,6 +14158,18 @@ "yallist": "^3.0.2" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "license": "MIT" + }, + "node_modules/mark.js": { + "version": "8.11.1", + "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", + "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", + "license": "MIT" + }, "node_modules/markdown-extensions": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", @@ -16082,6 +16650,66 @@ "ufo": "^1.6.3" } }, + "node_modules/mobx": { + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/mobx/-/mobx-6.15.0.tgz", + "integrity": "sha512-UczzB+0nnwGotYSgllfARAqWCJ5e/skuV2K/l+Zyck/H6pJIhLXuBnz+6vn2i211o7DtbE78HQtsYEKICHGI+g==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mobx" + } + }, + "node_modules/mobx-react": { + "version": "9.2.1", + "resolved": "https://registry.npmjs.org/mobx-react/-/mobx-react-9.2.1.tgz", + "integrity": "sha512-WJNNm0FB2n0Z0u+jS1QHmmWyV8l2WiAj8V8I/96kbUEN2YbYCoKW+hbbqKKRUBqElu0llxM7nWKehvRIkhBVJw==", + "license": "MIT", + "dependencies": { + "mobx-react-lite": "^4.1.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mobx" + }, + "peerDependencies": { + "mobx": "^6.9.0", + "react": "^16.8.0 || ^17 || ^18 || ^19" + }, + "peerDependenciesMeta": { + "react-dom": { + "optional": true + }, + "react-native": { + "optional": true + } + } + }, + "node_modules/mobx-react-lite": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/mobx-react-lite/-/mobx-react-lite-4.1.1.tgz", + "integrity": "sha512-iUxiMpsvNraCKXU+yPotsOncNNmyeS2B5DKL+TL6Tar/xm+wwNJAubJmtRSeAoYawdZqwv8Z/+5nPRHeQxTiXg==", + "license": "MIT", + "dependencies": { + "use-sync-external-store": "^1.4.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mobx" + }, + "peerDependencies": { + "mobx": "^6.9.0", + "react": "^16.8.0 || ^17 || ^18 || ^19" + }, + "peerDependenciesMeta": { + "react-dom": { + "optional": true + }, + "react-native": { + "optional": true + } + } + }, "node_modules/mrmime": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", @@ -16168,6 +16796,47 @@ "node": ">=18" } }, + "node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/node-fetch-h2": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/node-fetch-h2/-/node-fetch-h2-2.3.0.tgz", + "integrity": "sha512-ofRW94Ab0T4AOh5Fk8t0h8OBWrmjb0SSB20xh1H8YnPV9EJ+f5AMoYSUQ2zgJ4Iq2HAK0I2l5/Nequ8YzFS3Hg==", + "license": "MIT", + "dependencies": { + "http2-client": "^1.2.5" + }, + "engines": { + "node": "4.x || >=6.0.0" + } + }, + "node_modules/node-readfiles": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/node-readfiles/-/node-readfiles-0.2.0.tgz", + "integrity": "sha512-SU00ZarexNlE4Rjdm83vglt5Y9yiQ+XI1XpflWlb7q7UTN1JUItm69xMeiQCTxtTfnzt+83T8Cx+vI2ED++VDA==", + "license": "MIT", + "dependencies": { + "es6-promise": "^3.2.1" + } + }, "node_modules/node-releases": { "version": "2.0.36", "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.36.tgz", @@ -16294,6 +16963,76 @@ "url": "https://opencollective.com/webpack" } }, + "node_modules/oas-kit-common": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz", + "integrity": "sha512-pJTS2+T0oGIwgjGpw7sIRU8RQMcUoKCDWFLdBqKB2BNmGpbBMH2sdqAaOXUg8OzonZHU0L7vfJu1mJFEiYDWOQ==", + "license": "BSD-3-Clause", + "dependencies": { + "fast-safe-stringify": "^2.0.7" + } + }, + "node_modules/oas-linter": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/oas-linter/-/oas-linter-3.2.2.tgz", + "integrity": "sha512-KEGjPDVoU5K6swgo9hJVA/qYGlwfbFx+Kg2QB/kd7rzV5N8N5Mg6PlsoCMohVnQmo+pzJap/F610qTodKzecGQ==", + "license": "BSD-3-Clause", + "dependencies": { + "@exodus/schemasafe": "^1.0.0-rc.2", + "should": "^13.2.1", + "yaml": "^1.10.0" + }, + "funding": { + "url": "https://github.com/Mermade/oas-kit?sponsor=1" + } + }, + "node_modules/oas-resolver": { + "version": "2.5.6", + "resolved": "https://registry.npmjs.org/oas-resolver/-/oas-resolver-2.5.6.tgz", + "integrity": "sha512-Yx5PWQNZomfEhPPOphFbZKi9W93CocQj18NlD2Pa4GWZzdZpSJvYwoiuurRI7m3SpcChrnO08hkuQDL3FGsVFQ==", + "license": "BSD-3-Clause", + "dependencies": { + "node-fetch-h2": "^2.3.0", + "oas-kit-common": "^1.0.8", + "reftools": "^1.1.9", + "yaml": "^1.10.0", + "yargs": "^17.0.1" + }, + "bin": { + "resolve": "resolve.js" + }, + "funding": { + "url": "https://github.com/Mermade/oas-kit?sponsor=1" + } + }, + "node_modules/oas-schema-walker": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz", + "integrity": "sha512-2yucenq1a9YPmeNExoUa9Qwrt9RFkjqaMAA1X+U7sbb0AqBeTIdMHky9SQQ6iN94bO5NW0W4TRYXerG+BdAvAQ==", + "license": "BSD-3-Clause", + "funding": { + "url": "https://github.com/Mermade/oas-kit?sponsor=1" + } + }, + "node_modules/oas-validator": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/oas-validator/-/oas-validator-5.0.8.tgz", + "integrity": "sha512-cu20/HE5N5HKqVygs3dt94eYJfBi0TsZvPVXDhbXQHiEityDN+RROTleefoKRKKJ9dFAF2JBkDHgvWj0sjKGmw==", + "license": "BSD-3-Clause", + "dependencies": { + "call-me-maybe": "^1.0.1", + "oas-kit-common": "^1.0.8", + "oas-linter": "^3.2.2", + "oas-resolver": "^2.5.6", + "oas-schema-walker": "^1.1.5", + "reftools": "^1.1.9", + "should": "^13.2.1", + "yaml": "^1.10.0" + }, + "funding": { + "url": "https://github.com/Mermade/oas-kit?sponsor=1" + } + }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", @@ -16403,6 +17142,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/openapi-sampler": { + "version": "1.7.2", + "resolved": "https://registry.npmjs.org/openapi-sampler/-/openapi-sampler-1.7.2.tgz", + "integrity": "sha512-OKytvqB5XIaTgA9xtw8W8UTar+uymW2xPVpFN0NihMtuHPdPTGxBEhGnfFnJW5g/gOSIvkP+H0Xh3XhVI9/n7g==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.7", + "fast-xml-parser": "^5.5.1", + "json-pointer": "0.6.2" + } + }, "node_modules/opener": { "version": "1.5.2", "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", @@ -16828,6 +17578,21 @@ "node": "^12.20.0 || ^14.13.1 || >=16.0.0" } }, + "node_modules/path-expression-matcher": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/path-expression-matcher/-/path-expression-matcher-1.5.0.tgz", + "integrity": "sha512-cbrerZV+6rvdQrrD+iGMcZFEiiSrbv9Tfdkvnusy6y0x0GKBXREFg/Y65GhIfm0tnLntThhzCnfKwp1WRjeCyQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/NaturalIntelligence" + } + ], + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, "node_modules/path-is-inside": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", @@ -16873,6 +17638,12 @@ "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", "license": "MIT" }, + "node_modules/perfect-scrollbar": { + "version": "1.5.6", + "resolved": "https://registry.npmjs.org/perfect-scrollbar/-/perfect-scrollbar-1.5.6.tgz", + "integrity": "sha512-rixgxw3SxyJbCaSpo1n35A/fwI1r2rdwMKOTCg/AcG+xOEyZcE8UHVjpZMFCVImzsFoCZeJTT+M/rdEIQYO2nw==", + "license": "MIT" + }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", @@ -16934,6 +17705,15 @@ "node": ">=16.0.0" } }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, "node_modules/points-on-curve": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/points-on-curve/-/points-on-curve-0.2.0.tgz", @@ -16950,6 +17730,18 @@ "points-on-curve": "0.2.0" } }, + "node_modules/polished": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/polished/-/polished-4.3.1.tgz", + "integrity": "sha512-OBatVyC/N7SCW/FaDHrSd+vn0o5cS855TOmYi4OkdWUMSJCET/xip//ch8xGUvtr3i44X9LVyWwQlRMTN3pwSA==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.17.8" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/postcss": { "version": "8.5.9", "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.9.tgz", @@ -18122,6 +18914,15 @@ "postcss": "^8.4" } }, + "node_modules/postcss-prefix-selector": { + "version": "1.16.1", + "resolved": "https://registry.npmjs.org/postcss-prefix-selector/-/postcss-prefix-selector-1.16.1.tgz", + "integrity": "sha512-Umxu+FvKMwlY6TyDzGFoSUnzW+NOfMBLyC1tAkIjgX+Z/qGspJeRjVC903D7mx7TuBpJlwti2ibXtWuA7fKMeQ==", + "license": "MIT", + "peerDependencies": { + "postcss": ">4 <9" + } + }, "node_modules/postcss-preset-env": { "version": "10.6.1", "resolved": "https://registry.npmjs.org/postcss-preset-env/-/postcss-preset-env-10.6.1.tgz", @@ -18842,6 +19643,19 @@ "react": ">=15" } }, + "node_modules/react-tabs": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/react-tabs/-/react-tabs-6.1.1.tgz", + "integrity": "sha512-CPiuKoMFf89B7QlbFfdBD9XmUWiE3qudQputMVZB8GQvPJZRX/gqjDaDWOPDwGinEfpJKEuBCkGt83Tt4efeyA==", + "license": "MIT", + "dependencies": { + "clsx": "^2.0.0", + "prop-types": "^15.5.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0" + } + }, "node_modules/react-typed": { "version": "2.0.12", "resolved": "https://registry.npmjs.org/react-typed/-/react-typed-2.0.12.tgz", @@ -18944,12 +19758,38 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/redocusaurus": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/redocusaurus/-/redocusaurus-2.5.0.tgz", + "integrity": "sha512-QWJX2hgnEfSDb7fZzS4iZe6aqdAvm/XLCsNv6RkgDw6Pl/lsTZKipP2n1r5QS1CC5hY8eAwsjVXeF7B03vkz2g==", + "license": "MIT", + "dependencies": { + "docusaurus-plugin-redoc": "2.5.0", + "docusaurus-theme-redoc": "2.5.0" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@docusaurus/theme-common": "^3.6.0", + "@docusaurus/utils": "^3.6.0" + } + }, "node_modules/reflect-metadata": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", "license": "Apache-2.0" }, + "node_modules/reftools": { + "version": "1.1.9", + "resolved": "https://registry.npmjs.org/reftools/-/reftools-1.1.9.tgz", + "integrity": "sha512-OVede/NQE13xBQ+ob5CKd5KyeJYU2YInb1bmV4nRoOfquZPkAkxuOXicSe1PvqIuZZ4kD13sPKBbR7UFDmli6w==", + "license": "BSD-3-Clause", + "funding": { + "url": "https://github.com/Mermade/oas-kit?sponsor=1" + } + }, "node_modules/regenerate": { "version": "1.4.2", "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", @@ -19313,6 +20153,15 @@ "node": ">=0.10" } }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/require-from-string": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", @@ -20294,6 +21143,60 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/should": { + "version": "13.2.3", + "resolved": "https://registry.npmjs.org/should/-/should-13.2.3.tgz", + "integrity": "sha512-ggLesLtu2xp+ZxI+ysJTmNjh2U0TsC+rQ/pfED9bUZZ4DKefP27D+7YJVVTvKsmjLpIi9jAa7itwDGkDDmt1GQ==", + "license": "MIT", + "dependencies": { + "should-equal": "^2.0.0", + "should-format": "^3.0.3", + "should-type": "^1.4.0", + "should-type-adaptors": "^1.0.1", + "should-util": "^1.0.0" + } + }, + "node_modules/should-equal": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/should-equal/-/should-equal-2.0.0.tgz", + "integrity": "sha512-ZP36TMrK9euEuWQYBig9W55WPC7uo37qzAEmbjHz4gfyuXrEUgF8cUvQVO+w+d3OMfPvSRQJ22lSm8MQJ43LTA==", + "license": "MIT", + "dependencies": { + "should-type": "^1.4.0" + } + }, + "node_modules/should-format": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/should-format/-/should-format-3.0.3.tgz", + "integrity": "sha512-hZ58adtulAk0gKtua7QxevgUaXTTXxIi8t41L3zo9AHvjXO1/7sdLECuHeIN2SRtYXpNkmhoUP2pdeWgricQ+Q==", + "license": "MIT", + "dependencies": { + "should-type": "^1.3.0", + "should-type-adaptors": "^1.0.1" + } + }, + "node_modules/should-type": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/should-type/-/should-type-1.4.0.tgz", + "integrity": "sha512-MdAsTu3n25yDbIe1NeN69G4n6mUnJGtSJHygX3+oN0ZbO3DTiATnf7XnYJdGT42JCXurTb1JI0qOBR65shvhPQ==", + "license": "MIT" + }, + "node_modules/should-type-adaptors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/should-type-adaptors/-/should-type-adaptors-1.1.0.tgz", + "integrity": "sha512-JA4hdoLnN+kebEp2Vs8eBe9g7uy0zbRo+RMcU0EsNy+R+k049Ki+N5tT5Jagst2g7EAja+euFuoXFCa8vIklfA==", + "license": "MIT", + "dependencies": { + "should-type": "^1.3.0", + "should-util": "^1.0.0" + } + }, + "node_modules/should-util": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/should-util/-/should-util-1.0.1.tgz", + "integrity": "sha512-oXF8tfxx5cDk8r2kYqlkUJzZpDBqVY/II2WhvU0n9Y3XYvAYRmeaf1PvvIvTgPnv4KJ+ES5M0PyDq5Jp+Ygy2g==", + "license": "MIT" + }, "node_modules/side-channel": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", @@ -20456,6 +21359,15 @@ "url": "https://github.com/chalk/slice-ansi?sponsor=1" } }, + "node_modules/slugify": { + "version": "1.4.7", + "resolved": "https://registry.npmjs.org/slugify/-/slugify-1.4.7.tgz", + "integrity": "sha512-tf+h5W1IrjNm/9rKKj0JU2MDMruiopx0jjVA5zCdBtcGjfp0+c5rHw/zADLC3IeKlGHtVbHtpfzvYA0OYT+HKg==", + "license": "MIT", + "engines": { + "node": ">=8.0.0" + } + }, "node_modules/snake-case": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", @@ -20693,6 +21605,11 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/stickyfill": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/stickyfill/-/stickyfill-1.1.1.tgz", + "integrity": "sha512-GCp7vHAfpao+Qh/3Flh9DXEJ/qSi0KJwJw6zYlZOtRYXWUIpMM6mC2rIep/dK8RQqwW0KxGJIllmjPIBOGN8AA==" + }, "node_modules/string_decoder": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", @@ -20825,6 +21742,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/strnum": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/strnum/-/strnum-2.2.3.tgz", + "integrity": "sha512-oKx6RUCuHfT3oyVjtnrmn19H1SiCqgJSg+54XqURKp5aCMbrXrhLjRN9TjuwMjiYstZ0MzDrHqkGZ5dFTKd+zg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/NaturalIntelligence" + } + ], + "license": "MIT" + }, "node_modules/style-to-js": { "version": "1.1.17", "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.17.tgz", @@ -20929,6 +21858,33 @@ "node": ">= 10" } }, + "node_modules/swagger2openapi": { + "version": "7.0.8", + "resolved": "https://registry.npmjs.org/swagger2openapi/-/swagger2openapi-7.0.8.tgz", + "integrity": "sha512-upi/0ZGkYgEcLeGieoz8gT74oWHA0E7JivX7aN9mAf+Tc7BQoRBvnIGHoPDw+f9TXTW4s6kGYCZJtauP6OYp7g==", + "license": "BSD-3-Clause", + "dependencies": { + "call-me-maybe": "^1.0.1", + "node-fetch": "^2.6.1", + "node-fetch-h2": "^2.3.0", + "node-readfiles": "^0.2.0", + "oas-kit-common": "^1.0.8", + "oas-resolver": "^2.5.6", + "oas-schema-walker": "^1.1.5", + "oas-validator": "^5.0.8", + "reftools": "^1.1.9", + "yaml": "^1.10.0", + "yargs": "^17.0.1" + }, + "bin": { + "boast": "boast.js", + "oas-validate": "oas-validate.js", + "swagger2openapi": "swagger2openapi.js" + }, + "funding": { + "url": "https://github.com/Mermade/oas-kit?sponsor=1" + } + }, "node_modules/swc-loader": { "version": "0.2.7", "resolved": "https://registry.npmjs.org/swc-loader/-/swc-loader-0.2.7.tgz", @@ -21301,6 +22257,12 @@ "node": ">=6" } }, + "node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "license": "MIT" + }, "node_modules/tree-dump": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/tree-dump/-/tree-dump-1.1.0.tgz", @@ -21824,6 +22786,21 @@ "url": "https://opencollective.com/webpack" } }, + "node_modules/url-template": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/url-template/-/url-template-2.0.8.tgz", + "integrity": "sha512-XdVKMF4SJ0nP/O7XIPB0JwAEuT9lDIYnNsK8yGVe43y0AWoKeJNdv3ZNWh7ksJ6KqQFjOO6ox/VEitLnaVNufw==", + "license": "BSD" + }, + "node_modules/use-sync-external-store": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.6.0.tgz", + "integrity": "sha512-Pp6GSwGP/NrPIrxVFAIkOQeyw8lFenOHijQWkUTrDvrF4ALqylP2C/KCkeS9dpUM3KvYRQhna5vt7IL95+ZQ9w==", + "license": "MIT", + "peerDependencies": { + "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" + } + }, "node_modules/util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", @@ -22131,6 +23108,12 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "license": "BSD-2-Clause" + }, "node_modules/webpack": { "version": "5.106.2", "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.106.2.tgz", @@ -22558,6 +23541,16 @@ "node": ">=0.8.0" } }, + "node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -22737,12 +23730,83 @@ "xml-js": "bin/cli.js" } }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "license": "ISC", + "engines": { + "node": ">=10" + } + }, "node_modules/yallist": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", "license": "ISC" }, + "node_modules/yaml": { + "version": "1.10.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.3.tgz", + "integrity": "sha512-vIYeF1u3CjlhAFekPPAk2h/Kv4T3mAkMox5OymRiJQB0spDP10LHvt+K7G9Ny6NuuMAb25/6n1qyUjAcGNf/AA==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, + "node_modules/yaml-ast-parser": { + "version": "0.0.43", + "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz", + "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==", + "license": "Apache-2.0" + }, + "node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "license": "MIT", + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "license": "ISC", + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/yargs/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/yocto-queue": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", diff --git a/package.json b/package.json index 071a6885dc..ddcbef27d5 100644 --- a/package.json +++ b/package.json @@ -39,6 +39,7 @@ "react": "^18.3.1", "react-dom": "^18.3.1", "react-typed": "^2.0.12", + "redocusaurus": "^2.5.0", "serve": "^10.0.2" }, "devDependencies": { diff --git a/src/css/custom.css b/src/css/custom.css index 64c9272c6a..09161ffb7d 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -529,3 +529,18 @@ html { .DocSearch-Dropdown::-webkit-scrollbar-thumb:hover { background: var(--docsearch-primary-color); } + +/* Fix Redoc sidebar navigation: .api-content uses overflow:hidden + contain:layout + which intercepts scrollIntoView and prevents click-to-scroll from reaching the window. + Also, html has scroll-behavior:smooth (Docusaurus default) but Redoc's scroll correction + (scrollBy(0, -59)) fires synchronously after scrollIntoView(), cancelling the animation. + Forcing auto on the Redoc page makes the scroll instant so the offset correction applies + at the correct position. The html.plugin-redoc class is set only on the API reference page. */ +.api-content { + overflow: visible !important; + contain: none !important; +} + +html.plugin-redoc { + scroll-behavior: auto !important; +} diff --git a/static/openapi/changetracker-hub-8.1.yaml b/static/openapi/changetracker-hub-8.1.yaml new file mode 100644 index 0000000000..5734bcbee5 --- /dev/null +++ b/static/openapi/changetracker-hub-8.1.yaml @@ -0,0 +1,35148 @@ +openapi: 3.0.1 +info: + title: ChangeTracker Hub + version: '8.1' +servers: + - url: https://localhost:5001/api +paths: + '/command/tasks/poll/{AgentId}': + get: + tags: + - command + summary: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + description: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + operationId: GetAgentPolltaskspollAgentId_Get + parameters: + - name: UniqueId + in: query + description: Specifies the agent unique reference id. This is supplied in the return from the initial RegisterAgent call. + required: true + schema: + type: string + - name: AgentId + in: query + description: 'Specifies the agent id. Note: this the agent id excluding the device id: the poll returns tasks and configuration dates for all devices registered under this agent id.' + required: true + schema: + type: string + - name: LegacyId + in: query + description: 'The legacy v6.5 RA agent id. Note: this is only present for upgrade purposes.' + schema: + type: string + - name: PollTimeUtc + in: query + description: Specifies the local agent Utc time. Used to detect system time differences between agent and hub. + required: true + schema: + type: DateTime + format: date-time + x-nullable: false + - name: AgentVersion + in: query + description: Specifies the agent version. This is optional and typically only sent on initial poll. + schema: + type: string + - name: AgentMacAddresses + in: query + description: Specifies the agent physical/MAC addresses. This is optional and typically only sent on an initial poll or when the list changes. + schema: + type: string + - name: AgentIPv4 + in: query + description: Specifies the agent IP v4 addresses. This is optional and typically only sent on initial poll or when the list changes. + schema: + type: string + - name: AgentIPv6 + in: query + description: Specifies the agent IP v6 addresses. This is optional and typically only sent on initial poll or when the list changes. + schema: + type: string + - name: MachineName + in: query + description: 'Specifies the agent machine name including custom prefix, and domain prefix, if used. This is optional and typically only sent on initial poll or when the it changes.' + schema: + type: string + - name: FullyQualifiedDomainName + in: query + description: Specifies the fully qualified domain name. This is optional and typically only sent on initial poll or when the it changes. + schema: + type: string + - name: AgentType + in: query + description: Specifies the type of agent + schema: + enum: + - Unknown + - NetDesktop + - Mono + - NetCore + - ExpressAgent + type: string + x-nullable: false + - name: Os + in: query + description: Specifies the agent operating system. This is optional and typically only sent on initial poll or when the it changes. + schema: + type: string + - name: DeviceIds + in: query + description: Specifies the deviceIds of the devices online that the agent is proxying. This is optional and typically only sent by a proxying agent. + style: form + schema: + type: array + items: + type: string + - name: ReturnXml + in: query + description: Specifies whether to return the report task template xml in the response. This is optional and defaults to true. It can be used to prevent xml download on agents that implement a local cache of report definitions. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentPoll + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentPollResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + description: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + operationId: GetAgentPolltaskspollAgentId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentPoll' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentPoll + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentPollResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/{AgentId}': + get: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentId_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/submitAgentTaskResultStream/{AgentId}/{DeviceId}/{TaskId}': + post: + tags: + - submitAgentTaskResultStream + summary: Used to submit agent task result data to the hub as a stream. + description: Used to submit agent task result data to the hub as a stream. + operationId: SubmitAgentTaskResultStreamAgentIdDeviceIdTaskId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAgentTaskResultStream' + x-bodyName: body + responses: + '200': + description: The response object for SubmitAgentTaskResultsStream. + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAgentTaskResultStreamResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /submitAgentTaskResultData: + get: + tags: + - submitAgentTaskResultData + summary: 'Adds report result data for the given agent report, called by the agent. This is the new format used by the Gen 7 agent.' + description: 'Adds report result data for the given agent report, called by the agent. This is the new format used by the Gen 7 agent.' + operationId: SubmitAgentTaskResultData_Get + parameters: + - name: AgentId + in: query + description: 'Specifies the agent id. This required for external api callers, but optional internally because the system may update / expire tasks without knowing the AgentId, but external api entry points should ensure it is set to prevent tampering with tasks not owned by the caller.' + schema: + type: string + - name: DeviceId + in: query + description: 'Specifies the device id. Note: this is optional as the system knows the device id from the task.' + schema: + type: string + - name: TaskId + in: query + description: Specifies the task id that this data relates to. + schema: + type: integer + format: int32 + x-nullable: false + - name: DataValues + in: query + description: Specifies the result data items. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/VariableDataValue' + - name: Status + in: query + description: 'Specifies the status of the task. e.g complete, or error.' + schema: + enum: + - AwaitingPickup + - InProgress + - Complete + - Error + - Deleted + - ProcessingResults + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - submitAgentTaskResultData + summary: 'Adds report result data for the given agent report, called by the agent. This is the new format used by the Gen 7 agent.' + description: 'Adds report result data for the given agent report, called by the agent. This is the new format used by the Gen 7 agent.' + operationId: SubmitAgentTaskResultData_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAgentTaskResultData' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /submitAgentTaskResult: + get: + tags: + - submitAgentTaskResult + summary: 'Adds task result data for the given agent task, called by the agent.' + description: 'Adds task result data for the given agent task, called by the agent.' + operationId: SubmitAgentTaskResult_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent id. + required: true + schema: + type: string + - name: DeviceId + in: query + description: Specifies the device id. + required: true + schema: + type: string + - name: TaskId + in: query + description: Specifies the task id. + required: true + schema: + type: integer + format: int32 + x-nullable: false + - name: ResultData + in: query + description: Specifies the result data. If the task result is a single string it may be specified here. Otherwise specify it in ResultDataItems or RuleItemResults. + schema: + type: string + - name: ResultDataItems + in: query + description: 'Specifies the result data items, when the task result is a list of data items (eg get processes).' + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AgentDataItem' + - name: Status + in: query + description: Specifies the task status. + schema: + enum: + - AwaitingPickup + - InProgress + - Complete + - Error + - Deleted + - ProcessingResults + type: string + x-nullable: false + - name: StatusMessage + in: query + description: 'Specifies the additional status message, if any.' + schema: + type: string + - name: ReportResultSummary + in: query + description: Specifies the report result summary when this task represents a 'AgentTaskType.ReportExecutionRequest'. + schema: + $ref: '#/components/schemas/ReportResultSummary' + - name: RuleItemResults + in: query + description: Specifies the rule item results when this task represents a 'AgentTaskType.ReportExecutionRequest'. + schema: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RuleItemResult' + description: 'Dictionary>' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - submitAgentTaskResult + summary: 'Adds task result data for the given agent task, called by the agent.' + description: 'Adds task result data for the given agent task, called by the agent.' + operationId: SubmitAgentTaskResult_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAgentTaskResult' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /credential: + get: + tags: + - credential + summary: Get specific credentials for requested type and key (name). + description: Get specific credentials for requested type and key (name). + operationId: GetCredentials_Get + parameters: + - name: CredentialsType + in: query + description: Specifies the credentials type. + schema: + enum: + - Unknown + - Shell + - Database + - FTP + - Cloud + - ESX + - ITSM + - Splunk + type: string + x-nullable: false + - name: Key + in: query + description: Specifies the key (name) of the required credentials. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + post: + tags: + - credential + summary: Get specific credentials for requested type and key (name). + description: Get specific credentials for requested type and key (name). + operationId: GetCredentials_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCredentials' + x-bodyName: body + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplates: + get: + tags: + - policyTemplates + summary: Gets matching config templates. + description: Gets matching config templates. + operationId: GetPolicyTemplates_Get + parameters: + - name: Name + in: query + description: Specifies a single policy name (id) to search for. + schema: + type: string + - name: NameContains + in: query + description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. + schema: + type: string + - name: Names + in: query + description: Specifies a list of policy names (ids) to search for. + style: form + schema: + type: array + items: + type: string + - name: ReturnXml + in: query + description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: ReturnSignatures + in: query + description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: IsActive + in: query + description: Get the Active version of a template + schema: + type: boolean + - name: IsLatest + in: query + description: Get the Latest version of a template + schema: + type: boolean + - name: IsSystem + in: query + description: Get System supplied templates + schema: + type: boolean + - name: HasRules + in: query + description: Get templates with Rules + schema: + type: boolean + - name: HasTrackers + in: query + description: Get templates with Trackers + schema: + type: boolean + - name: TemplateTrackerTypes + in: query + description: Specifies the template's tracker types. + style: form + schema: + type: array + items: + type: string + - name: TemplateVersion + in: query + description: Specifies the template version to get. + schema: + type: string + - name: UsageTags + in: query + description: Specifies the policy usage types to get. + style: form + schema: + type: array + items: + type: string + - name: IsTrusted + in: query + description: Policy templates which contains commands that are trusted + schema: + type: boolean + - name: NotificationRefId + in: query + description: Policy templates associated with the supplied notification ref id + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplatesResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplates + summary: Gets matching config templates. + description: Gets matching config templates. + operationId: GetPolicyTemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplates' + x-bodyName: body + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplatesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplateVariables: + get: + tags: + - policyTemplateVariables + summary: A request to get a list of variable definitions from a named report to be collected by the agent. + description: A request to get a list of variable definitions from a named report to be collected by the agent. + operationId: GetPolicyTemplateVariables_Get + parameters: + - name: PolicyTemplateName + in: query + description: Specifies the report template name. + schema: + type: string + - name: ReturnConfigAsXml + in: query + description: 'For any config that needs to be applied, return as XML.' + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The list of variable definitions from a named report to be collected by the agent. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplateVariablesResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplateVariables + summary: A request to get a list of variable definitions from a named report to be collected by the agent. + description: A request to get a list of variable definitions from a named report to be collected by the agent. + operationId: GetPolicyTemplateVariables_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplateVariables' + x-bodyName: body + responses: + '200': + description: The list of variable definitions from a named report to be collected by the agent. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplateVariablesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceCredentials: + get: + tags: + - deviceCredentials + summary: A request to get the names of credentials associated with an agent. + description: A request to get the names of credentials associated with an agent. + operationId: GetCredentialsForAgentDevice_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - deviceCredentials + summary: A request to get the names of credentials associated with an agent. + description: A request to get the names of credentials associated with an agent. + operationId: GetCredentialsForAgentDevice_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCredentialsForAgentDevice' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceDbCredentials: + get: + tags: + - deviceDbCredentials + summary: A request to get the database credentials associated with a database proxied agent. + description: A request to get the database credentials associated with a database proxied agent. + operationId: GetDbCredentialForDatabaseAgentDevice_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + post: + tags: + - deviceDbCredentials + summary: A request to get the database credentials associated with a database proxied agent. + description: A request to get the database credentials associated with a database proxied agent. + operationId: GetDbCredentialForDatabaseAgentDevice_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDbCredentialForDatabaseAgentDevice' + x-bodyName: body + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupMemberships: + get: + tags: + - groupMemberships + summary: 'A request to return groups this agent or group is a member of, including parents of parents etc.' + description: 'A request to return groups this agent or group is a member of, including parents of parents etc.' + operationId: GroupMemberships_Get + parameters: + - name: MemberName + in: query + description: Specifies the member name to retrieve group memberships for. + schema: + type: string + - name: MemberType + in: query + description: Specifies the member type of the member specified by MemberName (AgentDevice or Group). + schema: + enum: + - None + - AgentDevice + - Group + type: string + x-nullable: false + - name: ExcludeInherited + in: query + description: 'Specifies a value indicating whether to exclude inherited groups. This defaults to false meaning that all groups including those that are parents of thoseexplicitly set are returned, for example if Windows 7 group is a member of Windows group, and a device is explicitly a member of Windows 7the function will return ''Windows, Windows 7''. If ''ExcludeInherited'' is true, only ''Windows 7'' will be returned.' + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - groupMemberships + summary: 'A request to return groups this agent or group is a member of, including parents of parents etc.' + description: 'A request to return groups this agent or group is a member of, including parents of parents etc.' + operationId: GroupMemberships_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GroupMemberships' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents: + get: + tags: + - agents + summary: A request to return agents matching the device filter. + description: A request to return agents matching the device filter. + operationId: GetAgents_Get + parameters: + - name: ExcludeTotalCount + in: query + description: Specifies a value indicating whether to calculate the total count returned in the GetAgentsResponse.Total + schema: + type: boolean + x-nullable: false + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: GetAgentGroupDetails + in: query + description: Specifies a value indicating whether to get agent group details. + schema: + type: boolean + x-nullable: false + - name: GetRelatedCredentials + in: query + description: Specifies a value indicating whether to get related credentials. + schema: + type: boolean + x-nullable: false + - name: GetRelatedPlannedChanges + in: query + description: Specifies a value indicating whether to get related planned changes. + schema: + type: boolean + x-nullable: false + - name: GetRelatedProxyAgents + in: query + description: Specifies a value indicating whether to get related proxy agents. + schema: + type: boolean + x-nullable: false + - name: GetRelatedTemplates + in: query + description: Specifies a value indicating whether to get templates applied to the returned agents. + schema: + type: boolean + x-nullable: false + - name: IncludeMasterInFilter + in: query + description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: A request to return agents matching the device filter. + description: A request to return agents matching the device filter. + operationId: GetAgents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgents' + x-bodyName: body + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/register: + get: + tags: + - agents + summary: Registers the details of an Agent with the system. + description: Registers the details of an Agent with the system. + operationId: RegisterAgentregister_Get + parameters: + - name: CanProxy + in: query + description: Specifies a value indicating whether the agent can proxy connections to other devices. + schema: + type: boolean + x-nullable: false + - name: CredentialKey + in: query + description: Specifies the credential key. Only allowed for proxied devices. + schema: + type: string + - name: DbConnection + in: query + description: Specifies the details for a database connection. + schema: + $ref: '#/components/schemas/DbConnection' + - name: DeviceName + in: query + description: Specifies the device name. + schema: + type: string + - name: GroupNames + in: query + description: Specifies the group names. Only allowed for proxied devices. + style: form + schema: + type: array + items: + type: string + - name: HostName + in: query + description: Specifies the host name. This is the name or IP address used for agentless access to this device by a proxy. + schema: + type: string + - name: HostType + in: query + description: Specifies the host type. + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + - name: MacAddresses + in: query + description: Specifies the mac addresses. + schema: + type: string + - name: IPv4 + in: query + description: Specifies the v4 ip address. + schema: + type: string + - name: IPv6 + in: query + description: Specifies the v6 ip address. + schema: + type: string + - name: LegacyHubId + in: query + description: Specifies the legacy hub id. + schema: + type: string + - name: DiscoveryId + in: query + description: Specifies the internal discovery-based id. + schema: + type: string + - name: DiscoveryTaskId + in: query + description: Specifies the internal discovery task id. + schema: + type: string + - name: OnlineDetection + in: query + description: Specifies the method to use when detecting if a proxed device is online + schema: + enum: + - None + - Ping + - TcpConnect + type: string + x-nullable: false + - name: Os + in: query + description: Specifies the Operating System full description as reported by the device. + schema: + type: string + - name: KnownOsName + in: query + description: Specifies the Operating System from the list of known Os names. + schema: + type: string + - name: OsUserSpecified + in: query + description: 'Specifies the operating system as entered by the user. This will override the discovered Os in the UI, if specified.' + schema: + type: string + - name: PollPeriodSeconds + in: query + description: Specifies the poll period in seconds. + schema: + type: integer + format: int32 + - name: ProxiedByAgentId + in: query + description: Specifies the agent id of the proxy agent this device will be proxied by. + schema: + type: string + - name: Registered + in: query + description: Specifies a value indicating whether registered. + schema: + type: boolean + x-nullable: false + - name: BaselineSendEnabled + in: query + description: Specifies that the agent send baseline events flag should be set according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UniqueId + in: query + description: 'Specifies a value uniquely identifying the agent independent of name or agent id from a previous registration. Used to detect a need to re-register when underlying hub store has been emptied, otherwise the autoincrementing agent id counter can result in clashes as already used ids are reissued to different agents.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents a remote NNT Agent. May be a 1.x Agent, Gen7 Agent or Express Agent or a proxied device.' + content: + application/json: + schema: + $ref: '#/components/schemas/Agent' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: Registers the details of an Agent with the system. + description: Registers the details of an Agent with the system. + operationId: RegisterAgentregister_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RegisterAgent' + x-bodyName: body + responses: + '200': + description: 'Represents a remote NNT Agent. May be a 1.x Agent, Gen7 Agent or Express Agent or a proxied device.' + content: + application/json: + schema: + $ref: '#/components/schemas/Agent' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/update: + get: + tags: + - agents + summary: Update an Agent's details. + description: Update an Agent's details. + operationId: UpdateAgentupdate_Get + parameters: + - name: Agent + in: query + description: Specifies the agent being updated + schema: + $ref: '#/components/schemas/Agent' + - name: CredentialKey + in: query + description: Specifies the credential key to associate with this agent. e.g ssh credentials. + schema: + type: string + - name: DbConnection + in: query + description: Specifies the details for a database connection. + schema: + $ref: '#/components/schemas/DbConnection' + - name: GroupNames + in: query + description: Specifies a list of group names this agent belongs to. + style: form + schema: + type: array + items: + type: string + - name: UpdateAgentDeviceName + in: query + description: Specifies that the agent device name should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateAgentHostType + in: query + description: Specifies that the agent host type should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateCredentialKey + in: query + description: Specifies that the agent credential key should be updated according to the value specified. + schema: + type: boolean + x-nullable: false + - name: UpdateDbConnectionDetails + in: query + description: Specifies that the agent database connection details should be updated according to the values specified. + schema: + type: boolean + x-nullable: false + - name: UpdateDiagnosticModeEnabled + in: query + description: Specifies that the agent diagnostic mode flag should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateEventBlockEnabled + in: query + description: Specifies that the agent events blocked flag should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateGroupNames + in: query + description: Specifies that the agent group names should be updated according to the value specified. + schema: + type: boolean + x-nullable: false + - name: UpdateHostName + in: query + description: Specifies that the agent host name should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateIPv4 + in: query + description: Specifies that the IPv4 should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateOnlineDetection + in: query + description: Specifies that the agentonline detection mode should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateOsUserSpecified + in: query + description: Specifies that the agent user specified os type should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateBaselineSendEnabled + in: query + description: Specifies that the agent send baseline events flag should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: ClearUniqueId + in: query + description: 'Specifies that the agent UniqueId should be cleared, allowing registration by another device of the same name, but different UniqueId.' + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: Update an Agent's details. + description: Update an Agent's details. + operationId: UpdateAgentupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateAgent' + x-bodyName: body + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/search: + get: + tags: + - agents + summary: A request to find agents matching the device filter and search criteria. + description: A request to find agents matching the device filter and search criteria. + operationId: SearchAgentssearch_Get + parameters: + - name: DeviceFilter + in: query + description: Limits the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: MatchText + in: query + description: Text to search for in the Agents fields. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for SearchAgents + content: + application/json: + schema: + $ref: '#/components/schemas/SearchAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: A request to find agents matching the device filter and search criteria. + description: A request to find agents matching the device filter and search criteria. + operationId: SearchAgentssearch_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SearchAgents' + x-bodyName: body + responses: + '200': + description: The response object for SearchAgents + content: + application/json: + schema: + $ref: '#/components/schemas/SearchAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/preRegister: + get: + tags: + - agents + summary: Registers the details of the specified Agents with the system. + description: Registers the details of the specified Agents with the system. + operationId: PreRegisterAgentspreRegister_Get + parameters: + - name: Agents + in: query + description: A list of agents to pre-register at the hub. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/RegisterAgent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for PreRegisterAgents + content: + application/json: + schema: + $ref: '#/components/schemas/PreRegisterAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: Registers the details of the specified Agents with the system. + description: Registers the details of the specified Agents with the system. + operationId: PreRegisterAgentspreRegister_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PreRegisterAgents' + x-bodyName: body + responses: + '200': + description: The response object for PreRegisterAgents + content: + application/json: + schema: + $ref: '#/components/schemas/PreRegisterAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceConfig: + get: + tags: + - deviceConfig + summary: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + description: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + operationId: GetDeviceConfig_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent and device id. Either 'AgentDevice' or 'AgentDeviceId' can be used. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: AgentDeviceId + in: query + description: 'Specifies the combined agent and device id, for example 1,1.' + schema: + type: string + - name: ReturnDocument + in: query + description: Specifies a value indicating whether return to return a device template object in GetDeviceConfigResponse.DeviceTemplate if trueor an xml string in GetDeviceConfigResponse.Xml if false. + schema: + type: boolean + x-nullable: false + - name: ReturnDocumentAsPolicyRuleSet + in: query + description: Specifies a value indicating whether return to return a device template rule-set object in GetDeviceConfigResponse.DeviceTemplate if trueor an xml string in GetDeviceConfigResponse.Xml if false. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents the tracking configuration template from the merged result of the group configurations for the groups the device is in. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceConfigResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceConfig + summary: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + description: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + operationId: GetDeviceConfig_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceConfig' + x-bodyName: body + responses: + '200': + description: Represents the tracking configuration template from the merged result of the group configurations for the groups the device is in. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceConfigResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceSettings: + get: + tags: + - deviceSettings + summary: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + description: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + operationId: GetDeviceSettings_Get + parameters: + - name: AgentId + in: query + description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: GroupName + in: query + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceSettingsResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceSettings + summary: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + description: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + operationId: GetDeviceSettings_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceSettings' + x-bodyName: body + responses: + '200': + description: 'Represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceSettingsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /events: + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEvents_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/start/{StartUtc}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtc_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtc_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/end/{End}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsendEnd_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/start/{StartUtc}/end/{End}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtcendEnd_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtcendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/skip/{Skip}/take/{Take}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsskipSkiptakeTake_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsskipSkiptakeTake_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/{EventId}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsEventId_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsEventId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /alertEvents/add: + get: + tags: + - alertEvents + summary: Adds a list of alert events to the system. + description: Adds a list of alert events to the system. + operationId: SubmitAlertEventsadd_Get + parameters: + - name: Events + in: query + description: Specifies the list of alert events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - alertEvents + summary: Adds a list of alert events to the system. + description: Adds a list of alert events to the system. + operationId: SubmitAlertEventsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAlertEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /alertEvents/limitedAdd: + get: + tags: + - alertEvents + summary: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitAlertEventsLimitedlimitedAdd_Get + parameters: + - name: Events + in: query + description: Specifies the list of alert events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAlertEventsLimitedResponse' + security: + - Bearer: [ ] + post: + tags: + - alertEvents + summary: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitAlertEventsLimitedlimitedAdd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAlertEventsLimited' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAlertEventsLimitedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /baselineEvents/add: + get: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. + description: Adds a list of baseline events to the system. + operationId: SubmitBaselineEventsadd_Get + parameters: + - name: Events + in: query + description: Specifies the list of baseline events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. + description: Adds a list of baseline events to the system. + operationId: SubmitBaselineEventsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitBaselineEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /baselineEvents/limitedAdd: + get: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitBaselineEventsLimitedlimitedAdd_Get + parameters: + - name: Events + in: query + description: Specifies the list of baseline events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitBaselineEventsLimitedResponse' + security: + - Bearer: [ ] + post: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitBaselineEventsLimitedlimitedAdd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitBaselineEventsLimited' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitBaselineEventsLimitedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceEvents/add: + get: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. + description: Adds a list of device change events to the system. + operationId: SubmitDeviceEventsadd_Get + parameters: + - name: Events + in: query + description: Specifies the list of device events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. + description: Adds a list of device change events to the system. + operationId: SubmitDeviceEventsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitDeviceEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceEvents/limitedAdd: + get: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitDeviceEventsLimitedlimitedAdd_Get + parameters: + - name: Events + in: query + description: Specifies the list of device events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitDeviceEventsLimitedResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitDeviceEventsLimitedlimitedAdd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitDeviceEventsLimited' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitDeviceEventsLimitedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/ready: + get: + tags: + - status + summary: Gets whether system is booted and ready for login. + description: Gets whether system is booted and ready for login. + operationId: SystemReadyready_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Indicates if system is booted and ready for login. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemReadyResponse' + post: + tags: + - status + summary: Gets whether system is booted and ready for login. + description: Gets whether system is booted and ready for login. + operationId: SystemReadyready_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SystemReady' + x-bodyName: body + responses: + '200': + description: Indicates if system is booted and ready for login. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemReadyResponse' + parameters: + - $ref: '#/components/parameters/Accept' + /status/system: + get: + tags: + - status + summary: Gets system version and config settings once logged in. + description: Gets system version and config settings once logged in. + operationId: SystemDetailssystem_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: System version and config settings. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemDetailsResponse' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Gets system version and config settings once logged in. + description: Gets system version and config settings once logged in. + operationId: SystemDetailssystem_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SystemDetails' + x-bodyName: body + responses: + '200': + description: System version and config settings. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemDetailsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/backgroundtasks: + get: + tags: + - status + summary: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + description: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + operationId: GetBackgroundTaskStatusesbackgroundtasks_Get + parameters: + - name: UserName + in: query + description: 'Specifies a specific user name to retrieve tasks for (Optional, but only Admin users can retrieve tasks for other users or internal system tasks).' + schema: + type: string + - name: StartDateTimeUtc + in: query + description: Specifies the start time (in UTC) for a task to be retrieved (Optional). + schema: + type: string + format: date-time + - name: EndDateTimeUtc + in: query + description: Specifies the end time (in UTC) for a task to be retrieved (Optional). + schema: + type: string + format: date-time + - name: Statuses + in: query + description: Specifies the status of tasks to be retrieved (Optional). + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies a list of specific task ids to retrieved (Optional). + style: form + schema: + type: array + items: + type: string + - name: TaskTypes + in: query + description: Specifies a list of specific task types to be retrieved (Optional). + style: form + schema: + type: array + items: + type: string + - name: IncludeDependentTasks + in: query + description: Specifies whether to return the tasks that each task depends on in its DependentTasks property (Optional). + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' + security: + - Bearer: [ ] + post: + tags: + - status + summary: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + description: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + operationId: GetBackgroundTaskStatusesbackgroundtasks_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetBackgroundTaskStatuses' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/eventsOnIncomingQueue: + get: + tags: + - status + summary: Gets the number of events currently in the processing queue. + description: Gets the number of events currently in the processing queue. + operationId: EventsOnIncomingQueueeventsOnIncomingQueue_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: integer + format: int32 + security: + - Bearer: [ ] + post: + tags: + - status + summary: Gets the number of events currently in the processing queue. + description: Gets the number of events currently in the processing queue. + operationId: EventsOnIncomingQueueeventsOnIncomingQueue_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/EventsOnIncomingQueue' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: integer + format: int32 + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/messageStatus: + get: + tags: + - status + summary: 'Returns the number of internal event notification messages received, processed or failed.' + description: 'Returns the number of internal event notification messages received, processed or failed.' + operationId: EventMessageStatusmessageStatus_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - status + summary: 'Returns the number of internal event notification messages received, processed or failed.' + description: 'Returns the number of internal event notification messages received, processed or failed.' + operationId: EventMessageStatusmessageStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/EventMessageStatus' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/pipeline: + get: + tags: + - status + summary: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + description: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + operationId: GetPipelineStatuspipeline_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + enum: + - Unknown + - Starting + - Up + - Stopping + - Down + - Busy + - Fault + - RequiresUpgrade + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - status + summary: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + description: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + operationId: GetPipelineStatuspipeline_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPipelineStatus' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + enum: + - Unknown + - Starting + - Up + - Stopping + - Down + - Busy + - Fault + - RequiresUpgrade + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/pipelineMetrics: + get: + tags: + - status + summary: Gets system performance metrics. + description: Gets system performance metrics. + operationId: GetPipelineMetricspipelineMetrics_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/PerformanceSnapshot' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Gets system performance metrics. + description: Gets system performance metrics. + operationId: GetPipelineMetricspipelineMetrics_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPipelineMetrics' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/PerformanceSnapshot' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/workload: + get: + tags: + - status + summary: Returns the pipeline workload. + description: Returns the pipeline workload. + operationId: GetWorkloadStatsworkload_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: number + format: double + x-nullable: false + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Returns the pipeline workload. + description: Returns the pipeline workload. + operationId: GetWorkloadStatsworkload_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetWorkloadStats' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: number + format: double + x-nullable: false + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/cache: + get: + tags: + - status + summary: Returns the cache statistics. + description: Returns the cache statistics. + operationId: GetCacheStatscache_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The cache statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/GetCacheStatsResponse' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Returns the cache statistics. + description: Returns the cache statistics. + operationId: GetCacheStatscache_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCacheStats' + x-bodyName: body + responses: + '200': + description: The cache statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/GetCacheStatsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /openapi3.yaml: + get: + tags: + - openapi3.yaml + operationId: GetOpenApi3Yaml_Get + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + parameters: + - $ref: '#/components/parameters/Accept' + /reports/availableTypes: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetAvailableReportTypesavailableTypes_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportTypesResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetAvailableReportTypesavailableTypes_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAvailableReportTypes' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportTypesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/template: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatetemplate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatetemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/templates: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatestemplates_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportTemplatesResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatestemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportTemplates' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportTemplatesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledReportsscheduled_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledReportsscheduled_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetScheduledReports' + x-bodyName: body + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/updatetemplate: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateReportTemplateupdatetemplate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReportTemplateResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateReportTemplateupdatetemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateReportTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReportTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/uploadreporttemplate: + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UploadReportTemplateuploadreporttemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UploadReportTemplate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/deletecustomreporttemplate: + get: + tags: + - reports + summary: Deletes a report layout template of the specified type and name + description: Deletes a report layout template of the specified type and name + operationId: DeleteCustomReportTemplatedeletecustomreporttemplate_Get + parameters: + - name: ReportTemplateType + in: query + description: Gets or sets the ReportTemplateType of the report template to delete. + required: true + schema: + enum: + - None + - ErrorReport + - AggregateReportTemplate + - EventsReport + - PlannedChangeReport + - TrackingTemplateReport + - ExecutiveSummaryReport + - ComplianceReport + - DeviceReport + - ScheduledItemsReport + - VulnerabilitySummaryReport + type: string + x-nullable: false + - name: TemplateName + in: query + description: Gets or sets the name of the report template to delete. + required: true + schema: + type: string + - name: TemplateVersion + in: query + description: Gets or sets the version of the report template to delete. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Deletes a report layout template of the specified type and name + description: Deletes a report layout template of the specified type and name + operationId: DeleteCustomReportTemplatedeletecustomreporttemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteCustomReportTemplate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/devicemonitoring: + get: + tags: + - reports + summary: A request to gets the data for a device monitoring report + description: A request to gets the data for a device monitoring report + operationId: DataSpecDeviceMonitoringReportdevicemonitoring_Get + parameters: + - name: DateRange + in: query + description: Provides information about how to calculate the start and end dates when performing the query + required: true + schema: + $ref: '#/components/schemas/ReportDateRange' + - name: OnlineStatuses + in: query + description: Gets or sets the online statuses of the devices to return. Optional. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Id + in: query + description: Specifies the Id of the data query specification + schema: + type: string + - name: Type + in: query + description: The Type name of the data query specification + schema: + type: string + - name: IteratorValues + in: query + description: 'Used to specify the list of items to report on, for data query specifications that support this. If this is not supplied, SelectionQuery can be used to specify a query to be performed to find the list of ids to report on' + style: form + schema: + type: array + items: + type: string + - name: SelectionQuery + in: query + description: 'The SelectionQuery is an alternative to supplying a list of values to report on in IteratorValues. It can be used to represent a query such as ''find Planned Change Instances where the name starts with XYZ'', returning a set of Planned Change Instance ids to report on.' + schema: + $ref: '#/components/schemas/SelectionQuery' + - name: Groups + in: query + description: Specifies the Groups (and implicitly and child groups) to be reported on in the report. + style: form + schema: + type: array + items: + type: string + - name: ItemName + in: query + description: 'Specifies the descriptive name of the result item, for example ''report'', ''planned change'', ''event'' etc.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The returned data for populating a device monitoring report + content: + application/json: + schema: + $ref: '#/components/schemas/DataSpecDeviceMonitoringReportResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: A request to gets the data for a device monitoring report + description: A request to gets the data for a device monitoring report + operationId: DataSpecDeviceMonitoringReportdevicemonitoring_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DataSpecDeviceMonitoringReport' + x-bodyName: body + responses: + '200': + description: The returned data for populating a device monitoring report + content: + application/json: + schema: + $ref: '#/components/schemas/DataSpecDeviceMonitoringReportResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/ruleresults: + get: + tags: + - reports + operationId: GetRuleResultsruleresults_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetRuleResultsResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + operationId: GetRuleResultsruleresults_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetRuleResults' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetRuleResultsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/compliancesummarydata: + get: + tags: + - stats + operationId: GetComplianceReportSummaryDatacompliancesummarydata_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: ReportInstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ComplianceReportSummaryResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + operationId: GetComplianceReportSummaryDatacompliancesummarydata_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceReportSummaryData' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ComplianceReportSummaryResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/plannedChanges: + get: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChanges_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChanges_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChanges' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/compliancedata: + get: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedata_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedata_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/getavailablecompliancedata: + get: + tags: + - stats + summary: Get a list of groups or devices that have report data available for them + description: Get a list of groups or devices that have report data available for them + operationId: GetAvailableComplianceDatagetavailablecompliancedata_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Get a list of groups or devices that have report data available for them + description: Get a list of groups or devices that have report data available for them + operationId: GetAvailableComplianceDatagetavailablecompliancedata_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAvailableComplianceData' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/deviceActivity: + get: + tags: + - stats + summary: Gets a list of inactive devices matching the filter. + description: Gets a list of inactive devices matching the filter. + operationId: GetDeviceActivitydeviceActivity_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents the list of devices matching the request criteria that have been inactive in the specified period. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceActivityResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Gets a list of inactive devices matching the filter. + description: Gets a list of inactive devices matching the filter. + operationId: GetDeviceActivitydeviceActivity_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceActivity' + x-bodyName: body + responses: + '200': + description: Represents the list of devices matching the request criteria that have been inactive in the specified period. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceActivityResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/events: + get: + tags: + - stats + summary: 'Gets a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + description: 'Gets a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + operationId: GetEventCountsevents_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventCountsResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Gets a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + description: 'Gets a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + operationId: GetEventCountsevents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEventCounts' + x-bodyName: body + responses: + '200': + description: 'Represents a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventCountsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/noisydevices: + get: + tags: + - stats + summary: 'Gets a summary of event counts for top N noisiest devices in the specified group, for the specified time period.' + description: 'Gets a summary of event counts for top N noisiest devices in the specified group, for the specified time period.' + operationId: GetNoisyDevicesnoisydevices_Get + parameters: + - name: TopN + in: query + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GetEventCountsResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Gets a summary of event counts for top N noisiest devices in the specified group, for the specified time period.' + description: 'Gets a summary of event counts for top N noisiest devices in the specified group, for the specified time period.' + operationId: GetNoisyDevicesnoisydevices_Post + parameters: + - name: TopN + in: query + schema: + type: integer + format: int32 + x-nullable: false + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetNoisyDevices' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GetEventCountsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reportExecute: + get: + tags: + - reportExecute + summary: Report Service + description: Report Service + operationId: ExecuteReport_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteReportResponse' + security: + - Bearer: [ ] + post: + tags: + - reportExecute + summary: Report Service + description: Report Service + operationId: ExecuteReport_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExecuteReport' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteReportResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reportRenderIsCached: + get: + tags: + - reportRenderIsCached + summary: Report Service + description: Report Service + operationId: RenderReportIsCached_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + schema: + type: string + - name: RuleSetResultEventId + in: query + description: 'For compliance reports only, if the InstanceId and ReportItemId are not available, the id of a previously stored RuleSetResultEvent can be supplied in this parameter.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - reportRenderIsCached + summary: Report Service + description: Report Service + operationId: RenderReportIsCached_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RenderReportIsCached' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reportRender: + get: + tags: + - reportRender + summary: Report Service + description: Report Service + operationId: RenderReport_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: RuleSetResultEventId + in: query + description: 'For compliance reports only, if the InstanceId and ReportItemId are not available, the id of a previously stored RuleSetResultEvent can be supplied in this parameter.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + post: + tags: + - reportRender + summary: Report Service + description: Report Service + operationId: RenderReport_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RenderReport' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reportRenderStart: + get: + tags: + - reportRenderStart + summary: Report Service + description: Report Service + operationId: RenderReportStart_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: RuleSetResultEventId + in: query + description: 'For compliance reports only, if the InstanceId and ReportItemId are not available, the id of a previously stored RuleSetResultEvent can be supplied in this parameter.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + post: + tags: + - reportRenderStart + summary: Report Service + description: Report Service + operationId: RenderReportStart_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RenderReportStart' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered/download: + get: + tags: + - reports + summary: Gets a previously generated report output file + description: Gets a previously generated report output file + operationId: GetScheduledInstanceOutputscheduledinstancesrendereddownload_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Gets a previously generated report output file + description: Gets a previously generated report output file + operationId: GetScheduledInstanceOutputscheduledinstancesrendereddownload_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetScheduledInstanceOutput' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered/delete: + get: + tags: + - reports + summary: Deletes previously generated report output files + description: Deletes previously generated report output files + operationId: DeleteScheduledInstanceOutputsscheduledinstancesrendereddelete_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Deletes previously generated report output files + description: Deletes previously generated report output files + operationId: DeleteScheduledInstanceOutputsscheduledinstancesrendereddelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteScheduledInstanceOutputs' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/delete: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledInstancescheduledinstancesdelete_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledInstancescheduledinstancesdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteScheduledInstance' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instance/updateLifetime: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledInstanceLifetimescheduledinstanceupdateLifetime_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstancesResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledInstanceLifetimescheduledinstanceupdateLifetime_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateScheduledInstanceLifetime' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstancesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstanceRenderedscheduledinstancesrendered_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstanceRenderedResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstanceRenderedscheduledinstancesrendered_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetScheduledInstanceRendered' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstanceRenderedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/add: + get: + tags: + - reports + summary: Adds a new schedulable report of the type specified by the Id parameter + description: Adds a new schedulable report of the type specified by the Id parameter + operationId: AddScheduledReportscheduledadd_Get + parameters: + - name: Id + in: query + description: 'The id of the type of report to add, from the list supplied by GetAvailableReportTypes' + required: true + schema: + type: string + - name: IsPublic + in: query + description: Indicates whether the report/query can be seen by everyone + schema: + type: boolean + x-nullable: false + - name: IsEditable + in: query + description: 'Indicates whether the report/query can be edited/deleted by everyone. Note, if this is true, IsPublic must also be true' + schema: + type: boolean + x-nullable: false + - name: IsHidden + in: query + description: Indicates whether the report/query is visible in the reports list. Used to create temporary items for interactive 'export to csv' functions. + schema: + type: boolean + x-nullable: false + - name: AsCopyOf + in: query + description: Specifies as a copy of an existing the report/query with this Id + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Adds a new schedulable report of the type specified by the Id parameter + description: Adds a new schedulable report of the type specified by the Id parameter + operationId: AddScheduledReportscheduledadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddScheduledReport' + x-bodyName: body + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/update: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledReportscheduledupdate_Get + parameters: + - name: ShowTableOfContents + in: query + description: Specifies the updated setting for when a table of content page is shown. + schema: + enum: + - None + - Always + - Auto + type: string + x-nullable: false + - name: ContainerReport + in: query + description: Specifies the updated definition of the container report. + schema: + $ref: '#/components/schemas/ReportSpecification' + - name: Reports + in: query + description: Specifies the updated definition of the sub reports. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/ReportSpecification' + - name: KeepUnscheduledResultsForMinutes + in: query + description: 'Specifies how long to keep ''adhoc'' (ie non-scheduled) report results for, in minutes.' + schema: + type: integer + format: int32 + x-nullable: false + - name: KeepScheduledResultsForMinutes + in: query + description: 'Specifies how long to keep scheduled report results for, in minutes.' + schema: + type: integer + format: int32 + x-nullable: false + - name: WaitForAdhocResultsMinutes + in: query + description: 'Specifies long to wait for a run''s queries to complete, in minutes.' + schema: + type: integer + format: int32 + x-nullable: false + - name: OverrideWaitForResults + in: query + description: Specifies whether to override the default behaviour for scheduled queries of waiting until the next scheduled run and use the value specified by WaitForAdhocResultsMinutes instead. + schema: + type: boolean + x-nullable: false + - name: Schedule + in: query + description: Specifies the updated schedule on which the report is run. + schema: + $ref: '#/components/schemas/ReportSchedule' + - name: EmailDelivery + in: query + description: Specifies the updated email delivery settings. + schema: + $ref: '#/components/schemas/ReportEmailDelivery' + - name: IsPublic + in: query + description: Specifies whether the report/query can be seen by everyone. + schema: + type: boolean + x-nullable: false + - name: IsEditable + in: query + description: Specifies whether the report/query can be edited by everyone. + schema: + type: boolean + x-nullable: false + - name: IsHidden + in: query + description: Specifies whether the report/query can be seen in the UI. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledReportscheduledupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateScheduledReport' + x-bodyName: body + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/delete: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledReportsscheduleddelete_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledReportsscheduleddelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteScheduledReports' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstancesscheduledinstances_Get + parameters: + - name: SummaryOnly + in: query + description: Returns only summary information for use in reporting UI page + schema: + type: boolean + x-nullable: false + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstancesResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstancesscheduledinstances_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetScheduledInstances' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstancesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /uploadAgentUpdate: + get: + tags: + - uploadAgentUpdate + summary: Upload an Agent Update + description: Upload an Agent Update + operationId: UploadAgentUpdate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - uploadAgentUpdate + summary: Upload an Agent Update + description: Upload an Agent Update + operationId: UploadAgentUpdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UploadAgentUpdate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /updatehubdetails: + get: + tags: + - updatehubdetails + summary: Update the HUbDetails.xml file for the specified agents / groups + description: Update the HUbDetails.xml file for the specified agents / groups + operationId: UpdateHubDetails_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - updatehubdetails + summary: Update the HUbDetails.xml file for the specified agents / groups + description: Update the HUbDetails.xml file for the specified agents / groups + operationId: UpdateHubDetails_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateHubDetails' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/downloadAgentUpdate/{VersionRequested}': + get: + tags: + - downloadAgentUpdate + summary: Download an update package for the agent. + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequested_Get + parameters: + - name: VersionRequested + in: query + description: 'Used when requesting an update file from the hub, specifies the specific version required.' + schema: + type: string + - name: UpdateType + in: query + description: 'Specifies the update type to download (e,g RPM, DEB etc).' + schema: + enum: + - Unknown + - MultiPlatform + - Windows + - WindowsNetCore + - LinuxRPM + - LinuxRPMNetCore + - UbuntuDEB + - UbuntuDEBNetCore + - MacOSXPKG + - MacOSXPKGNetCore + - AIXRPM + - SolarisPKG + - WindowsNetCoreArm + - LinuxRPMNetCoreArm + - UbuntuDEBNetCoreArm + - MacOSXPKGNetCoreArm + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - downloadAgentUpdate + summary: Download an update package for the agent. + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequested_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DownloadUpdate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/downloadAgentUpdate/{VersionRequested}/{UpdateType}': + get: + tags: + - downloadAgentUpdate + summary: Download an update package for the agent. + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequestedUpdateType_Get + parameters: + - name: VersionRequested + in: query + description: 'Used when requesting an update file from the hub, specifies the specific version required.' + schema: + type: string + - name: UpdateType + in: query + description: 'Specifies the update type to download (e,g RPM, DEB etc).' + schema: + enum: + - Unknown + - MultiPlatform + - Windows + - WindowsNetCore + - LinuxRPM + - LinuxRPMNetCore + - UbuntuDEB + - UbuntuDEBNetCore + - MacOSXPKG + - MacOSXPKGNetCore + - AIXRPM + - SolarisPKG + - WindowsNetCoreArm + - LinuxRPMNetCoreArm + - UbuntuDEBNetCoreArm + - MacOSXPKGNetCoreArm + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - downloadAgentUpdate + summary: Download an update package for the agent. + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequestedUpdateType_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DownloadUpdate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentUpdates/delete: + get: + tags: + - agentUpdates + summary: Deletes the specified Agent update. + description: Deletes the specified Agent update. + operationId: DeleteAgentUpdatedelete_Get + parameters: + - name: Id + in: query + description: Specifies the agent update ID to delete. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - agentUpdates + summary: Deletes the specified Agent update. + description: Deletes the specified Agent update. + operationId: DeleteAgentUpdatedelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteAgentUpdate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentUpdates: + get: + tags: + - agentUpdates + summary: 'Gets a list of Agent updates, by version or specific ID.' + description: 'Gets a list of Agent updates, by version or specific ID.' + operationId: GetAgentUpdates_Get + parameters: + - name: VersionRequested + in: query + description: Specifies the (optional) version to get details for. + schema: + type: string + - name: Id + in: query + description: Specifies the specific agent update ID to get. + schema: + type: string + - name: UpdateType + in: query + description: 'Gets or sets the update type (deb, rpm etc)' + schema: + enum: + - Unknown + - MultiPlatform + - Windows + - WindowsNetCore + - LinuxRPM + - LinuxRPMNetCore + - UbuntuDEB + - UbuntuDEBNetCore + - MacOSXPKG + - MacOSXPKGNetCore + - AIXRPM + - SolarisPKG + - WindowsNetCoreArm + - LinuxRPMNetCoreArm + - UbuntuDEBNetCoreArm + - MacOSXPKGNetCoreArm + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/AgentSoftwareUpdate' + security: + - Bearer: [ ] + post: + tags: + - agentUpdates + summary: 'Gets a list of Agent updates, by version or specific ID.' + description: 'Gets a list of Agent updates, by version or specific ID.' + operationId: GetAgentUpdates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentUpdates' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/AgentSoftwareUpdate' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules: + get: + tags: + - agentSoftwareUpdateSchedules + summary: Gets the agent software update schedule for a group. + description: Gets the agent software update schedule for a group. + operationId: GetAgentSoftwareUpdateScheduleForGroup_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name to remove the schedule for. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + security: + - Bearer: [ ] + post: + tags: + - agentSoftwareUpdateSchedules + summary: Gets the agent software update schedule for a group. + description: Gets the agent software update schedule for a group. + operationId: GetAgentSoftwareUpdateScheduleForGroup_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentSoftwareUpdateScheduleForGroup' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/delete: + get: + tags: + - agentSoftwareUpdateSchedules + summary: Remove (delete) the agent software update schedule for a group. + description: Remove (delete) the agent software update schedule for a group. + operationId: DeleteAgentSoftwareUpdateScheduleFromGroupdelete_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name to remove the schedule for. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - agentSoftwareUpdateSchedules + summary: Remove (delete) the agent software update schedule for a group. + description: Remove (delete) the agent software update schedule for a group. + operationId: DeleteAgentSoftwareUpdateScheduleFromGroupdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteAgentSoftwareUpdateScheduleFromGroup' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/update: + get: + tags: + - agentSoftwareUpdateSchedules + summary: Update the agent software update schedule for a group. + description: Update the agent software update schedule for a group. + operationId: UpdateAgentSoftwareUpdateScheduleForGroupupdate_Get + parameters: + - name: GroupName + in: query + description: Gets or sets the group name that the update scheduled applies to. + schema: + type: string + - name: AgentUpdateSchedule + in: query + description: Specifies the update schedule that is being requested for the group. + schema: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - agentSoftwareUpdateSchedules + summary: Update the agent software update schedule for a group. + description: Update the agent software update schedule for a group. + operationId: UpdateAgentSoftwareUpdateScheduleForGroupupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateAgentSoftwareUpdateScheduleForGroup' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/add: + get: + tags: + - agentSoftwareUpdateSchedules + summary: Add (set) an agent update schedule for a specific group. Only one schedule is permitted per group at the current time. + description: Add (set) an agent update schedule for a specific group. Only one schedule is permitted per group at the current time. + operationId: SetAgentSoftwareUpdateScheduleForGroupadd_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name to associate this schedule with. + schema: + type: string + - name: AgentUpdateSchedule + in: query + description: Defines the schedule + schema: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + security: + - Bearer: [ ] + post: + tags: + - agentSoftwareUpdateSchedules + summary: Add (set) an agent update schedule for a specific group. Only one schedule is permitted per group at the current time. + description: Add (set) an agent update schedule for a specific group. Only one schedule is permitted per group at the current time. + operationId: SetAgentSoftwareUpdateScheduleForGroupadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetAgentSoftwareUpdateScheduleForGroup' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems: + get: + tags: + - syncServiceConfigItems + summary: Retrieves a list of SyncService configuration items. + description: Retrieves a list of SyncService configuration items. + operationId: GetSyncServiceConfigItems_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response for retrieving SyncService configuration items + content: + application/json: + schema: + $ref: '#/components/schemas/GetSyncServiceConfigItemsResponse' + security: + - Bearer: [ ] + post: + tags: + - syncServiceConfigItems + summary: Retrieves a list of SyncService configuration items. + description: Retrieves a list of SyncService configuration items. + operationId: GetSyncServiceConfigItems_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetSyncServiceConfigItems' + x-bodyName: body + responses: + '200': + description: Response for retrieving SyncService configuration items + content: + application/json: + schema: + $ref: '#/components/schemas/GetSyncServiceConfigItemsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/add: + post: + tags: + - syncServiceConfigItems + summary: Adds a new SyncService configuration item. + description: Adds a new SyncService configuration item. + operationId: AddSyncServiceConfigItemadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddSyncServiceConfigItem' + x-bodyName: body + responses: + '200': + description: Response for adding a SyncService configuration item + content: + application/json: + schema: + $ref: '#/components/schemas/AddSyncServiceConfigItemResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/update: + post: + tags: + - syncServiceConfigItems + summary: Updates an existing SyncService configuration item. + description: Updates an existing SyncService configuration item. + operationId: UpdateSyncServiceConfigItemupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateSyncServiceConfigItem' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/delete: + post: + tags: + - syncServiceConfigItems + summary: Deletes a SyncService configuration item. + description: Deletes a SyncService configuration item. + operationId: DeleteSyncServiceConfigItemdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteSyncServiceConfigItem' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /configItems: + get: + tags: + - configItems + summary: Retrieves a list of hub configuration parameters. + description: Retrieves a list of hub configuration parameters. + operationId: GetConfigItems_Get + parameters: + - name: Id + in: query + description: Specifies a specific configuration item to retrieve (Optional). + schema: + type: string + - name: Key + in: query + description: Specifies a specific configuration parameter 'Key' to retrieved (Optional). + schema: + type: string + - name: KeyList + in: query + description: Specifies a list of specific configuration parameter 'Keys' to retrieved (Optional). + style: form + schema: + type: array + items: + type: string + - name: IncludeHidden + in: query + description: 'Include hidden, ''system'', parameters.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the hub configuration parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/GetConfigItemsResponse' + security: + - Bearer: [ ] + post: + tags: + - configItems + summary: Retrieves a list of hub configuration parameters. + description: Retrieves a list of hub configuration parameters. + operationId: GetConfigItems_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetConfigItems' + x-bodyName: body + responses: + '200': + description: Describes the hub configuration parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/GetConfigItemsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /configItems/add: + get: + tags: + - configItems + summary: Add a list of hub configuration parameters. + description: Add a list of hub configuration parameters. + operationId: AddConfigItemsadd_Get + parameters: + - name: ConfigItems + in: query + description: A list of config items to add in bulk + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/NewId' + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - configItems + summary: Add a list of hub configuration parameters. + description: Add a list of hub configuration parameters. + operationId: AddConfigItemsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddConfigItems' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/NewId' + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /configItems/update: + get: + tags: + - configItems + summary: Update a a list of hub configuration parameters. + description: Update a a list of hub configuration parameters. + operationId: UpdateConfigItemsupdate_Get + parameters: + - name: ConfigItems + in: query + description: A list of config items to update. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/UpdateConfigItem' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - configItems + summary: Update a a list of hub configuration parameters. + description: Update a a list of hub configuration parameters. + operationId: UpdateConfigItemsupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateConfigItems' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /configItems/delete: + get: + tags: + - configItems + summary: Remove a hub configuration parameter by either ID or Key. + description: Remove a hub configuration parameter by either ID or Key. + operationId: DeleteConfigItemdelete_Get + parameters: + - name: Id + in: query + description: Specifies the specific config item to remove. + schema: + type: string + - name: Key + in: query + description: 'Specifies the config item key to remove. Note : will remove all instances of config items with the same key.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - configItems + summary: Remove a hub configuration parameter by either ID or Key. + description: Remove a hub configuration parameter by either ID or Key. + operationId: DeleteConfigItemdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteConfigItem' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /configItem/update: + get: + tags: + - configItem + summary: Update a single hub configuration parameter by either ID or Key. + description: Update a single hub configuration parameter by either ID or Key. + operationId: UpdateConfigItemupdate_Get + parameters: + - name: Id + in: query + description: The specific config value to update (can be used if a multi-value key is being updated or if a key is to be changed). + schema: + type: string + - name: Key + in: query + description: The new key value in the case of updating by Id or a the key to search for if updating by key. + schema: + type: string + - name: Value + in: query + description: The new value for this config key / id. + schema: + type: string + - name: Hidden + in: query + description: A boolean indicating whether or not to hide this config item from the UI. + schema: + type: boolean + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - configItem + summary: Update a single hub configuration parameter by either ID or Key. + description: Update a single hub configuration parameter by either ID or Key. + operationId: UpdateConfigItemupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateConfigItem' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /configItem/add: + get: + tags: + - configItem + summary: Add a hub configuration parameter by Key. + description: Add a hub configuration parameter by Key. + operationId: AddConfigItemadd_Get + parameters: + - name: Key + in: query + description: The configuration key you wish to add + schema: + type: string + - name: Value + in: query + description: The value of the key + schema: + type: string + - name: Hidden + in: query + description: A boolean indicating whether or not this is a 'hidden' key (i.e internal not intended for users to change) + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response delivered after adding a new config key / value. + content: + application/json: + schema: + $ref: '#/components/schemas/AddConfigItemResponse' + security: + - Bearer: [ ] + post: + tags: + - configItem + summary: Add a hub configuration parameter by Key. + description: Add a hub configuration parameter by Key. + operationId: AddConfigItemadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddConfigItem' + x-bodyName: body + responses: + '200': + description: The response delivered after adding a new config key / value. + content: + application/json: + schema: + $ref: '#/components/schemas/AddConfigItemResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /misc/dateTransmissionTest: + get: + tags: + - misc + summary: Echos the specified date/time value to ensure that no serialization issues exist between hub and client. + description: Echos the specified date/time value to ensure that no serialization issues exist between hub and client. + operationId: DateTransmissionTestdateTransmissionTest_Get + parameters: + - name: DateTime + in: query + description: The date to send to the hub that will be then sent back as the response to ensure no loss of accuracy occurs + schema: + type: string + format: date-time + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: string + format: date-time + security: + - Bearer: [ ] + post: + tags: + - misc + summary: Echos the specified date/time value to ensure that no serialization issues exist between hub and client. + description: Echos the specified date/time value to ensure that no serialization issues exist between hub and client. + operationId: DateTransmissionTestdateTransmissionTest_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DateTransmissionTest' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: string + format: date-time + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /credentials/add: + get: + tags: + - credentials + summary: Add credentials for specified type and key. + description: Add credentials for specified type and key. + operationId: AddCredentialsadd_Get + parameters: + - name: Credentials + in: query + description: Specifies the credentials. + schema: + $ref: '#/components/schemas/Credentials' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + post: + tags: + - credentials + summary: Add credentials for specified type and key. + description: Add credentials for specified type and key. + operationId: AddCredentialsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddCredentials' + x-bodyName: body + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /credentials/update: + get: + tags: + - credentials + summary: Update credentials for specified type and key. + description: Update credentials for specified type and key. + operationId: UpdateCredentialsupdate_Get + parameters: + - name: CredentialsType + in: query + description: Specifies the original credential type. + schema: + enum: + - Unknown + - Shell + - Database + - FTP + - Cloud + - ESX + - ITSM + - Splunk + type: string + x-nullable: false + - name: Key + in: query + description: Specifies the original key + schema: + type: string + - name: Credentials + in: query + description: Specifies the credentials. + schema: + $ref: '#/components/schemas/Credentials' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + post: + tags: + - credentials + summary: Update credentials for specified type and key. + description: Update credentials for specified type and key. + operationId: UpdateCredentialsupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateCredentials' + x-bodyName: body + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /credentials/delete: + get: + tags: + - credentials + summary: Remove credentials for specified type and key. + description: Remove credentials for specified type and key. + operationId: RemoveCredentialsdelete_Get + parameters: + - name: CredentialsType + in: query + description: Specifies the credentials type. + schema: + enum: + - Unknown + - Shell + - Database + - FTP + - Cloud + - ESX + - ITSM + - Splunk + type: string + x-nullable: false + - name: Key + in: query + description: Specifies the key. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - credentials + summary: Remove credentials for specified type and key. + description: Remove credentials for specified type and key. + operationId: RemoveCredentialsdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RemoveCredentials' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /credentialsKeyedByType: + get: + tags: + - credentialsKeyedByType + summary: 'Get a list of all the known credentials, keyed by the type.' + description: 'Get a list of all the known credentials, keyed by the type.' + operationId: GetCredentialsKeyedByType_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary>' + content: + application/json: + schema: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + security: + - Bearer: [ ] + post: + tags: + - credentialsKeyedByType + summary: 'Get a list of all the known credentials, keyed by the type.' + description: 'Get a list of all the known credentials, keyed by the type.' + operationId: GetCredentialsKeyedByType_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCredentialsKeyedByType' + x-bodyName: body + responses: + '200': + description: 'Dictionary>' + content: + application/json: + schema: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /credentials: + get: + tags: + - credentials + summary: Gets a list of all credentials of the specified type. + description: Gets a list of all credentials of the specified type. + operationId: GetCredentialsList_Get + parameters: + - name: CredentialType + in: query + description: Specifies the type of credentials to return + schema: + enum: + - Unknown + - Shell + - Database + - FTP + - Cloud + - ESX + - ITSM + - Splunk + type: string + x-nullable: false + - name: DeviceFilter + in: query + description: Specifies the credentials to search for by associated agent id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + post: + tags: + - credentials + summary: Gets a list of all credentials of the specified type. + description: Gets a list of all credentials of the specified type. + operationId: GetCredentialsList_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCredentialsList' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /command/tasks/status: + get: + tags: + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatus_Get + parameters: + - name: Ids + in: query + description: Specifies the task ids. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id. + schema: + type: integer + format: int32 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTaskStatuses + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTaskStatuses' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTaskStatuses + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/status/ids/{Ids}': + get: + tags: + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatusidsIds_Get + parameters: + - name: Ids + in: query + description: Specifies the task ids. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id. + schema: + type: integer + format: int32 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTaskStatuses + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatusidsIds_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTaskStatuses' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTaskStatuses + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/add/agent/{AgentId}': + get: + tags: + - command + summary: Adds a list of tasks for the given agent. + description: Adds a list of tasks for the given agent. + operationId: SubmitAgentTaskstasksaddagentAgentId_Get + parameters: + - name: Tasks + in: query + description: Specifies the list of tasks that will be submitted. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AgentTask' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for SubmitAgentTasks. + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Adds a list of tasks for the given agent. + description: Adds a list of tasks for the given agent. + operationId: SubmitAgentTaskstasksaddagentAgentId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for SubmitAgentTasks. + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/legacy/{LegacyId}': + get: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyId_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/{AgentId}/all/{AllTasks}': + get: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdallAllTasks_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdallAllTasks_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/{AgentId}/single/{TaskId}': + get: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdsingleTaskId_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdsingleTaskId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/legacy/{LegacyId}/all/{AllTasks}': + get: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdallAllTasks_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdallAllTasks_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/legacy/{LegacyId}/single/{TaskId}': + get: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdsingleTaskId_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdsingleTaskId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/downloadFileHash/{HostType}/{OperatingSystem}/{Variant}': + get: + tags: + - downloadFileHash + summary: Download the filehasing utility app for remote monitoring. + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_Get + parameters: + - name: ReturnUrl + in: query + description: Specifies a flag that indicates wether or not to return a URL or the file directly + schema: + type: boolean + x-nullable: false + - name: HostType + in: query + description: 'Specifies the host type the file hash binary is required for (e.g Unix, Windows etc)' + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + - name: OperatingSystem + in: query + description: Specifies the operating system naame (as defined in KnownOsNames). Optional + schema: + type: string + - name: Variant + in: query + description: 'Specifies the operating system / host variant. e.g x64, 10 SPARC etc' + schema: + type: string + - name: FileId + in: query + description: Specifies the specific file id + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - downloadFileHash + summary: Download the filehasing utility app for remote monitoring. + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DownloadFileHashBinary' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/downloadFileHashById/{FileId}': + get: + tags: + - downloadFileHashById + summary: Download the filehasing utility app for remote monitoring. + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryFileId_Get + parameters: + - name: ReturnUrl + in: query + description: Specifies a flag that indicates wether or not to return a URL or the file directly + schema: + type: boolean + x-nullable: false + - name: HostType + in: query + description: 'Specifies the host type the file hash binary is required for (e.g Unix, Windows etc)' + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + - name: OperatingSystem + in: query + description: Specifies the operating system naame (as defined in KnownOsNames). Optional + schema: + type: string + - name: Variant + in: query + description: 'Specifies the operating system / host variant. e.g x64, 10 SPARC etc' + schema: + type: string + - name: FileId + in: query + description: Specifies the specific file id + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - downloadFileHashById + summary: Download the filehasing utility app for remote monitoring. + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryFileId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DownloadFileHashBinary' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /getFileHashBinaries: + get: + tags: + - getFileHashBinaries + summary: Retrieves the list of file hash binaries available to download from the hub. + description: Retrieves the list of file hash binaries available to download from the hub. + operationId: GetFileHashBinaries_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/FileHashBinary' + security: + - Bearer: [ ] + post: + tags: + - getFileHashBinaries + summary: Retrieves the list of file hash binaries available to download from the hub. + description: Retrieves the list of file hash binaries available to download from the hub. + operationId: GetFileHashBinaries_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetFileHashBinaries' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/FileHashBinary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/members: + get: + tags: + - plannedChangeInstances + summary: Gets the group and device members of the specified planned change instance. + description: Gets the group and device members of the specified planned change instance. + operationId: GetPlannedChangeInstanceMembersmembers_Get + parameters: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Gets the group and device members of the specified planned change instance. + description: Gets the group and device members of the specified planned change instance. + operationId: GetPlannedChangeInstanceMembersmembers_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstanceMembers' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/delete: + get: + tags: + - plannedChangeInstances + summary: Deletes an instance of a planned change from the system. + description: Deletes an instance of a planned change from the system. + operationId: DeletePlannedChangeInstancedelete_Get + parameters: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: DeletePlannedChange + in: query + description: Delete the 'parent' planned change also? + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Deletes an instance of a planned change from the system. + description: Deletes an instance of a planned change from the system. + operationId: DeletePlannedChangeInstancedelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePlannedChangeInstance' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/deleteMember: + get: + tags: + - plannedChangeInstances + summary: Removes a group or device from a planned change + description: Removes a group or device from a planned change + operationId: DeletePlannedChangeInstanceMemberdeleteMember_Get + parameters: + - name: GroupName + in: query + description: Specifies the group to remove from the planned change. + schema: + type: string + - name: AgentDeviceId + in: query + description: Specifies individual device remove from the planned change. + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Removes a group or device from a planned change + description: Removes a group or device from a planned change + operationId: DeletePlannedChangeInstanceMemberdeleteMember_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePlannedChangeInstanceMember' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/add: + get: + tags: + - plannedChangeInstances + summary: Add a planned change instance. + description: Add a planned change instance. + operationId: AddPlannedChangeInstanceadd_Get + parameters: + - name: PlannedChangeName + in: query + description: 'Specifies the planned change definition name. Optional, if not supplied a new empty planned change ruleset is created and returned in the response.' + schema: + type: string + - name: DisplayName + in: query + description: Specifies the DisplayName. Required. + schema: + type: string + - name: Description + in: query + description: Specifies the description. Required. + schema: + type: string + - name: AssignedTo + in: query + description: Specifies the Assigned To Name. + schema: + type: string + - name: Origin + in: query + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when created by sync service.' + schema: + type: string + - name: MemberGroups + in: query + description: Specifies the groups that are members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the devices that are explicit members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: StartTimeUtc + in: query + description: Specifies the UTC start time of the instance. Optional. + schema: + type: string + format: date-time + - name: EndTimeUtc + in: query + description: Specifies the UTC end time of the instance. Optional. + schema: + type: string + format: date-time + - name: PeriodicityCount + in: query + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + x-nullable: false + - name: PeriodicityUnit + in: query + description: Specifies a value indicating the periodicity unit. + schema: + enum: + - None + - Second + - Minute + - Hour + - Day + - Week + type: string + x-nullable: false + - name: PeriodDurationCount + in: query + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + x-nullable: false + - name: PeriodDurationUnit + in: query + description: Specifies a value indicating the period duration unit. + schema: + enum: + - None + - Second + - Minute + - Hour + - Day + - Week + type: string + x-nullable: false + - name: Disabled + in: query + description: Specifies a value indicating whether to create the planned change instance in a disabled state. + schema: + type: boolean + x-nullable: false + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + schema: + type: boolean + x-nullable: false + - name: UseAttributeRules + in: query + description: 'TODO: How do we deal with this? TEMP used to trigger the new file hash based attribute rule generation. Eventually this will be the norm and this property can be removed.' + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Add a planned change instance. + description: Add a planned change instance. + operationId: AddPlannedChangeInstanceadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPlannedChangeInstance' + x-bodyName: body + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/update: + get: + tags: + - plannedChangeInstances + summary: Update a planned change instance + description: Update a planned change instance + operationId: UpdatePlannedChangeInstanceupdate_Get + parameters: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Description + in: query + description: Specifies the description. Optional. + schema: + type: string + - name: PlannedChangeName + in: query + description: Specifies the id (Name) of the ruleset used by this planned change. Optional. + schema: + type: string + - name: AssignedTo + in: query + description: Specifies the Assigned To Name. + schema: + type: string + - name: MemberGroups + in: query + description: Specifies the groups that are members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: StartTimeUtc + in: query + description: Specifies the UTC start time of the instance. Optional. + schema: + type: string + format: date-time + - name: EndTimeUtc + in: query + description: Specifies the UTC end time of the instance. Optional. + schema: + type: string + format: date-time + - name: Started + in: query + description: Specifies a value indicating whether the planned change has been started. Optional. + schema: + type: boolean + - name: Ended + in: query + description: Specifies a value indicating whether the planned change has been ended. Optional. + schema: + type: boolean + - name: Disabled + in: query + description: Specifies a value indicating whether the planned change instance is disabled. Optional. + schema: + type: boolean + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events. Optional.' + schema: + type: boolean + - name: PeriodicityCount + in: query + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + - name: PeriodicityUnit + in: query + description: Specifies a value indicating the periodicity unit. + schema: + type: string + - name: PeriodDurationCount + in: query + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + - name: PeriodDurationUnit + in: query + description: Specifies a value indicating the period duration unit. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the Display Name. + schema: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the devices that are explicit members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Update a planned change instance + description: Update a planned change instance + operationId: UpdatePlannedChangeInstanceupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdatePlannedChangeInstance' + x-bodyName: body + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/clone: + get: + tags: + - plannedChangeInstances + summary: Clone a planned change instance. + description: Clone a planned change instance. + operationId: ClonePlannedChangeInstanceclone_Get + parameters: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: CloneDefinition + in: query + description: Specifies the whether to clone the associated PlannedChangeDefinition + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Clone a planned change instance. + description: Clone a planned change instance. + operationId: ClonePlannedChangeInstanceclone_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ClonePlannedChangeInstance' + x-bodyName: body + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/nameValue: + get: + tags: + - plannedChangeInstances + summary: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + description: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + operationId: GetPlannedChangeInstancesNameValuenameValue_Get + parameters: + - name: InstanceIds + in: query + description: Specifies the instance id. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberGroups + in: query + description: Specifies the member groups to filter by. This is a list of groups that are members of the planned changes instances returned. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the ids of member devices. + style: form + schema: + type: array + items: + type: string + - name: Description + in: query + description: Specifies the planned change instance description to find. Optional. + schema: + type: string + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name to find instances of. Optional. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the planned change display name to find instances of. Optional. + schema: + type: string + - name: DisplayNameContains + in: query + description: Specifies the planned change instance name fragment to find. Optional. + schema: + type: string + - name: ExcludeDisabled + in: query + description: 'Specifies a value indicating whether to exclude disabled instances from the list. Optional, defaults to false.' + schema: + type: boolean + x-nullable: false + - name: ExcludeOutOfSchedule + in: query + description: 'Specifies a value indicating whether to exclude instances whose schedule is not currently active from the list. Optional, defaults to false.' + schema: + type: boolean + x-nullable: false + - name: DisallowRules + in: query + description: Specifies an optional value indicating whether the planned change instances returned are allowed to have rules. + schema: + type: boolean + - name: StartDateUtc + in: query + description: Gets or sets the Date/Time of the start date UTC of the Planned Changes to be returned. + schema: + type: string + format: date-time + - name: EndDateUtc + in: query + description: Gets or sets the Date/Time of the end date UTC of the Planned Changes to be returned. + schema: + type: string + format: date-time + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + description: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + operationId: GetPlannedChangeInstancesNameValuenameValue_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValue' + x-bodyName: body + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/addMembers: + get: + tags: + - plannedChangeInstances + summary: Add a list of groups to a planned change + description: Add a list of groups to a planned change + operationId: AddPlannedChangeInstanceMemberaddMembers_Get + parameters: + - name: MemberGroups + in: query + description: Specifies names of groups of devices to add to the planned change. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies individual device ids to add to the planned change. + style: form + schema: + type: array + items: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Add a list of groups to a planned change + description: Add a list of groups to a planned change + operationId: AddPlannedChangeInstanceMemberaddMembers_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPlannedChangeInstanceMember' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/addOrUpdateFromEvents: + get: + tags: + - plannedChangeInstances + summary: A request to add a new planned change and planned change instance based on the given events. + description: A request to add a new planned change and planned change instance based on the given events. + operationId: AddOrUpdatePlannedChangeInstanceFromEventsaddOrUpdateFromEvents_Get + parameters: + - name: AllEventsSelected + in: query + description: Indicates that the All Events option has been selected. + schema: + type: boolean + x-nullable: false + - name: EventsQuery + in: query + description: Specifies the events query criteria which is a requirement when AllEventsSelected is true. + schema: + $ref: '#/components/schemas/GetEvents' + - name: Name + in: query + description: Specifies the name of the 'PlannedChangeDefinition' to create. + schema: + type: string + - name: UpdateExisting + in: query + description: Specifies the flag indicating whether or not we're updating an existing planned change + schema: + type: boolean + x-nullable: false + - name: UseMinimumRules + in: query + description: Specifies a value indicating whether to use the minimum possible number rules to match the items. + schema: + type: boolean + x-nullable: false + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: MemberGroups + in: query + description: Specifies the groups that are members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the devices that are explicit members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: ReconsiderEventsFromUtc + in: query + description: Specifies the UTC time to reconsider matching events from. If null no events are reprocessed. + schema: + type: string + format: date-time + - name: RuleBuilderItems + in: query + description: Specifies the events that make up the initial filter rules of the new 'PlannedChangeInstance'. The matching 'PlannedChangeFilterRuleInferenceOptions' provide details about how the event filter rule is to be constructed. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/RuleBuilderItem' + - name: PreviewOnly + in: query + description: Specifies a value indicating whether to preview the settings for the resulting 'PlannedChangeInstance' or to really created it + schema: + type: boolean + x-nullable: false + - name: EndDateUtc + in: query + description: Specifies the UTC end date for the new PlannedChangeInstance. If this is null the PlannedChangeInstance is open-ended. + schema: + type: string + format: date-time + - name: Origin + in: query + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: A request to add a new planned change and planned change instance based on the given events. + description: A request to add a new planned change and planned change instance based on the given events. + operationId: AddOrUpdatePlannedChangeInstanceFromEventsaddOrUpdateFromEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEvents' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/reevaluateEvents: + get: + tags: + - plannedChangeInstances + summary: A request to re-evaluate the events associated with the specified planned change. + description: A request to re-evaluate the events associated with the specified planned change. + operationId: AddReEvaluationOfPlannedChangeInstanceEventsreevaluateEvents_Get + parameters: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: EarliestEventTimeUtc + in: query + description: Specifies the earliest UTC event time. This is the time of earliest events to re-consider for retrospective inclusion in the planned change. + schema: + type: string + format: date-time + - name: LastEventTimeUtc + in: query + description: Specifies the latest UTC event time. This is the time of the last events to re-consider for retrospective inclusion in the planned change. + schema: + type: string + format: date-time + - name: PlannedChangeManual + in: query + description: Indicates whether to further restrict the event query to events that were either added to the planned change manually or not (i.e. were added by a rule) + schema: + type: boolean + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: A request to re-evaluate the events associated with the specified planned change. + description: A request to re-evaluate the events associated with the specified planned change. + operationId: AddReEvaluationOfPlannedChangeInstanceEventsreevaluateEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddReEvaluationOfPlannedChangeInstanceEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances: + get: + tags: + - plannedChangeInstances + summary: 'Gets planned change instances, filtering by name, id or groups that are members.' + description: 'Gets planned change instances, filtering by name, id or groups that are members.' + operationId: GetPlannedChangeInstances_Get + parameters: + - name: InstanceIds + in: query + description: Specifies the instance id. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberGroups + in: query + description: Specifies the member groups to filter by. This is a list of groups that are members of the planned changes instances returned. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the ids of member devices. + style: form + schema: + type: array + items: + type: string + - name: Description + in: query + description: Specifies the planned change instance description to find. Optional. + schema: + type: string + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name to find instances of. Optional. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the planned change display name to find instances of. Optional. + schema: + type: string + - name: DisplayNameContains + in: query + description: Specifies the planned change instance name fragment to find. Optional. + schema: + type: string + - name: ExcludeDisabled + in: query + description: 'Specifies a value indicating whether to exclude disabled instances from the list. Optional, defaults to false.' + schema: + type: boolean + x-nullable: false + - name: ExcludeOutOfSchedule + in: query + description: 'Specifies a value indicating whether to exclude instances whose schedule is not currently active from the list. Optional, defaults to false.' + schema: + type: boolean + x-nullable: false + - name: DisallowRules + in: query + description: Specifies an optional value indicating whether the planned change instances returned are allowed to have rules. + schema: + type: boolean + - name: OmitPlannedChangeDefinitions + in: query + description: 'Specifies an optional value indicating whether to omit returning the PlannedChangeDefinition on the returned PlannedChangeInstance, useful if you only want a list of instances without the potentially large definitions embedded.' + schema: + type: boolean + x-nullable: false + - name: StartDateUtc + in: query + description: Gets or sets the Date/Time of the start date UTC of the Planned Changes to be returned. + schema: + type: string + format: date-time + - name: EndDateUtc + in: query + description: Gets or sets the Date/Time of the end date UTC of the Planned Changes to be returned. + schema: + type: string + format: date-time + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: 'Gets planned change instances, filtering by name, id or groups that are members.' + description: 'Gets planned change instances, filtering by name, id or groups that are members.' + operationId: GetPlannedChangeInstances_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstances' + x-bodyName: body + responses: + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/add: + get: + tags: + - plannedChanges + summary: Add a planned change definition. + description: Add a planned change definition. + operationId: AddPlannedChangeadd_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + - name: Name + in: query + description: Specifies the internally identifying name. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name. + schema: + type: string + - name: Description + in: query + description: Specifies the description text. + schema: + type: string + - name: Origin + in: query + description: 'Specifies the origin of the planned change ruleset. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + schema: + type: string + - name: CreationDateUtc + in: query + description: Specifies the UTC creation date of the planned change. + schema: + type: string + format: date-time + x-nullable: false + - name: LastModifiedDateUtc + in: query + description: Specifies the UTC last modified date of the planned change. + schema: + type: string + format: date-time + x-nullable: false + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + schema: + type: boolean + x-nullable: false + - name: Rules + in: query + description: Specifies the dictionary of 'PlannedChangeRule.Id' to 'PlannedChangeRule' rules. + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + - name: RuleCombinationOperator + in: query + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the'Rules'. + schema: + enum: + - And + - Or + - LogicExpression + type: string + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Add a planned change definition. + description: Add a planned change definition. + operationId: AddPlannedChangeadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPlannedChange' + x-bodyName: body + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/upload: + post: + tags: + - plannedChanges + summary: Upload a planned change ruleset json file + description: Upload a planned change ruleset json file + operationId: UploadPlannedChangeupload_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UploadPlannedChange' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/download: + get: + tags: + - plannedChanges + summary: Download a planned change ruleset json file + description: Download a planned change ruleset json file + operationId: DownloadPlannedChangedownload_Get + parameters: + - name: Id + in: query + description: Specifies the planned change rule set id + schema: + type: string + - name: IncludeAttributeRuleList + in: query + description: Specifies whether to return the List property for attribute list rules. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: IncludeAttributeRuleText + in: query + description: Specifies whether to return the list in the MatchText property for attribute list rules. Defaults to true. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Download a planned change ruleset json file + description: Download a planned change ruleset json file + operationId: DownloadPlannedChangedownload_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DownloadPlannedChange' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/update: + get: + tags: + - plannedChanges + summary: Update a planned change definition + description: Update a planned change definition + operationId: UpdatePlannedChangeupdate_Get + parameters: + - name: Name + in: query + description: Specifies the internal Name identifying the planned change. This cannot be updated. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name. + schema: + type: string + - name: Description + in: query + description: Specifies the description text. + schema: + type: string + - name: RuleCombinationOperator + in: query + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the 'PlannedChangeDefinition.Rules'. + schema: + type: string + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + schema: + type: boolean + - name: Rules + in: query + description: Specifies the dictionary of 'PlannedChangeRule.Id' to 'PlannedChangeRule' rules. + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + - name: Origin + in: query + description: 'Specifies the origin of the planned change update. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when updated by sync service.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Update a planned change definition + description: Update a planned change definition + operationId: UpdatePlannedChangeupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdatePlannedChange' + x-bodyName: body + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/clone: + get: + tags: + - plannedChanges + summary: Clone a planned change definition. + description: Clone a planned change definition. + operationId: ClonePlannedChangeclone_Get + parameters: + - name: Name + in: query + description: Specifies the internal Name identifying the planned change to clone. This cannot be updated. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Clone a planned change definition. + description: Clone a planned change definition. + operationId: ClonePlannedChangeclone_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ClonePlannedChange' + x-bodyName: body + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/analyze: + get: + tags: + - plannedChanges + summary: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + description: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + operationId: AnalyzePlannedChangeanalyze_Get + parameters: + - name: Name + in: query + description: Specifies the planned change Name. This cannot be updated. + schema: + type: string + - name: ReduceRuleIds + in: query + description: Specifies the list of rule ids to be automatically reduced to the minimum set to catch at least the same events. For example two exact name matches of files in the same directory will be reduced to one rule that matches any file in the directory. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyzePlannedChangeResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + description: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + operationId: AnalyzePlannedChangeanalyze_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AnalyzePlannedChange' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyzePlannedChangeResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/applyPlan: + get: + tags: + - plannedChanges + summary: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + description: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + operationId: ApplyPlannedChangePlanapplyPlan_Get + parameters: + - name: Name + in: query + description: Specifies the planned change Name. This cannot be updated. + schema: + type: string + - name: RuleIdsToRemove + in: query + description: Specifies the rule ids to remove. + style: form + schema: + type: array + items: + type: string + - name: RuleReductionPlan + in: query + description: Specifies the rule reduction plan. + schema: + $ref: '#/components/schemas/RuleReductionPlan2' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + description: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + operationId: ApplyPlannedChangePlanapplyPlan_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ApplyPlannedChangePlan' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/updateRule: + get: + tags: + - plannedChanges + summary: Updates a rule in a planned change + description: Updates a rule in a planned change + operationId: UpdatePlannedChangeRuleupdateRule_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Updates a rule in a planned change + description: Updates a rule in a planned change + operationId: UpdatePlannedChangeRuleupdateRule_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdatePlannedChangeRule' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/updateRules: + get: + tags: + - plannedChanges + summary: Updates the entire rule set in a planned change + description: Updates the entire rule set in a planned change + operationId: UpdatePlannedChangeRulesupdateRules_Get + parameters: + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name. + schema: + type: string + - name: Rules + in: query + description: Specifies the dictionary of 'PlannedChangeRule.Id' to 'PlannedChangeRule' rules. + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: A named Planned Change definition. + content: + application/json: + schema: + $ref: '#/components/schemas/PlannedChangeDefinition' + deprecated: true + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Updates the entire rule set in a planned change + description: Updates the entire rule set in a planned change + operationId: UpdatePlannedChangeRulesupdateRules_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdatePlannedChangeRules' + x-bodyName: body + responses: + '200': + description: A named Planned Change definition. + content: + application/json: + schema: + $ref: '#/components/schemas/PlannedChangeDefinition' + deprecated: true + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/deleteRule: + get: + tags: + - plannedChanges + summary: Removes a rule from a planned change + description: Removes a rule from a planned change + operationId: DeletePlannedChangeRuledeleteRule_Get + parameters: + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name. + schema: + type: string + - name: Id + in: query + description: Specifies the rule id. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Removes a rule from a planned change + description: Removes a rule from a planned change + operationId: DeletePlannedChangeRuledeleteRule_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePlannedChangeRule' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/delete: + get: + tags: + - plannedChanges + summary: Delete a planned change ruleset definition from the system. + description: Delete a planned change ruleset definition from the system. + operationId: DeletePlannedChangedelete_Get + parameters: + - name: Name + in: query + description: Specifies the planned change ruleset definition name to remove. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: Delete a planned change ruleset definition from the system. + description: Delete a planned change ruleset definition from the system. + operationId: DeletePlannedChangedelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePlannedChange' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeRule/add: + get: + tags: + - plannedChangeRule + summary: Add a rule to a planned change + description: Add a rule to a planned change + operationId: AddPlannedChangeRuleadd_Get + parameters: + - name: PlannedChangeName + in: query + description: Specifies the name of the planned change to which the new rule will be added. + schema: + type: string + - name: Rule + in: query + description: Specifies the new rule being added. + schema: + $ref: '#/components/schemas/PlannedChangeRule' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The id of the new item created. + content: + application/json: + schema: + $ref: '#/components/schemas/NewId' + security: + - Bearer: [ ] + post: + tags: + - plannedChangeRule + summary: Add a rule to a planned change + description: Add a rule to a planned change + operationId: AddPlannedChangeRuleadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPlannedChangeRule' + x-bodyName: body + responses: + '200': + description: The id of the new item created. + content: + application/json: + schema: + $ref: '#/components/schemas/NewId' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges: + get: + tags: + - plannedChanges + summary: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + description: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + operationId: GetPlannedChanges_Get + parameters: + - name: Name + in: query + description: Specifies the planned change definition name to find. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the planned change display name to find. + schema: + type: string + - name: DisplayNameContains + in: query + description: Specifies the partial planned change display name to find. + schema: + type: string + - name: DisallowRules + in: query + description: Specifies an optional value indicating whether the planned changes returned are allowed to have rules. + schema: + type: boolean + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + description: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + operationId: GetPlannedChanges_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPlannedChanges' + x-bodyName: body + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/parse: + get: + tags: + - commandParser + summary: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + description: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + operationId: ParseCommandsparse_Get + parameters: + - name: CommandLines + in: query + description: Specifies the command line + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ParseCommandResponse' + security: + - Bearer: [ ] + post: + tags: + - commandParser + summary: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + description: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + operationId: ParseCommandsparse_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ParseCommands' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ParseCommandResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist: + get: + tags: + - commandParser + summary: Gets the whitelisted command component. + description: Gets the whitelisted command component. + operationId: GetWhitelistedCommandComponentwhitelist_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/WhitelistCommandComponentResponse' + security: + - Bearer: [ ] + post: + tags: + - commandParser + summary: Attempts to whitelist the supplied command component. + description: Attempts to whitelist the supplied command component. + operationId: CreateWhitelistedCommandComponentwhitelist_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/CreateWhitelistedCommandComponent' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/WhitelistCommandComponentResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist/all: + get: + tags: + - commandParser + summary: Attempts to get all the whitelisted command components. + description: Attempts to get all the whitelisted command components. + operationId: GetAllWhitelistedCommandComponentswhitelistall_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/WhitelistCommandComponentResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist/update: + post: + tags: + - commandParser + summary: Attempts to update the supplied command component by id. + description: Attempts to update the supplied command component by id. + operationId: UpdateWhitelistedCommandComponentwhitelistupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateWhitelistedCommandComponent' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/WhitelistCommandComponentResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist/updateMany: + post: + tags: + - commandParser + summary: Attempts to bulk update the whitelisted command component with the supplied ids. + description: Attempts to bulk update the whitelisted command component with the supplied ids. + operationId: UpdateWhitelistedCommandComponentswhitelistupdateMany_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateWhitelistedCommandComponents' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/WhitelistCommandComponentResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponent/addTemplates: + post: + tags: + - commandParser + summary: Adds the given template(s) to a command component. + description: Adds the given template(s) to a command component. + operationId: AddTemplatesToCommandComponentcommandComponentaddTemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddTemplatesToCommandComponent' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CommandComponentTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponent/removeTemplates: + post: + tags: + - commandParser + summary: Attempts to remove the given template(s) from a command component. + description: Attempts to remove the given template(s) from a command component. + operationId: RemoveTemplatesFromCommandComponentcommandComponentremoveTemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RemoveTemplatesFromCommandComponent' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CommandComponentTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponent/templates: + get: + tags: + - commandParser + summary: Gets all templates of a command component. + description: Gets all templates of a command component. + operationId: GetAllCommandComponentTemplatescommandComponenttemplates_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllCommandComponentTemplatesResponse' + security: + - Bearer: [ ] + post: + tags: + - commandParser + summary: 'Attempts to set the given template(s) to a command component, clearing old templates if they exist.' + description: 'Attempts to set the given template(s) to a command component, clearing old templates if they exist.' + operationId: SetAllTemplatesOfCommandComponentcommandComponenttemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetAllTemplatesOfCommandComponent' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CommandComponentTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponentMany/templates: + post: + tags: + - commandParser + summary: Gets all templates of multiple command components. + description: Gets all templates of multiple command components. + operationId: GetAllCommandComponentsTemplatescommandComponentManytemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAllCommandComponentsTemplates' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllCommandComponentsTemplatesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /cloudTemplate/status: + get: + tags: + - cloudTemplate + summary: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. + description: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. + operationId: GetCloudTemplateCreationStatusstatus_Get + parameters: + - name: ProspectiveName + in: query + description: Specifies the prospective name of a Cloud System so that a check can be made to determine if any of the components already exist + schema: + type: string + - name: ReportSpecId + in: query + description: Specifies the id of the ReportSpecification representing this scheduled cloud report + schema: + type: string + - name: IncludeIfHidden + in: query + description: Whether or not the report associated with the ReportSpecification id will get found if it's in a hidden state + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' + security: + - Bearer: [ ] + post: + tags: + - cloudTemplate + summary: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. + description: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. + operationId: GetCloudTemplateCreationStatusstatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCloudTemplateCreationStatus' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/setup: + get: + tags: + - policyTemplate + summary: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + description: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + operationId: SetupPolicyTemplatesetup_Get + parameters: + - name: PolicyTemplateName + in: query + description: Specifies the policy template name + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SetupPolicyTemplateResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplate + summary: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + description: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + operationId: SetupPolicyTemplatesetup_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetupPolicyTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SetupPolicyTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/status: + get: + tags: + - policyTemplate + summary: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + description: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + operationId: GetPolicyTemplateCreationStatusstatus_Get + parameters: + - name: PolicyTemplateName + in: query + description: Specifies the policy template name to query + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplate + summary: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + description: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + operationId: GetPolicyTemplateCreationStatusstatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplateCreationStatus' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/add: + get: + tags: + - policyTemplate + summary: Adds a device config template. + description: Adds a device config template. + operationId: AddPolicyTemplateadd_Get + parameters: + - name: Template + in: query + description: Specifies the template. + schema: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + - name: UsageTags + in: query + description: 'Specifies the policy usages type to store on the Template e.g. Baseline, Tracking etc...' + style: form + schema: + type: array + items: + type: string + - name: ChangeComment + in: query + description: Specifies a short description of the change for auditing purposes. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplatesResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplate + summary: Adds a device config template. + description: Adds a device config template. + operationId: AddPolicyTemplateadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPolicyTemplate' + x-bodyName: body + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplatesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyRecent: + get: + tags: + - policyRecent + summary: Gets the most recent policy run results for each matching policy in the time range. + description: Gets the most recent policy run results for each matching policy in the time range. + operationId: GetMostRecentPolicyResults_Get + parameters: + - name: UsageTag + in: query + description: Restricts the results returned to compliance policies marked with the specified UsageTagsApplicable. + schema: + enum: + - All + - Database + - Linux + - Network + - OSX + - Unix + - Windows + - Baseline + - Compliance + - Tracking + - Hardening + - Cloud + type: string + x-nullable: false + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: ExcludePoliciesWithNoDevices + in: query + description: Restricts the results returned to policies run on groups containing at least one device. + schema: + type: boolean + x-nullable: false + - name: ExcludePoliciesNotSetup + in: query + description: Baselines only - excludes policies not yet fully setup from the results. + schema: + type: boolean + x-nullable: false + - name: ExcludePoliciesWithNoResults + in: query + description: Baselines only - excludes policies with no results in the time period from the results. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' + security: + - Bearer: [ ] + post: + tags: + - policyRecent + summary: Gets the most recent policy run results for each matching policy in the time range. + description: Gets the most recent policy run results for each matching policy in the time range. + operationId: GetMostRecentPolicyResults_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetMostRecentPolicyResults' + x-bodyName: body + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/add/rules: + get: + tags: + - policyTemplate + summary: Add a rules to a baseline policy based on events + description: Add a rules to a baseline policy based on events + operationId: AddPolicyTemplateRulesaddrules_Get + parameters: + - name: Name + in: query + description: Specifies the policy template name to add rules to + schema: + type: string + - name: AddDeviceInformationRule + in: query + description: Specifies whether to add the device information section at the start of the report + schema: + type: boolean + x-nullable: false + - name: ChangeComment + in: query + description: Specifies a short description of the change for auditing purposes. + schema: + type: string + - name: PreviewChanges + in: query + description: Specifies if the rule changes should only be previewed and not saved to the template. + schema: + type: boolean + x-nullable: false + - name: StartUtc + in: query + description: 'Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: RuleOptions + in: query + description: Specifies any Rule Builder Options. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/RuleBuilderOptions' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddPolicyTemplateRulesResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplate + summary: Add a rules to a baseline policy based on events + description: Add a rules to a baseline policy based on events + operationId: AddPolicyTemplateRulesaddrules_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPolicyTemplateRules' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddPolicyTemplateRulesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /devicePolicyTemplate/add: + get: + tags: + - devicePolicyTemplate + summary: Adds a device policy template to the system. The specified template should be supplied as Xml. + description: Adds a device policy template to the system. The specified template should be supplied as Xml. + operationId: AddPolicyTemplateXmladd_Get + parameters: + - name: Name + in: query + description: Specifies the name. + schema: + type: string + - name: Xml + in: query + description: Specifies the xml. + schema: + type: string + - name: PassMark + in: query + description: Specifies the pass mark. Only relevant for 'TemplateType' of 'PolicyTemplateType.ComplianceReport'. + schema: + type: number + format: double + x-nullable: false + - name: AsCopyOf + in: query + description: Specifies as a copy of an existing template named this + schema: + type: string + - name: CopyTemplateValues + in: query + description: 'Specifies a copy of an existing template should only copy the tracking information, not the values' + schema: + type: boolean + x-nullable: false + - name: AsCopyOfVersion + in: query + description: Specifies version to copy when using AsCopyOf + schema: + type: string + - name: AdditionalUsageTags + in: query + description: 'Specifies extra UsageTagsApplicable to record against the template, in addition to those specified in the Xml' + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: OverwriteIfExists + in: query + description: Specifies a flag to indicate whether or not not overwrite the report / config if it already exists + schema: + type: boolean + x-nullable: false + - name: ExternalDataFileId + in: query + description: Specifies an external file id if the XML is not provided 'in line' + schema: + type: string + - name: IsSystem + in: query + description: Specifies a flag to indicate whether or not the template is part of the standard system set or a customized version + schema: + type: boolean + x-nullable: false + - name: IsUiUpload + in: query + description: Specifies a flag to indicate whether or not the template is has been uploaded from the UI + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to adding a device policy template to the system. + content: + application/json: + schema: + $ref: '#/components/schemas/AddPolicyTemplateResponse' + security: + - Bearer: [ ] + post: + tags: + - devicePolicyTemplate + summary: Adds a device policy template to the system. The specified template should be supplied as Xml. + description: Adds a device policy template to the system. The specified template should be supplied as Xml. + operationId: AddPolicyTemplateXmladd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPolicyTemplateXml' + x-bodyName: body + responses: + '200': + description: Response to adding a device policy template to the system. + content: + application/json: + schema: + $ref: '#/components/schemas/AddPolicyTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /devicePolicyTemplate/delete: + get: + tags: + - devicePolicyTemplate + summary: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + description: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + operationId: DeletePolicyTemplatedelete_Get + parameters: + - name: Name + in: query + description: Specifies the policy template name to delete + schema: + type: string + - name: TemplateVersion + in: query + description: 'Specifies the policy template version to delete. Optional, if not supplied all versions of the template are removed.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - devicePolicyTemplate + summary: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + description: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + operationId: DeletePolicyTemplatedelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePolicyTemplate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /uploadPolicyTemplate: + post: + tags: + - uploadPolicyTemplate + summary: Upload a policy template file + description: Upload a policy template file + operationId: UploadPolicyTemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UploadPolicyTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UploadPolicyTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplateAsFile: + get: + tags: + - policyTemplateAsFile + summary: Returns a policy template as an xml file in the Http Response stream. + description: Returns a policy template as an xml file in the Http Response stream. + operationId: GetPolicyTemplateAsFile_Get + parameters: + - name: Name + in: query + description: Specifies the templatem name to retrieve. + schema: + type: string + - name: AgentDeviceId + in: query + description: Specifies the agent device id to get the current combined template for. Note either this or the 'Name' should be specified. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - policyTemplateAsFile + summary: Returns a policy template as an xml file in the Http Response stream. + description: Returns a policy template as an xml file in the Http Response stream. + operationId: GetPolicyTemplateAsFile_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplateAsFile' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentProcesses: + get: + tags: + - agentProcesses + summary: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + description: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + operationId: GetAgentProcesses_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent/device to get the processes from + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the list of running processes on a device. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentProcessesResponse' + security: + - Bearer: [ ] + post: + tags: + - agentProcesses + summary: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + description: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + operationId: GetAgentProcesses_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentProcesses' + x-bodyName: body + responses: + '200': + description: Describes the list of running processes on a device. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentProcessesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /startAgentTracker: + get: + tags: + - startAgentTracker + summary: Ask an agent to start a specified tracker. + description: Ask an agent to start a specified tracker. + operationId: StartAgentTracker_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent the tracker will be started on. Alternative to AgentDeviceId. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: AgentDeviceId + in: query + description: Specifies the agent id the tracker will be started on. Alternative to AgentDevice. + schema: + type: string + - name: TrackerName + in: query + description: Specifies the tracker to be started + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/StartAgentTrackerResponse' + security: + - Bearer: [ ] + post: + tags: + - startAgentTracker + summary: Ask an agent to start a specified tracker. + description: Ask an agent to start a specified tracker. + operationId: StartAgentTracker_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/StartAgentTracker' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/StartAgentTrackerResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentServices: + get: + tags: + - agentServices + summary: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + description: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + operationId: GetAgentServices_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent/device to get the Services from + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the list of running services on a device. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentServicesResponse' + security: + - Bearer: [ ] + post: + tags: + - agentServices + summary: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + description: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + operationId: GetAgentServices_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentServices' + x-bodyName: body + responses: + '200': + description: Describes the list of running services on a device. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentServicesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplates/activeVersion: + get: + tags: + - policyTemplates + summary: Sets a specific version of a named policy template as the active one. + description: Sets a specific version of a named policy template as the active one. + operationId: SetActivePolicyTemplateactiveVersion_Get + parameters: + - name: TemplateName + in: query + description: Specifies the template name. + schema: + type: string + - name: ActiveVersion + in: query + description: Specifies the version of the template to make active. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - policyTemplates + summary: Sets a specific version of a named policy template as the active one. + description: Sets a specific version of a named policy template as the active one. + operationId: SetActivePolicyTemplateactiveVersion_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetActivePolicyTemplate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplates/update: + get: + tags: + - policyTemplates + summary: Update matching config templates. + description: Update matching config templates. + operationId: UpdatePolicyTemplatesupdate_Get + parameters: + - name: Name + in: query + description: Specifies the name (id) to search for. + schema: + type: string + - name: NameContains + in: query + description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. + schema: + type: string + - name: ReturnXml + in: query + description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: ReturnSignatures + in: query + description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: IsActive + in: query + description: Get the Active version of a template + schema: + type: boolean + - name: IsLatest + in: query + description: Get the Latest version of a template + schema: + type: boolean + - name: HasRules + in: query + description: Get templates with Rules + schema: + type: boolean + - name: HasTrackers + in: query + description: Get templates with Trackers + schema: + type: boolean + - name: TemplateTrackerTypes + in: query + description: Specifies the template's tracker types. + style: form + schema: + type: array + items: + type: string + - name: TemplateVersion + in: query + description: Specifies the template version to get. + schema: + type: string + - name: UsageTags + in: query + description: Specifies the policy usage types to get. + style: form + schema: + type: array + items: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - policyTemplates + summary: Update matching config templates. + description: Update matching config templates. + operationId: UpdatePolicyTemplatesupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdatePolicyTemplates' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceConfigTemplate: + get: + tags: + - deviceConfigTemplate + summary: Gets a named device config template. + description: Gets a named device config template. + operationId: GetDeviceConfigTemplate_Get + parameters: + - name: Name + in: query + description: Specifies the template name. + schema: + type: string + - name: IncludeSystemFilters + in: query + description: Specifies a value indicating whether to include system defined filters and path match definitions. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents a named policy tracking configuration and rule-set template. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + security: + - Bearer: [ ] + post: + tags: + - deviceConfigTemplate + summary: Gets a named device config template. + description: Gets a named device config template. + operationId: GetDeviceConfigTemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceConfigTemplate' + x-bodyName: body + responses: + '200': + description: Represents a named policy tracking configuration and rule-set template. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceConfigTemplateNames: + get: + tags: + - deviceConfigTemplateNames + summary: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + description: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + operationId: GetDeviceConfigTemplateNames_Get + parameters: + - name: TrackersContained + in: query + description: Specifies the trackers contained. Optional. If specified this filters the returned list of template names to include only those containing the named trackers (eg 'processtracker'). + style: form + schema: + type: array + items: + type: string + - name: AgentDeviceIds + in: query + description: 'Specifies the agent devices. Optional. If specified this filters the returned list of template names to include only those currently applied to ALL the listed devices due to their group memberships, i.e. an intersection of group membership sets.' + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - deviceConfigTemplateNames + summary: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + description: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + operationId: GetDeviceConfigTemplateNames_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceConfigTemplateNames' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /addDeviceConfigProcessRules: + get: + tags: + - addDeviceConfigProcessRules + summary: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + description: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + operationId: AddDeviceConfigProcessRules_Get + parameters: + - name: DeviceTemplateName + in: query + description: The name of the device tracking configuration template + schema: + type: string + - name: Rules + in: query + description: A list of all the Rules + style: form + schema: + type: array + items: + $ref: '#/components/schemas/Process' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - addDeviceConfigProcessRules + summary: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + description: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + operationId: AddDeviceConfigProcessRules_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddDeviceConfigProcessRules' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupPolicy: + get: + tags: + - groupPolicy + summary: Get the configured config policy template for the specified group or by individual template name. + description: Get the configured config policy template for the specified group or by individual template name. + operationId: GetGroupPolicy_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name. Optional. + schema: + type: string + - name: GroupNames + in: query + description: Specifies the group names. Optional. + style: form + schema: + type: array + items: + type: string + - name: PolicyTemplateName + in: query + description: Specifies the policy template name. Optional. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to the request for configured policy templates on the group. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupPolicyResponse' + security: + - Bearer: [ ] + post: + tags: + - groupPolicy + summary: Get the configured config policy template for the specified group or by individual template name. + description: Get the configured config policy template for the specified group or by individual template name. + operationId: GetGroupPolicy_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroupPolicy' + x-bodyName: body + responses: + '200': + description: The response to the request for configured policy templates on the group. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupPolicyResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupPolicyNames: + get: + tags: + - groupPolicyNames + summary: Get the configured config policy template names for the specified groups. + description: Get the configured config policy template names for the specified groups. + operationId: GetGroupPolicyConfigNames_Get + parameters: + - name: GroupNames + in: query + description: Specifies the list of group names to get the config for + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary>' + content: + application/json: + schema: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + security: + - Bearer: [ ] + post: + tags: + - groupPolicyNames + summary: Get the configured config policy template names for the specified groups. + description: Get the configured config policy template names for the specified groups. + operationId: GetGroupPolicyConfigNames_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroupPolicyConfigNames' + x-bodyName: body + responses: + '200': + description: 'Dictionary>' + content: + application/json: + schema: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupPolicy/add: + get: + tags: + - groupPolicy + summary: Adds a config template to a group. + description: Adds a config template to a group. + operationId: AddGroupPolicyadd_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: GroupDisplayName + in: query + description: Specifies the group display name. + schema: + type: string + - name: PolicyTemplateName + in: query + description: Specifies the policy template name. + schema: + type: string + - name: PolicyTemplateDisplayName + in: query + description: Specifies the policy template display name. + schema: + type: string + - name: IsTrusted + in: query + description: Specifies if policy template contains trusted commands. + schema: + type: boolean + responses: + '200': + description: The response to the request to add a configured policy template to the group. + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupPolicyResponse' + security: + - Bearer: [ ] + post: + tags: + - groupPolicy + summary: Adds a config template to a group. + description: Adds a config template to a group. + operationId: AddGroupPolicyadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddGroupPolicy' + x-bodyName: body + responses: + '200': + description: The response to the request to add a configured policy template to the group. + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupPolicyResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupPolicy/delete: + get: + tags: + - groupPolicy + summary: Removes a config template from a group. + description: Removes a config template from a group. + operationId: DeleteGroupPolicydelete_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name to delete the policy from. + schema: + type: string + - name: PolicyTemplateName + in: query + description: Specifies the policy template name to remove from the group. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groupPolicy + summary: Removes a config template from a group. + description: Removes a config template from a group. + operationId: DeleteGroupPolicydelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteGroupPolicy' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reParentDevices: + get: + tags: + - reParentDevices + summary: Re-parents the given devices to the specified Agent. + description: Re-parents the given devices to the specified Agent. + operationId: ReParentDevices_Get + parameters: + - name: Devices + in: query + description: A list of agent device IDs to be re-parented. + style: form + schema: + type: array + items: + type: string + - name: AgentDeviceId + in: query + description: The agent device id to re-parent the devices to. + schema: + type: string + - name: MigrateEvents + in: query + description: A boolean that controls wether to migrate any 'old' events to the new agent device id combination. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - reParentDevices + summary: Re-parents the given devices to the specified Agent. + description: Re-parents the given devices to the specified Agent. + operationId: ReParentDevices_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ReParentDevices' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /exportAgents: + get: + tags: + - exportAgents + summary: Export a list of agent details. + description: Export a list of agent details. + operationId: ExportAgents_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the device filter used to control the list of agents + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: ExportFormat + in: query + description: Specifies the export format + schema: + enum: + - Default + - Excel + - PDF + - HTML + - CSV + - JSON + - CSVXlsx + type: string + x-nullable: false + - name: ReportTitle + in: query + description: Specifies the title for the report + schema: + type: string + - name: TimeZoneId + in: query + description: Specifies the timezone id to do the export in + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - exportAgents + summary: Export a list of agent details. + description: Export a list of agent details. + operationId: ExportAgents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExportAgents' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentsRanked: + get: + tags: + - agentsRanked + summary: A request to return agents matching the device filter. + description: A request to return agents matching the device filter. + operationId: GetAgentsRanked_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: GetAgentGroupDetails + in: query + description: Specifies a value indicating whether to get agent group details. + schema: + type: boolean + x-nullable: false + - name: GetRelatedCredentials + in: query + description: Specifies a value indicating whether to get related credentials. + schema: + type: boolean + x-nullable: false + - name: GetRelatedPlannedChanges + in: query + description: Specifies a value indicating whether to get related planned changes. + schema: + type: boolean + x-nullable: false + - name: GetRelatedTemplates + in: query + description: Specifies a value indicating whether to get templates applied to the returned agents. + schema: + type: boolean + x-nullable: false + - name: IncludeMasterInFilter + in: query + description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response objeect for GetAgentsRanked + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsRankedResponse' + security: + - Bearer: [ ] + post: + tags: + - agentsRanked + summary: A request to return agents matching the device filter. + description: A request to return agents matching the device filter. + operationId: GetAgentsRanked_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentsRanked' + x-bodyName: body + responses: + '200': + description: The response objeect for GetAgentsRanked + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsRankedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupMembers: + get: + tags: + - groupMembers + summary: A request to return group members matching the criteria. + description: A request to return group members matching the criteria. + operationId: GroupMembers_Get + parameters: + - name: GroupName + in: query + description: The name of the group to query. + schema: + type: string + - name: MemberType + in: query + description: Specifies the member type to return (AgentDevice or Group). + schema: + enum: + - None + - AgentDevice + - Group + type: string + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to group members request. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupMembersResponse' + security: + - Bearer: [ ] + post: + tags: + - groupMembers + summary: A request to return group members matching the criteria. + description: A request to return group members matching the criteria. + operationId: GroupMembers_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GroupMembers' + x-bodyName: body + responses: + '200': + description: The response to group members request. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupMembersResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groups: + get: + tags: + - groups + summary: A request to return groups matching the criteria. + description: A request to return groups matching the criteria. + operationId: GetGroups_Get + parameters: + - name: Name + in: query + description: The internal name of the group to find. + schema: + type: string + - name: DisplayName + in: query + description: The display name of the group to find. + schema: + type: string + - name: DisplayNameContains + in: query + description: A fragment of the display name in the groups to find. + schema: + type: string + - name: UserName + in: query + description: The alternative user name to retrieve groups for. Note that the returned list will also be filtered by the visibility of groups the authenticated user has. + schema: + type: string + - name: MemberOf + in: query + description: 'The groups of which the returned groups must be a member. If null, members of any group can be returned, if an empty list only groups which are members of no groups (i.e. have no parent) are returned.' + style: form + schema: + type: array + items: + type: string + - name: OnlyGroupsWithUpdate + in: query + description: Gets or sets the a flag indicating whether to only return groups with an agent update scheduled. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get groups request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsResponse' + security: + - Bearer: [ ] + post: + tags: + - groups + summary: A request to return groups matching the criteria. + description: A request to return groups matching the criteria. + operationId: GetGroups_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroups' + x-bodyName: body + responses: + '200': + description: The response to a get groups request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupsTree: + get: + tags: + - groupsTree + summary: Gets a tree structure representing the groups hierarchy. + description: Gets a tree structure representing the groups hierarchy. + operationId: GetGroupsTree_Get + responses: + '200': + description: A returned tree structure representing the groups hierarchy. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsTreeResponse' + security: + - Bearer: [ ] + post: + tags: + - groupsTree + summary: Gets a tree structure representing the groups hierarchy. + description: Gets a tree structure representing the groups hierarchy. + operationId: GetGroupsTree_Post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsTree' + x-bodyName: body + responses: + '200': + description: A returned tree structure representing the groups hierarchy. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsTreeResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groups/delete: + get: + tags: + - groups + summary: Represents a request to delete a group matching the criteria. + description: Represents a request to delete a group matching the criteria. + operationId: DeleteGroupdelete_Get + parameters: + - name: Name + in: query + description: Gets or sets the Group Matching Name. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groups + summary: Represents a request to delete a group matching the criteria. + description: Represents a request to delete a group matching the criteria. + operationId: DeleteGroupdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteGroup' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groups/add: + get: + tags: + - groups + summary: Adds a new Group definition. + description: Adds a new Group definition. + operationId: AddGroupadd_Get + parameters: + - name: ParentGroupName + in: query + description: Optionally specifies a parent group for the new group. If this is not supplied the group is automatically added as a child of the root 'All Devices' group unless NoParent is set + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name of the new group + schema: + type: string + - name: GroupType + in: query + description: Specifies the type of members allowed in the new group. Can be a combination of the allowed values + required: true + schema: + enum: + - None + - UserContainer + - DeviceContainer + - GroupContainer + type: int + x-nullable: false + - name: IsSystem + in: query + description: Specifies a flag indicating if this is a 'system' group or not + schema: + type: boolean + x-nullable: false + - name: Members + in: query + description: Specifies the list of ids of 'child group' members of the new group + style: form + schema: + type: array + items: + type: string + - name: RiskScore + in: query + description: Specifies the risk score of the group. + schema: + enum: + - Undefined + - Low + - MediumLow + - Medium + - MediumHigh + - High + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents a response to adding a new group + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupResponse' + security: + - Bearer: [ ] + post: + tags: + - groups + summary: Adds a new Group definition. + description: Adds a new Group definition. + operationId: AddGroupadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddGroup' + x-bodyName: body + responses: + '200': + description: Represents a response to adding a new group + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groups/update: + get: + tags: + - groups + summary: Updates a Group definition. + description: Updates a Group definition. + operationId: UpdateGroupupdate_Get + parameters: + - name: Name + in: query + description: Specifies the name of the group to update + required: true + schema: + type: string + - name: DisplayName + in: query + description: Specifies the new display name of the group + schema: + type: string + - name: Members + in: query + description: Specifies the list of 'child group' members + style: form + schema: + type: array + items: + type: string + - name: RiskScore + in: query + description: Specifies the risk score of the group + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groups + summary: Updates a Group definition. + description: Updates a Group definition. + operationId: UpdateGroupupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateGroup' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /devices/delete: + get: + tags: + - devices + summary: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + description: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + operationId: DeleteDevicesdelete_Get + parameters: + - name: AgentDeviceIds + in: query + description: 'The agent device ids to delete from their current groups, moving them to the Deleted group.' + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - devices + summary: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + description: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + operationId: DeleteDevicesdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteDevices' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /devices/overdue: + get: + tags: + - devices + summary: Gets devices that have not polled in for the specified amount of time. + description: Gets devices that have not polled in for the specified amount of time. + operationId: GetOverdueDevicesoverdue_Get + parameters: + - name: OfflineSeconds + in: query + description: Specifies the number of seconds the offline device must have been offline for. + required: true + schema: + type: integer + format: int32 + x-nullable: false + - name: MemberOfGroups + in: query + description: Specifies optional list of groups the devices must be a member of. + style: form + schema: + type: array + items: + type: string + - name: NotMemberOfGroups + in: query + description: Specifies optional list of groups the devices must not be a member of. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Lists devices that have not polled in for the specified amount of time. + content: + application/json: + schema: + $ref: '#/components/schemas/GetOverdueDevicesResponse' + security: + - Bearer: [ ] + post: + tags: + - devices + summary: Gets devices that have not polled in for the specified amount of time. + description: Gets devices that have not polled in for the specified amount of time. + operationId: GetOverdueDevicesoverdue_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetOverdueDevices' + x-bodyName: body + responses: + '200': + description: Lists devices that have not polled in for the specified amount of time. + content: + application/json: + schema: + $ref: '#/components/schemas/GetOverdueDevicesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /device/deletePermanently: + get: + tags: + - device + summary: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + description: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + operationId: DeleteDevicePermanentlydeletePermanently_Get + parameters: + - name: AgentId + in: query + description: Specifies the id of the agent. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. + schema: + type: string + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: Response + in: query + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + security: + - Bearer: [ ] + post: + tags: + - device + summary: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + description: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + operationId: DeleteDevicePermanentlydeletePermanently_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteDevicePermanently' + x-bodyName: body + responses: + '200': + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /device/reRegister: + get: + tags: + - device + summary: Represents a request to re-register a list of previously deleted devices matching the criteria. + description: Represents a request to re-register a list of previously deleted devices matching the criteria. + operationId: ReRegisterDevicereRegister_Get + parameters: + - name: AgentDeviceIds + in: query + description: Specifies the list of combined agent and device ids. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - device + summary: Represents a request to re-register a list of previously deleted devices matching the criteria. + description: Represents a request to re-register a list of previously deleted devices matching the criteria. + operationId: ReRegisterDevicereRegister_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ReRegisterDevice' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /group/deleteMembersPermanently: + get: + tags: + - group + summary: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + description: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + operationId: DeleteGroupMembersPermanentlydeleteMembersPermanently_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: Response + in: query + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + security: + - Bearer: [ ] + post: + tags: + - group + summary: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + description: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + operationId: DeleteGroupMembersPermanentlydeleteMembersPermanently_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteGroupMembersPermanently' + x-bodyName: body + responses: + '200': + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilter/add: + get: + tags: + - deviceFilter + summary: Represents a request to add a DeviceFilter. + description: Represents a request to add a DeviceFilter. + operationId: AddDeviceFilteradd_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the device filter to add. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceFilter + summary: Represents a request to add a DeviceFilter. + description: Represents a request to add a DeviceFilter. + operationId: AddDeviceFilteradd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddDeviceFilter' + x-bodyName: body + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilter/update: + get: + tags: + - deviceFilter + summary: Represents a request to update a DeviceFilter matching the given id. + description: Represents a request to update a DeviceFilter matching the given id. + operationId: UpdateDeviceFilterupdate_Get + parameters: + - name: Name + in: query + description: Specifies the name of the device filter to update. + schema: + type: string + - name: DeviceFilter + in: query + description: Specifies the new device filter. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceFilter + summary: Represents a request to update a DeviceFilter matching the given id. + description: Represents a request to update a DeviceFilter matching the given id. + operationId: UpdateDeviceFilterupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateDeviceFilter' + x-bodyName: body + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilter/promote: + get: + tags: + - deviceFilter + summary: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + description: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + operationId: PromoteDeviceFilterpromote_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the device filter. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceFilter + summary: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + description: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + operationId: PromoteDeviceFilterpromote_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PromoteDeviceFilter' + x-bodyName: body + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilter/delete: + get: + tags: + - deviceFilter + summary: Represents a request to delete a DeviceFilter matching the criteria. + description: Represents a request to delete a DeviceFilter matching the criteria. + operationId: DeleteDeviceFilterdelete_Get + parameters: + - name: Name + in: query + description: Specifies the name of the device filter to delete. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceFilter + summary: Represents a request to delete a DeviceFilter matching the criteria. + description: Represents a request to delete a DeviceFilter matching the criteria. + operationId: DeleteDeviceFilterdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteDeviceFilter' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilters: + get: + tags: + - deviceFilters + summary: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + description: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + operationId: GetDeviceFilters_Get + parameters: + - name: NameContains + in: query + description: Specifies text to search for in the filter Name + schema: + type: string + - name: Name + in: query + description: Specifies an exact filter Name to search for + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceFilters + summary: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + description: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + operationId: GetDeviceFilters_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceFilters' + x-bodyName: body + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupMembers/add: + get: + tags: + - groupMembers + summary: A request to add the specified Groups and Agents group members to the named group. + description: A request to add the specified Groups and Agents group members to the named group. + operationId: AddGroupMembersadd_Get + parameters: + - name: GroupName + in: query + description: The internal name/id of the group to add to. + schema: + type: string + - name: Groups + in: query + description: The names of groups to add to the parent. + style: form + schema: + type: array + items: + type: string + - name: Agents + in: query + description: The Agents to add to the parent. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/Agent' + - name: AgentDeviceIds + in: query + description: The AgentDeviceIds of agents to add to the parent. Used as an alternative to Agents property. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groupMembers + summary: A request to add the specified Groups and Agents group members to the named group. + description: A request to add the specified Groups and Agents group members to the named group. + operationId: AddGroupMembersadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddGroupMembers' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupMembers/delete: + get: + tags: + - groupMembers + summary: A request to remove group or device members from the named group. + description: A request to remove group or device members from the named group. + operationId: DeleteGroupMembersdelete_Get + parameters: + - name: GroupName + in: query + description: The name of the parent group to remove from. + schema: + type: string + - name: Groups + in: query + description: The names of groups to remove from the parent. + style: form + schema: + type: array + items: + type: string + - name: AgentDeviceIds + in: query + description: The agent device ids to remove from the parent. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groupMembers + summary: A request to remove group or device members from the named group. + description: A request to remove group or device members from the named group. + operationId: DeleteGroupMembersdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteGroupMembers' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceOnlineStatus: + get: + tags: + - deviceOnlineStatus + summary: Gets an indication of the device's online/offline status + description: Gets an indication of the device's online/offline status + operationId: GetDeviceOnlineStatus_Get + parameters: + - name: AgentId + in: query + description: Specifies the id of the agent. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: string + security: + - Bearer: [ ] + post: + tags: + - deviceOnlineStatus + summary: Gets an indication of the device's online/offline status + description: Gets an indication of the device's online/offline status + operationId: GetDeviceOnlineStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceOnlineStatus' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceSettings/update: + get: + tags: + - deviceSettings + summary: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + description: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + operationId: UpdateDeviceSettingsupdate_Get + parameters: + - name: AgentId + in: query + description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: FileLiveTrackingRequiresBaselineCompletion + in: query + description: Specifies whether a full baseline must be completed before live file tracking can be started. Optional + schema: + type: boolean + - name: GroupName + in: query + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceSettings' + security: + - Bearer: [ ] + post: + tags: + - deviceSettings + summary: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + description: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + operationId: UpdateDeviceSettingsupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateDeviceSettings' + x-bodyName: body + responses: + '200': + description: 'The device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceSettings' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceCredentials/add: + get: + tags: + - deviceCredentials + summary: A request to associate named credentials with an agent. + description: A request to associate named credentials with an agent. + operationId: AddCredentialsToAgentDeviceadd_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: CredentialsKey + in: query + description: Specifies the credentials key. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceCredentials + summary: A request to associate named credentials with an agent. + description: A request to associate named credentials with an agent. + operationId: AddCredentialsToAgentDeviceadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddCredentialsToAgentDevice' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceCredentials/delete: + get: + tags: + - deviceCredentials + summary: A request to remove named credentials from an agent. + description: A request to remove named credentials from an agent. + operationId: RemoveCredentialsFromAgentDevicedelete_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: CredentialKey + in: query + description: Specifies the credential key. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceCredentials + summary: A request to remove named credentials from an agent. + description: A request to remove named credentials from an agent. + operationId: RemoveCredentialsFromAgentDevicedelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RemoveCredentialsFromAgentDevice' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceName/update: + get: + tags: + - deviceName + summary: A request to update the display name of an agent. + description: A request to update the display name of an agent. + operationId: SetAgentDeviceNameupdate_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: DeviceName + in: query + description: Specifies the device name. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceName + summary: A request to update the display name of an agent. + description: A request to update the display name of an agent. + operationId: SetAgentDeviceNameupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetAgentDeviceName' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceHostType/update: + get: + tags: + - deviceHostType + summary: A request to update the host type of an agent. + description: A request to update the host type of an agent. + operationId: SetAgentHostTypeupdate_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: HostType + in: query + description: Specifies the device type. + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceHostType + summary: A request to update the host type of an agent. + description: A request to update the host type of an agent. + operationId: SetAgentHostTypeupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetAgentHostType' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testAgentCredentials: + get: + tags: + - testAgentCredentials + summary: Ask an agent to test the credentials for a device it is proxying. + description: Ask an agent to test the credentials for a device it is proxying. + operationId: TestAgentCredentials_Get + parameters: + - name: AgentDeviceId + in: query + description: Specifies the agent device id whose credentials are to be tested. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TestAgentCredentialsResponse' + security: + - Bearer: [ ] + post: + tags: + - testAgentCredentials + summary: Ask an agent to test the credentials for a device it is proxying. + description: Ask an agent to test the credentials for a device it is proxying. + operationId: TestAgentCredentials_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestAgentCredentials' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TestAgentCredentialsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /ipBlocking: + get: + tags: + - ipBlocking + summary: Gets details of ip addresses that have been blocked. + description: Gets details of ip addresses that have been blocked. + operationId: GetIpBlocking_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + post: + tags: + - ipBlocking + summary: Gets details of ip addresses that have been blocked. + description: Gets details of ip addresses that have been blocked. + operationId: GetIpBlocking_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetIpBlocking' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /ipBlocking/add: + get: + tags: + - ipBlocking + summary: Adds manual blocking of a specified ip address until a specified time. + description: Adds manual blocking of a specified ip address until a specified time. + operationId: AddIpBlockingadd_Get + parameters: + - name: IpAddress + in: query + description: Gets or sets the ip address. + schema: + type: string + - name: ExpiresUtc + in: query + description: Gets or sets the expiry date time in UTC. + schema: + type: string + format: date-time + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + post: + tags: + - ipBlocking + summary: Adds manual blocking of a specified ip address until a specified time. + description: Adds manual blocking of a specified ip address until a specified time. + operationId: AddIpBlockingadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddIpBlocking' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /ipBlocking/delete: + get: + tags: + - ipBlocking + summary: Removes blocking of a specified ip address. + description: Removes blocking of a specified ip address. + operationId: DeleteIpBlockingdelete_Get + parameters: + - name: IpAddress + in: query + description: Gets or sets the ip address to remove blocking from. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + post: + tags: + - ipBlocking + summary: Removes blocking of a specified ip address. + description: Removes blocking of a specified ip address. + operationId: DeleteIpBlockingdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteIpBlocking' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /discoverDevices: + get: + tags: + - discoverDevices + summary: Discovers devices to be added as proxied devices to a master device. + description: Discovers devices to be added as proxied devices to a master device. + operationId: DiscoverDevices_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoverDevicesResponse' + security: + - Bearer: [ ] + post: + tags: + - discoverDevices + summary: Discovers devices to be added as proxied devices to a master device. + description: Discovers devices to be added as proxied devices to a master device. + operationId: DiscoverDevices_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DiscoverDevices' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoverDevicesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /discoveredDevices: + get: + tags: + - discoveredDevices + summary: Submits discovered devices as a response to a DiscoverDevices request. + description: Submits discovered devices as a response to a DiscoverDevices request. + operationId: SubmitDiscoveredDevices_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - discoveredDevices + summary: Submits discovered devices as a response to a DiscoverDevices request. + description: Submits discovered devices as a response to a DiscoverDevices request. + operationId: SubmitDiscoveredDevices_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitDiscoveredDevices' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /acknowledgeEvents: + get: + tags: + - acknowledgeEvents + summary: Acknowledge a list of events as 'planned'. + description: Acknowledge a list of events as 'planned'. + operationId: AcknowledgeEvents_Get + parameters: + - name: EventIds + in: query + description: Specifies the event ids to update. + style: form + schema: + type: array + items: + type: string + - name: PlannedChangeId + in: query + description: Specifies the planned change instance id to acknowledge these events under. + schema: + type: string + - name: NewStatus + in: query + description: Specifies the new status for the alert events. + schema: + enum: + - Unknown + - NotRelevant + - Planned + - Unplanned + - UnderInvestigation + - Acknowledged + type: string + x-nullable: false + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: 'Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - acknowledgeEvents + summary: Acknowledge a list of events as 'planned'. + description: Acknowledge a list of events as 'planned'. + operationId: AcknowledgeEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AcknowledgeEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /resubmitEvents: + get: + tags: + - resubmitEvents + summary: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + description: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + operationId: ResubmitEvents_Get + parameters: + - name: GetEvents + in: query + description: Gets or sets the event IDs to re-submit + schema: + $ref: '#/components/schemas/GetEvents' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - resubmitEvents + summary: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + description: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + operationId: ResubmitEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResubmitEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/event/history/{EventId}': + get: + tags: + - event + summary: Get the event history for one specific event. + description: Get the event history for one specific event. + operationId: GetEventHistoryhistoryEventId_Get + parameters: + - name: EventId + in: query + description: Specifies the specific event id to retrieve history for. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes an event's history. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventHistoryResponse' + security: + - Bearer: [ ] + post: + tags: + - event + summary: Get the event history for one specific event. + description: Get the event history for one specific event. + operationId: GetEventHistoryhistoryEventId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEventHistory' + x-bodyName: body + responses: + '200': + description: Describes an event's history. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventHistoryResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /eventDeviceGroups: + get: + tags: + - eventDeviceGroups + summary: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + description: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + operationId: GetEventDeviceGroups_Get + parameters: + - name: EventIds + in: query + description: ' Gets or sets the event ids.' + style: form + schema: + type: array + items: + type: string + - name: Intersection + in: query + description: ' Gets or sets a value indicating whether the returned set of groups is the intersection of the event''s device memberships, if true, or the union. If intersection, only the groups of which all devices are a member are returned.' + schema: + type: boolean + x-nullable: false + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: 'Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: GroupFindMode + in: query + description: Gets or sets how the returned group list is built. + schema: + enum: + - GroupFindFromAgents + - GroupFindFromEvents + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents the list of groups that the devices associated with the given events are members of. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventDeviceGroupsResponse' + security: + - Bearer: [ ] + post: + tags: + - eventDeviceGroups + summary: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + description: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + operationId: GetEventDeviceGroups_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEventDeviceGroups' + x-bodyName: body + responses: + '200': + description: Represents the list of groups that the devices associated with the given events are members of. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventDeviceGroupsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /setCommentsForEvents: + get: + tags: + - setCommentsForEvents + summary: Set comments for events + description: Set comments for events + operationId: SetCommentForEvents_Get + parameters: + - name: GetEvents + in: query + description: Event filter to specify the events to set the comment for + schema: + $ref: '#/components/schemas/GetEvents' + - name: Comment + in: query + description: The comment + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - setCommentsForEvents + summary: Set comments for events + description: Set comments for events + operationId: SetCommentForEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetCommentForEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory: + get: + tags: + - inventory + summary: Retrieves a list of inventory items from the hub service. + description: Retrieves a list of inventory items from the hub service. + operationId: GetInventory_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetInventoryResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: Retrieves a list of inventory items from the hub service. + description: Retrieves a list of inventory items from the hub service. + operationId: GetInventory_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetInventory' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetInventoryResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentInventoryGrouped: + get: + tags: + - agentInventoryGrouped + summary: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + description: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + operationId: GetAgentInventoryItemsGrouped_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + security: + - Bearer: [ ] + post: + tags: + - agentInventoryGrouped + summary: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + description: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + operationId: GetAgentInventoryItemsGrouped_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentInventoryItemsGrouped' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentInventoryAgentsDetail: + get: + tags: + - agentInventoryAgentsDetail + summary: Retrieves a list of agents with a specific inventory item id from the hub service. + description: Retrieves a list of agents with a specific inventory item id from the hub service. + operationId: GetAgentInventoryAgentsDetail_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - agentInventoryAgentsDetail + summary: Retrieves a list of agents with a specific inventory item id from the hub service. + description: Retrieves a list of agents with a specific inventory item id from the hub service. + operationId: GetAgentInventoryAgentsDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentInventoryAgentsDetail' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/vulnerabilityOverview: + get: + tags: + - inventory + summary: A request to return the vulnerability overview matching the device filter. + description: A request to return the vulnerability overview matching the device filter. + operationId: GetVulnerabilityOverviewvulnerabilityOverview_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: StartDateUtc + in: query + description: Specifies the Utc start date from which the vulnerability changes are retrieved. + schema: + type: string + format: date-time + x-nullable: false + - name: ShowIgnored + in: query + description: Specifies whether to include excluded/suppressed Cves in the overview statistics. + schema: + type: boolean + x-nullable: false + - name: GetStatus + in: query + description: Get the vulnerability scanner status as well + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetVulnerabilityOverview + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityOverviewResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the vulnerability overview matching the device filter. + description: A request to return the vulnerability overview matching the device filter. + operationId: GetVulnerabilityOverviewvulnerabilityOverview_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerabilityOverview' + x-bodyName: body + responses: + '200': + description: The response object for GetVulnerabilityOverview + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityOverviewResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/vulnerabilities: + get: + tags: + - inventory + summary: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + description: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + operationId: GetVulnerabilityvulnerabilities_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + description: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + operationId: GetVulnerabilityvulnerabilities_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerability' + x-bodyName: body + responses: + '200': + description: The response object for GetVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/softwareVulnerability: + get: + tags: + - inventory + summary: A request to return the software vulnerability matching the device filter. + description: A request to return the software vulnerability matching the device filter. + operationId: GetSoftwareVulnerabilitysoftwareVulnerability_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: StartDateUtc + in: query + description: Specifies the Utc start date from which the vulnerability changes are retrieved. + schema: + type: string + format: date-time + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetSoftwareVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the software vulnerability matching the device filter. + description: A request to return the software vulnerability matching the device filter. + operationId: GetSoftwareVulnerabilitysoftwareVulnerability_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerability' + x-bodyName: body + responses: + '200': + description: The response object for GetSoftwareVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/update: + get: + tags: + - inventory + summary: Marks an inventory item a requiring an update / refresh. + description: Marks an inventory item a requiring an update / refresh. + operationId: MarkInventoryItemsRequiringUpdateupdate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: Marks an inventory item a requiring an update / refresh. + description: Marks an inventory item a requiring an update / refresh. + operationId: MarkInventoryItemsRequiringUpdateupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/MarkInventoryItemsRequiringUpdate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/softwareVulnerabilityDetail: + get: + tags: + - inventory + summary: A request to return the software vulnerability matching the device filter. + description: A request to return the software vulnerability matching the device filter. + operationId: GetSoftwareVulnerabilityDetailsoftwareVulnerabilityDetail_Get + parameters: + - name: SoftwareId + in: query + description: Specifies the software item to search for. + schema: + type: string + - name: CpeName + in: query + description: Specifies the CPE Name to search for. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetSoftwareVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the software vulnerability matching the device filter. + description: A request to return the software vulnerability matching the device filter. + operationId: GetSoftwareVulnerabilityDetailsoftwareVulnerabilityDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityDetail' + x-bodyName: body + responses: + '200': + description: The response object for GetSoftwareVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/deviceVulnerability: + get: + tags: + - inventory + summary: A request to return the device vulnerability matching the device filter. + description: A request to return the device vulnerability matching the device filter. + operationId: GetDeviceVulnerabilitydeviceVulnerability_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: StartDateUtc + in: query + description: Specifies the Utc start date from which the vulnerability changes are retrieved. + schema: + type: string + format: date-time + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetDeviceVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the device vulnerability matching the device filter. + description: A request to return the device vulnerability matching the device filter. + operationId: GetDeviceVulnerabilitydeviceVulnerability_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceVulnerability' + x-bodyName: body + responses: + '200': + description: The response object for GetDeviceVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/deviceVulnerabilityDetail: + get: + tags: + - inventory + summary: A request to return the device vulnerability matching the device filter. + description: A request to return the device vulnerability matching the device filter. + operationId: GetDeviceVulnerabilityDetaildeviceVulnerabilityDetail_Get + parameters: + - name: AgentDeviceId + in: query + description: Specifies the agents to search for by id or group membership. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetDeviceVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the device vulnerability matching the device filter. + description: A request to return the device vulnerability matching the device filter. + operationId: GetDeviceVulnerabilityDetaildeviceVulnerabilityDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityDetail' + x-bodyName: body + responses: + '200': + description: The response object for GetDeviceVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/relatedSoftwareVulnerabilityDetail: + get: + tags: + - inventory + summary: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + description: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + operationId: GetCvesForRelatedCpesrelatedSoftwareVulnerabilityDetail_Get + parameters: + - name: CpeName + in: query + schema: + type: string + - name: InventoryItemId + in: query + schema: + type: string + - name: MaxItemsToReturn + in: query + schema: + type: integer + format: int32 + x-nullable: false + - name: ReturnFullCveData + in: query + schema: + type: boolean + x-nullable: false + - name: VulnerabilityFilter + in: query + schema: + type: string + responses: + '200': + description: The response object for GetCvesForRelatedCpes + content: + application/json: + schema: + $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + description: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + operationId: GetCvesForRelatedCpesrelatedSoftwareVulnerabilityDetail_Post + parameters: + - name: CpeName + in: query + schema: + type: string + - name: InventoryItemId + in: query + schema: + type: string + - name: MaxItemsToReturn + in: query + schema: + type: integer + format: int32 + x-nullable: false + - name: ReturnFullCveData + in: query + schema: + type: boolean + x-nullable: false + - name: VulnerabilityFilter + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetCvesForRelatedCpes' + x-bodyName: body + responses: + '200': + description: The response object for GetCvesForRelatedCpes + content: + application/json: + schema: + $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/vulnerableDeviceDetail: + get: + tags: + - inventory + summary: A request to return the vulnerable devices matching the CVE. + description: A request to return the vulnerable devices matching the CVE. + operationId: GetVulnerableDeviceDetailvulnerableDeviceDetail_Get + parameters: + - name: CveId + in: query + description: Specifies the cve to search for vulnerable devices. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetDeviceVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerableDeviceDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the vulnerable devices matching the CVE. + description: A request to return the vulnerable devices matching the CVE. + operationId: GetVulnerableDeviceDetailvulnerableDeviceDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerableDeviceDetail' + x-bodyName: body + responses: + '200': + description: The response object for GetDeviceVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerableDeviceDetailResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/ignoreCves: + get: + tags: + - inventory + summary: A request to ignore one or more Cves until a given data. + description: A request to ignore one or more Cves until a given data. + operationId: IgnoreCveItemignoreCves_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to ignore one or more Cves until a given data. + description: A request to ignore one or more Cves until a given data. + operationId: IgnoreCveItemignoreCves_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/IgnoreCveItem' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /vulnerabilityscanstatus: + get: + tags: + - vulnerabilityscanstatus + summary: A request to return the software vulnerability scan status. + description: A request to return the software vulnerability scan status. + operationId: GetVulnerabilityScanStatus_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetVulnerabilityStatus + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityScanStatusResponse' + security: + - Bearer: [ ] + post: + tags: + - vulnerabilityscanstatus + summary: A request to return the software vulnerability scan status. + description: A request to return the software vulnerability scan status. + operationId: GetVulnerabilityScanStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerabilityScanStatus' + x-bodyName: body + responses: + '200': + description: The response object for GetVulnerabilityStatus + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityScanStatusResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /log4netConfigs/all: + get: + tags: + - log4netConfigs + summary: Retrieves a list of log4net logger configurations + description: Retrieves a list of log4net logger configurations + operationId: GetAllLog4NetConfigItemsall_Get + responses: + '200': + description: Response for getting log4net configuration items + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllLog4NetConfigItemsResponse' + security: + - Bearer: [ ] + post: + tags: + - log4netConfigs + summary: Retrieves a list of log4net logger configurations + description: Retrieves a list of log4net logger configurations + operationId: GetAllLog4NetConfigItemsall_Post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllLog4NetConfigItems' + x-bodyName: body + responses: + '200': + description: Response for getting log4net configuration items + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllLog4NetConfigItemsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /log4netConfigs/add: + post: + tags: + - log4netConfigs + operationId: AddLog4NetConfigItemadd_Post + parameters: + - name: LoggerName + in: query + schema: + type: string + - name: LogLevel + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddLog4NetConfigItem' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddLog4NetConfigItemResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /log4netConfigs/update: + post: + tags: + - log4netConfigs + operationId: UpdateLog4NetConfigItemupdate_Post + parameters: + - name: Id + in: query + schema: + type: string + - name: LoggerName + in: query + schema: + type: string + - name: LogLevel + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLog4NetConfigItem' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLog4NetConfigItemResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /log4netConfigs/delete: + post: + tags: + - log4netConfigs + operationId: DeleteLog4NetConfigItemdelete_Post + parameters: + - name: Id + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteLog4NetConfigItem' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteLog4NetConfigItemResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /log4netConfigs: + get: + tags: + - log4netConfigs + summary: Retrieves a list of log4net logger configurations with pagination support. + description: Retrieves a list of log4net logger configurations with pagination support. + operationId: GetLog4NetConfigItems_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response for getting log4net configuration items with pagination support + content: + application/json: + schema: + $ref: '#/components/schemas/GetLog4NetConfigItemsResponse' + security: + - Bearer: [ ] + post: + tags: + - log4netConfigs + summary: Retrieves a list of log4net logger configurations with pagination support. + description: Retrieves a list of log4net logger configurations with pagination support. + operationId: GetLog4NetConfigItems_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetLog4NetConfigItems' + x-bodyName: body + responses: + '200': + description: Response for getting log4net configuration items with pagination support + content: + application/json: + schema: + $ref: '#/components/schemas/GetLog4NetConfigItemsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reportDescription: + get: + tags: + - reportDescription + summary: Returns a description for the specified report. + description: Returns a description for the specified report. + operationId: GetReportDescription_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - reportDescription + summary: Returns a description for the specified report. + description: Returns a description for the specified report. + operationId: GetReportDescription_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportDescription' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reportDifferences: + get: + tags: + - reportDifferences + summary: Get a list of differences between two reports runs. + description: Get a list of differences between two reports runs. + operationId: GetReportChangeDetails_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/ReportChangeDetail' + security: + - Bearer: [ ] + post: + tags: + - reportDifferences + summary: Get a list of differences between two reports runs. + description: Get a list of differences between two reports runs. + operationId: GetReportChangeDetails_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportChangeDetails' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/ReportChangeDetail' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/reportData/{reportId}': + get: + tags: + - reportData + summary: 'Gets report results for the specified agent, device or task id.' + description: 'Gets report results for the specified agent, device or task id.' + operationId: GetReportDatareportId_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: A returned list of report results for displaying in a grid. + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportDataResponse' + security: + - Bearer: [ ] + post: + tags: + - reportData + summary: 'Gets report results for the specified agent, device or task id.' + description: 'Gets report results for the specified agent, device or task id.' + operationId: GetReportDatareportId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportData' + x-bodyName: body + responses: + '200': + description: A returned list of report results for displaying in a grid. + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /availableReports: + get: + tags: + - availableReports + summary: ' Gets a list of available reports for a specified group or agent.' + description: ' Gets a list of available reports for a specified group or agent.' + operationId: GetAvailableReports_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the devices for which to retrieve the available reports. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: StartDateUtc + in: query + description: Specifies a start date to search from. + schema: + type: string + format: date-time + - name: EndDateUtc + in: query + description: Specifies a start date to search up to. + schema: + type: string + format: date-time + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the available reports for the specified devices. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportsResponse' + security: + - Bearer: [ ] + post: + tags: + - availableReports + summary: ' Gets a list of available reports for a specified group or agent.' + description: ' Gets a list of available reports for a specified group or agent.' + operationId: GetAvailableReports_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAvailableReports' + x-bodyName: body + responses: + '200': + description: Describes the available reports for the specified devices. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userDashboard: + get: + tags: + - userDashboard + summary: Gets the user dashboard widget layout. + description: Gets the user dashboard widget layout. + operationId: GetUserDashboard_Get + parameters: + - name: Id + in: query + description: The identifier of the dashboard to get. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Details of a specific dashboard layout. + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardLayout' + security: + - Bearer: [ ] + post: + tags: + - userDashboard + summary: Gets the user dashboard widget layout. + description: Gets the user dashboard widget layout. + operationId: GetUserDashboard_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserDashboard' + x-bodyName: body + responses: + '200': + description: Details of a specific dashboard layout. + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardLayout' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userDashboard/named: + get: + tags: + - userDashboard + summary: Gets the user dashboard widget layout by name. + description: Gets the user dashboard widget layout by name. + operationId: GetUserDashboardByNamenamed_Get + parameters: + - name: Name + in: query + description: The name of the dashboard to get. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Details of a specific dashboard layout. + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardLayout' + security: + - Bearer: [ ] + post: + tags: + - userDashboard + summary: Gets the user dashboard widget layout by name. + description: Gets the user dashboard widget layout by name. + operationId: GetUserDashboardByNamenamed_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserDashboardByName' + x-bodyName: body + responses: + '200': + description: Details of a specific dashboard layout. + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardLayout' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userDashboard/save: + get: + tags: + - userDashboard + summary: Stores the user dashboard widget layout. + description: Stores the user dashboard widget layout. + operationId: SaveUserDashboardsave_Get + parameters: + - name: Id + in: query + description: 'The identifier of the dashboard to get. If not supplied a new record is created, else existing is updated.' + schema: + type: string + - name: Name + in: query + description: The name of the dashboard. + schema: + type: string + - name: Widgets + in: query + description: The widgets. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/DashboardWidgetSpec' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to the SaveUserDashboard request. + content: + application/json: + schema: + $ref: '#/components/schemas/SaveUserDashboardResponse' + security: + - Bearer: [ ] + post: + tags: + - userDashboard + summary: Stores the user dashboard widget layout. + description: Stores the user dashboard widget layout. + operationId: SaveUserDashboardsave_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SaveUserDashboard' + x-bodyName: body + responses: + '200': + description: Response to the SaveUserDashboard request. + content: + application/json: + schema: + $ref: '#/components/schemas/SaveUserDashboardResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userDashboard/delete: + get: + tags: + - userDashboard + summary: Deletes the user dashboard widget layout. + description: Deletes the user dashboard widget layout. + operationId: DeleteUserDashboarddelete_Get + parameters: + - name: Id + in: query + description: The identifier of the dashboard to delete. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - userDashboard + summary: Deletes the user dashboard widget layout. + description: Deletes the user dashboard widget layout. + operationId: DeleteUserDashboarddelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteUserDashboard' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userSettings: + get: + tags: + - userSettings + summary: Gets the user settings and selections. + description: Gets the user settings and selections. + operationId: GetUserSettings_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to the GetUserSettings request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserSettingsResponse' + security: + - Bearer: [ ] + post: + tags: + - userSettings + summary: Gets the user settings and selections. + description: Gets the user settings and selections. + operationId: GetUserSettings_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserSettings' + x-bodyName: body + responses: + '200': + description: Response to the GetUserSettings request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserSettingsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userSettings/save: + get: + tags: + - userSettings + summary: Stores the user settings and selections. + description: Stores the user settings and selections. + operationId: SaveUserSettingssave_Get + parameters: + - name: DashboardId + in: query + description: The user's default dashboard identifier. + schema: + type: string + - name: ThemeId + in: query + description: The user's default theme identifier. + schema: + type: string + - name: HideWelcomePopup + in: query + description: Indicates whether the user has opted to skip the welcome wizard. + schema: + type: boolean + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to the GetUserSettings request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserSettingsResponse' + security: + - Bearer: [ ] + post: + tags: + - userSettings + summary: Stores the user settings and selections. + description: Stores the user settings and selections. + operationId: SaveUserSettingssave_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SaveUserSettings' + x-bodyName: body + responses: + '200': + description: Response to the GetUserSettings request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserSettingsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /dashboard/widgetTemplates: + get: + tags: + - dashboard + summary: Gets the dashboard widgets. + description: Gets the dashboard widgets. + operationId: GetDashboardWidgetswidgetTemplates_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to the GetDashboardWidgets request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDashboardWidgetsResponse' + security: + - Bearer: [ ] + post: + tags: + - dashboard + summary: Gets the dashboard widgets. + description: Gets the dashboard widgets. + operationId: GetDashboardWidgetswidgetTemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDashboardWidgets' + x-bodyName: body + responses: + '200': + description: Response to the GetDashboardWidgets request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDashboardWidgetsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/stats/plannedChanges/hours/{PeriodHours}': + get: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChangeshoursPeriodHours_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChangeshoursPeriodHours_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChanges' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/stats/compliancedata/start/{Start}': + get: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedatastartStart_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedatastartStart_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/stats/compliancedata/end/{End}': + get: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedataendEnd_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedataendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/stats/compliancedata/start/{Start}/end/{End}': + get: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedatastartStartendEnd_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedatastartStartendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/events/invalidate: + get: + tags: + - stats + summary: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + description: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + operationId: InvalidateEventCountseventsinvalidate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + description: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + operationId: InvalidateEventCountseventsinvalidate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/InvalidateEventCounts' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testSmtpConnection: + get: + tags: + - testSmtpConnection + summary: Tests the specified SMTP details. + description: Tests the specified SMTP details. + operationId: TestSmtpConnection_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - testSmtpConnection + summary: Tests the specified SMTP details. + description: Tests the specified SMTP details. + operationId: TestSmtpConnection_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestSmtpConnection' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testFastConnection: + get: + tags: + - testFastConnection + summary: Tests the configured Fast service can be contacted. + description: Tests the configured Fast service can be contacted. + operationId: TestFastConnection_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - testFastConnection + summary: Tests the configured Fast service can be contacted. + description: Tests the configured Fast service can be contacted. + operationId: TestFastConnection_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestFastConnection' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testFastCustomerConnection: + get: + tags: + - testFastCustomerConnection + summary: Tests the configured Fast service can be contacted using customer credentials. + description: Tests the configured Fast service can be contacted using customer credentials. + operationId: TestFastCustomerConnection_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - testFastCustomerConnection + summary: Tests the configured Fast service can be contacted using customer credentials. + description: Tests the configured Fast service can be contacted using customer credentials. + operationId: TestFastCustomerConnection_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestFastCustomerConnection' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testSyslogConnection: + get: + tags: + - testSyslogConnection + summary: Tests the specified SysLog details. + description: Tests the specified SysLog details. + operationId: TestSyslogConnection_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - testSyslogConnection + summary: Tests the specified SysLog details. + description: Tests the specified SysLog details. + operationId: TestSyslogConnection_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestSyslogConnection' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testServiceNowConnection: + get: + tags: + - testServiceNowConnection + summary: Tests the specified ServiceNow details. + description: Tests the specified ServiceNow details. + operationId: TestServiceNowConnection_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - testServiceNowConnection + summary: Tests the specified ServiceNow details. + description: Tests the specified ServiceNow details. + operationId: TestServiceNowConnection_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestServiceNowConnection' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /testAuditorConnection: + get: + tags: + - testAuditorConnection + summary: Tests the specified Auditor details. + description: Tests the specified Auditor details. + operationId: TestAuditorConnection_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - testAuditorConnection + summary: Tests the specified Auditor details. + description: Tests the specified Auditor details. + operationId: TestAuditorConnection_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/TestAuditorConnection' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /pipelineNodes: + get: + tags: + - pipelineNodes + summary: Gets a list of pipeline node names. + description: Gets a list of pipeline node names. + operationId: GetPipelineNodeList_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - pipelineNodes + summary: Gets a list of pipeline node names. + description: Gets a list of pipeline node names. + operationId: GetPipelineNodeList_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPipelineNodeList' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/add/: + get: + tags: + - users + summary: Add a user. + description: Add a user. + operationId: AddUseradd_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + post: + tags: + - users + summary: Add a user. + description: Add a user. + operationId: AddUseradd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddUser' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/twoFactorStatus: + post: + tags: + - users + summary: Represents a pre-authentication request to query the user's Two-factor authentication status. Counts as a sign-in attempt. + description: Represents a pre-authentication request to query the user's Two-factor authentication status. Counts as a sign-in attempt. + operationId: GetUserTwoFactorStatustwoFactorStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserTwoFactorStatus' + x-bodyName: body + responses: + '200': + description: Response to the GetUserTwoFactorStatus request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserTwoFactorStatusResponse' + parameters: + - $ref: '#/components/parameters/Accept' + /users/elevateTwoFactorStatus: + post: + tags: + - users + summary: Represents a post-authentication request to elevate the user's Two-factor authentication status. Counts as a sign-in attempt. + description: Represents a post-authentication request to elevate the user's Two-factor authentication status. Counts as a sign-in attempt. + operationId: ElevateUserTwoFactorStatuselevateTwoFactorStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ElevateUserTwoFactorStatus' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/validatePassword/: + get: + tags: + - users + summary: Validates a user password. + description: Validates a user password. + operationId: ValidateUserPasswordvalidatePassword_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + post: + tags: + - users + summary: Validates a user password. + description: Validates a user password. + operationId: ValidateUserPasswordvalidatePassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ValidateUserPassword' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + parameters: + - $ref: '#/components/parameters/Accept' + /users/delete/: + get: + tags: + - users + summary: Delete a user. + description: Delete a user. + operationId: DeleteUserdelete_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - users + summary: Delete a user. + description: Delete a user. + operationId: DeleteUserdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteUser' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/users/{UserName}': + get: + tags: + - users + summary: Get a user's details. + description: Get a user's details. + operationId: GetUserUserName_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + post: + tags: + - users + summary: Get a user's details. + description: Get a user's details. + operationId: GetUserUserName_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUser' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/update/: + get: + tags: + - users + summary: Updates stored user details. Note that UserManage permissions are required to manage any user other than the caller. + description: Updates stored user details. Note that UserManage permissions are required to manage any user other than the caller. + operationId: UpdateUserupdate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - users + summary: Updates stored user details. Note that UserManage permissions are required to manage any user other than the caller. + description: Updates stored user details. Note that UserManage permissions are required to manage any user other than the caller. + operationId: UpdateUserupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateUser' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/updatePassword/: + get: + tags: + - users + summary: Updates stored user password. CurrentPassword property should contain the password of the user attempting to make the change. Note that UserManage permissions are required to manage any user password other than caller's. + description: Updates stored user password. CurrentPassword property should contain the password of the user attempting to make the change. Note that UserManage permissions are required to manage any user password other than caller's. + operationId: UpdateUserPasswordupdatePassword_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - users + summary: Updates stored user password. CurrentPassword property should contain the password of the user attempting to make the change. Note that UserManage permissions are required to manage any user password other than caller's. + description: Updates stored user password. CurrentPassword property should contain the password of the user attempting to make the change. Note that UserManage permissions are required to manage any user password other than caller's. + operationId: UpdateUserPasswordupdatePassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateUserPassword' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/reset/: + get: + tags: + - users + summary: Resets a user. Note that UserManage permissions are required to manage any user other than the caller. + description: Resets a user. Note that UserManage permissions are required to manage any user other than the caller. + operationId: ResetUserreset_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - users + summary: Resets a user. Note that UserManage permissions are required to manage any user other than the caller. + description: Resets a user. Note that UserManage permissions are required to manage any user other than the caller. + operationId: ResetUserreset_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResetUser' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/resetPassword/: + get: + tags: + - users + summary: Resets a user password. Note that this operation is intended to manage any user other than the caller. + description: Resets a user password. Note that this operation is intended to manage any user other than the caller. + operationId: ResetUserPasswordresetPassword_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResetUserPasswordResponse' + security: + - Bearer: [ ] + post: + tags: + - users + summary: Resets a user password. Note that this operation is intended to manage any user other than the caller. + description: Resets a user password. Note that this operation is intended to manage any user other than the caller. + operationId: ResetUserPasswordresetPassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResetUserPassword' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResetUserPasswordResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/previewResetPassword/: + post: + tags: + - users + summary: Generates a reset password for preview without applying it. Pass the returned PreviewToken to resetPassword to apply it. + description: Generates a reset password for preview without applying it. Pass the returned PreviewToken to resetPassword to apply it. + operationId: PreviewResetUserPasswordpreviewResetPassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PreviewResetUserPassword' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PreviewResetUserPasswordResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/reset2fa/: + get: + tags: + - users + summary: Resets a user's 2FA . Note that UserManage permissions are required to manage any user other than the caller. + description: Resets a user's 2FA . Note that UserManage permissions are required to manage any user other than the caller. + operationId: ResetUser2fareset2fa_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - users + summary: Resets a user's 2FA . Note that UserManage permissions are required to manage any user other than the caller. + description: Resets a user's 2FA . Note that UserManage permissions are required to manage any user other than the caller. + operationId: ResetUser2fareset2fa_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResetUser2fa' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /exportUserNotifications/: + get: + tags: + - exportUserNotifications + summary: Export users and the notifications they are configured to receive + description: Export users and the notifications they are configured to receive + operationId: ExportUserNotifications_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - exportUserNotifications + summary: Export users and the notifications they are configured to receive + description: Export users and the notifications they are configured to receive + operationId: ExportUserNotifications_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExportUserNotifications' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /timezones: + get: + tags: + - timezones + summary: Gets a list of possible time zone names. + description: Gets a list of possible time zone names. + operationId: GetTimeZoneIds_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/TimeZoneDetail' + security: + - Bearer: [ ] + post: + tags: + - timezones + summary: Gets a list of possible time zone names. + description: Gets a list of possible time zone names. + operationId: GetTimeZoneIds_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetTimeZoneIds' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/TimeZoneDetail' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userHasChangedPassword: + get: + tags: + - userHasChangedPassword + summary: Has the current user changed their password from any system assigned one? + description: Has the current user changed their password from any system assigned one? + operationId: UserHasChangedPassword_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - userHasChangedPassword + summary: Has the current user changed their password from any system assigned one? + description: Has the current user changed their password from any system assigned one? + operationId: UserHasChangedPassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserHasChangedPassword' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupAlerts/add: + get: + tags: + - groupAlerts + summary: Add a group alert to a user. + description: Add a group alert to a user. + operationId: AddGroupAlertToUseradd_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + post: + tags: + - groupAlerts + summary: Add a group alert to a user. + description: Add a group alert to a user. + operationId: AddGroupAlertToUseradd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddGroupAlertToUser' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupAlerts/delete: + get: + tags: + - groupAlerts + summary: Remove a group notification from a user + description: Remove a group notification from a user + operationId: DeleteGroupAlertFromUserdelete_Get + parameters: + - name: UserName + in: query + description: Specifies the user name to delete group alerts / notifications for. + schema: + type: string + - name: Id + in: query + description: Specifies the specific alert / notification to remove. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groupAlerts + summary: Remove a group notification from a user + description: Remove a group notification from a user + operationId: DeleteGroupAlertFromUserdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteGroupAlertFromUser' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupAlerts/update: + get: + tags: + - groupAlerts + summary: Update a group notification from a user + description: Update a group notification from a user + operationId: UpdateGroupAlertForUserupdate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - groupAlerts + summary: Update a group notification from a user + description: Update a group notification from a user + operationId: UpdateGroupAlertForUserupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateGroupAlertForUser' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupAlerts: + get: + tags: + - groupAlerts + summary: Get the configured notifications for the specified group. + description: Get the configured notifications for the specified group. + operationId: GetGroupAlertsForGroup_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAlert' + security: + - Bearer: [ ] + post: + tags: + - groupAlerts + summary: Get the configured notifications for the specified group. + description: Get the configured notifications for the specified group. + operationId: GetGroupAlertsForGroup_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroupAlertsForGroup' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAlert' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /users/: + get: + tags: + - users + summary: Get a list of user names. + description: Get a list of user names. + operationId: GetUserList_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + post: + tags: + - users + summary: Get a list of user names. + description: Get a list of user names. + operationId: GetUserList_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserList' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /resetAdminPassword: + get: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPassword_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + post: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResetAdminPassword' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + parameters: + - $ref: '#/components/parameters/Accept' + '/resetAdminPassword/{AdminName}': + get: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPasswordAdminName_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + post: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPasswordAdminName_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResetAdminPassword' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + parameters: + - $ref: '#/components/parameters/Accept' + '/resetAdminPassword/{OrganizationId}/{AdminName}': + get: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPasswordOrganizationIdAdminName_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + post: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPasswordOrganizationIdAdminName_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ResetAdminPassword' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles: + get: + tags: + - userRoles + summary: Get a list of user roles defined in the system. + description: Get a list of user roles defined in the system. + operationId: GetUserRoles_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserRolesResponse' + security: + - Bearer: [ ] + post: + tags: + - userRoles + summary: Get a list of user roles defined in the system. + description: Get a list of user roles defined in the system. + operationId: GetUserRoles_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserRoles' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserRolesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /permissions/: + get: + tags: + - permissions + summary: Gets a list of permissions names defined in the system. + description: Gets a list of permissions names defined in the system. + operationId: GetPermissions_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - permissions + summary: Gets a list of permissions names defined in the system. + description: Gets a list of permissions names defined in the system. + operationId: GetPermissions_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPermissions' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles/add: + get: + tags: + - userRoles + summary: Adds a custom user role + description: Adds a custom user role + operationId: AddUserRoleadd_Get + parameters: + - name: Name + in: query + description: Specifies the unique internal name for the role. If this is not supplied the DisplayName is used. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name for the role. + required: true + schema: + type: string + - name: ExternalName + in: query + description: Specifies the role name in an external identity provider that corresponds to this role. + schema: + type: string + - name: Permissions + in: query + description: Specifies the list of names of permissions associated with the role. + style: form + schema: + type: array + items: + type: string + - name: ReadOnly + in: query + description: 'Specifies whether the role is read only, or can be edited.' + required: true + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddUserRoleResponse' + security: + - Bearer: [ ] + post: + tags: + - userRoles + summary: Adds a custom user role + description: Adds a custom user role + operationId: AddUserRoleadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddUserRole' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AddUserRoleResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles/update: + get: + tags: + - userRoles + summary: Update a user role + description: Update a user role + operationId: UpdateUserRoleupdate_Get + parameters: + - name: Name + in: query + description: Specifies the unique internal name for the role. + required: true + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name for the role. + required: true + schema: + type: string + - name: ExternalName + in: query + description: Specifies the role name in an external identity provider that corresponds to this role. + schema: + type: string + - name: Permissions + in: query + description: Specifies the list of names of permissions associated with the role. + required: true + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUserRoleResponse' + security: + - Bearer: [ ] + post: + tags: + - userRoles + summary: Update a user role + description: Update a user role + operationId: UpdateUserRoleupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateUserRole' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUserRoleResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles/clone: + get: + tags: + - userRoles + summary: Clone an existing user role. + description: Clone an existing user role. + operationId: CloneUserRoleclone_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserRole' + security: + - Bearer: [ ] + post: + tags: + - userRoles + summary: Clone an existing user role. + description: Clone an existing user role. + operationId: CloneUserRoleclone_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/CloneUserRole' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserRole' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles/delete: + get: + tags: + - userRoles + summary: Delete a user role. + description: Delete a user role. + operationId: DeleteUserRoledelete_Get + parameters: + - name: Name + in: query + description: Specifies the internal name of the role to delete. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - userRoles + summary: Delete a user role. + description: Delete a user role. + operationId: DeleteUserRoledelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteUserRole' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /licenseInfo: + get: + tags: + - licenseInfo + summary: Represents a request to get an Organization's license info. + description: Represents a request to get an Organization's license info. + operationId: GetLicenseInfo_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a request to get an Organization's license info. + content: + application/json: + schema: + $ref: '#/components/schemas/GetLicenseInfoResponse' + security: + - Bearer: [ ] + post: + tags: + - licenseInfo + summary: Represents a request to get an Organization's license info. + description: Represents a request to get an Organization's license info. + operationId: GetLicenseInfo_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetLicenseInfo' + x-bodyName: body + responses: + '200': + description: The response to a request to get an Organization's license info. + content: + application/json: + schema: + $ref: '#/components/schemas/GetLicenseInfoResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /organization/update: + get: + tags: + - organization + summary: 'Represents a request to update an Organization, used to set the license.' + description: 'Represents a request to update an Organization, used to set the license.' + operationId: UpdateOrganizationupdate_Get + parameters: + - name: License + in: query + description: Specifies the license. + schema: + type: string + - name: AllowInvalidLicense + in: query + description: Specifies a value indicating whether to allow an invalid license in the License. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - organization + summary: 'Represents a request to update an Organization, used to set the license.' + description: 'Represents a request to update an Organization, used to set the license.' + operationId: UpdateOrganizationupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateOrganization' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRolesPermisions/check: + get: + tags: + - userRolesPermisions + summary: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + operationId: HasRoleOrPermissioncheck_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - userRolesPermisions + summary: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + operationId: HasRoleOrPermissioncheck_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/HasRoleOrPermission' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRolesPermissions/check: + get: + tags: + - userRolesPermissions + summary: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + operationId: HasRoleOrPermissioncheck2_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - userRolesPermissions + summary: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + operationId: HasRoleOrPermissioncheck2_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/HasRoleOrPermission' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRolesPermisions: + get: + tags: + - userRolesPermisions + summary: 'Gets roles and permissions for the caller, or the named user if supplied.' + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + operationId: GetRolesAndPermissions_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The roles and permissions for the user. + content: + application/json: + schema: + $ref: '#/components/schemas/GetRolesAndPermissionsResponse' + security: + - Bearer: [ ] + post: + tags: + - userRolesPermisions + summary: 'Gets roles and permissions for the caller, or the named user if supplied.' + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + operationId: GetRolesAndPermissions_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetRolesAndPermissions' + x-bodyName: body + responses: + '200': + description: The roles and permissions for the user. + content: + application/json: + schema: + $ref: '#/components/schemas/GetRolesAndPermissionsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRolesPermissions: + get: + tags: + - userRolesPermissions + summary: 'Gets roles and permissions for the caller, or the named user if supplied.' + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + operationId: GetRolesAndPermissions2_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The roles and permissions for the user. + content: + application/json: + schema: + $ref: '#/components/schemas/GetRolesAndPermissionsResponse' + security: + - Bearer: [ ] + post: + tags: + - userRolesPermissions + summary: 'Gets roles and permissions for the caller, or the named user if supplied.' + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + operationId: GetRolesAndPermissions2_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetRolesAndPermissions' + x-bodyName: body + responses: + '200': + description: The roles and permissions for the user. + content: + application/json: + schema: + $ref: '#/components/schemas/GetRolesAndPermissionsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/auth/{provider}': + get: + tags: + - auth + summary: Sign In + description: Sign In + operationId: Authenticateprovider_Get + parameters: + - name: provider + in: path + required: true + schema: + type: string + - name: UserName + in: query + schema: + type: string + - name: Password + in: query + schema: + type: string + - name: RememberMe + in: query + schema: + type: boolean + - name: AccessToken + in: query + schema: + type: string + - name: AccessTokenSecret + in: query + schema: + type: string + - name: ReturnUrl + in: query + schema: + type: string + - name: ErrorView + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateResponse' + post: + tags: + - auth + summary: Sign In + description: Sign In + operationId: Authenticateprovider_Post + parameters: + - name: provider + in: path + required: true + schema: + type: string + - name: UserName + in: query + schema: + type: string + - name: Password + in: query + schema: + type: string + - name: RememberMe + in: query + schema: + type: boolean + - name: AccessToken + in: query + schema: + type: string + - name: AccessTokenSecret + in: query + schema: + type: string + - name: ReturnUrl + in: query + schema: + type: string + - name: ErrorView + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Authenticate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateResponse' + parameters: + - $ref: '#/components/parameters/Accept' + /auth: + get: + tags: + - auth + summary: Sign In + description: Sign In + operationId: Authenticate_Get + parameters: + - name: provider + in: query + schema: + type: string + - name: UserName + in: query + schema: + type: string + - name: Password + in: query + schema: + type: string + - name: RememberMe + in: query + schema: + type: boolean + - name: AccessToken + in: query + schema: + type: string + - name: AccessTokenSecret + in: query + schema: + type: string + - name: ReturnUrl + in: query + schema: + type: string + - name: ErrorView + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateResponse' + post: + tags: + - auth + summary: Sign In + description: Sign In + operationId: Authenticate_Post + parameters: + - name: provider + in: query + schema: + type: string + - name: UserName + in: query + schema: + type: string + - name: Password + in: query + schema: + type: string + - name: RememberMe + in: query + schema: + type: boolean + - name: AccessToken + in: query + schema: + type: string + - name: AccessTokenSecret + in: query + schema: + type: string + - name: ReturnUrl + in: query + schema: + type: string + - name: ErrorView + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Authenticate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateResponse' + parameters: + - $ref: '#/components/parameters/Accept' + /access-token: + get: + tags: + - auth + operationId: GetAccessToken_Get + parameters: + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAccessTokenResponse' + put: + tags: + - auth + operationId: GetAccessToken_Create + parameters: + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetAccessToken' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAccessTokenResponse' + post: + tags: + - auth + operationId: GetAccessToken_Post + parameters: + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetAccessToken' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAccessTokenResponse' + delete: + tags: + - auth + operationId: GetAccessToken_Delete + parameters: + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAccessTokenResponse' + parameters: + - $ref: '#/components/parameters/Accept' +components: + schemas: + Object: + type: object + description: Object + GetAgentPoll: + title: GetAgentPoll + required: + - UniqueId + - AgentId + - PollTimeUtc + type: object + properties: + UniqueId: + type: string + description: Specifies the agent unique reference id. This is supplied in the return from the initial RegisterAgent call. + AgentId: + type: string + description: 'Specifies the agent id. Note: this the agent id excluding the device id: the poll returns tasks and configuration dates for all devices registered under this agent id.' + LegacyId: + type: string + description: 'The legacy v6.5 RA agent id. Note: this is only present for upgrade purposes.' + PollTimeUtc: + type: DateTime + description: Specifies the local agent Utc time. Used to detect system time differences between agent and hub. + format: date-time + x-nullable: false + AgentVersion: + type: string + description: Specifies the agent version. This is optional and typically only sent on initial poll. + AgentMacAddresses: + type: string + description: Specifies the agent physical/MAC addresses. This is optional and typically only sent on an initial poll or when the list changes. + AgentIPv4: + type: string + description: Specifies the agent IP v4 addresses. This is optional and typically only sent on initial poll or when the list changes. + AgentIPv6: + type: string + description: Specifies the agent IP v6 addresses. This is optional and typically only sent on initial poll or when the list changes. + MachineName: + type: string + description: 'Specifies the agent machine name including custom prefix, and domain prefix, if used. This is optional and typically only sent on initial poll or when the it changes.' + FullyQualifiedDomainName: + type: string + description: Specifies the fully qualified domain name. This is optional and typically only sent on initial poll or when the it changes. + AgentType: + type: string + description: Specifies the type of agent + Os: + type: string + description: Specifies the agent operating system. This is optional and typically only sent on initial poll or when the it changes. + DeviceIds: + type: array + items: + type: string + description: Specifies the deviceIds of the devices online that the agent is proxying. This is optional and typically only sent by a proxying agent. + ReturnXml: + type: boolean + description: Specifies whether to return the report task template xml in the response. This is optional and defaults to true. It can be used to prevent xml download on agents that implement a local cache of report definitions. + x-nullable: false + DeviceConfigIds: + $ref: '#/components/schemas/Dictionary_String_String_' + MainDeviceActivity: + $ref: '#/components/schemas/DeviceActivity' + ProxiedDeviceActivity: + type: array + items: + $ref: '#/components/schemas/DeviceActivity' + PublicKeyStringsInUse: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + Dictionary_String_String_: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + DeviceActivity: + title: DeviceActivity + type: object + properties: + AgentDeviceId: + type: string + LastUpdatedUtc: + type: string + format: date-time + x-nullable: false + ConfigDateUtc: + type: string + format: date-time + LoginName: + type: string + ProcessId: + type: integer + format: int32 + x-nullable: false + description: A representation of an agent's current status and activities. + GetAgentTasks: + title: GetAgentTasks + type: object + properties: + AgentId: + type: string + description: Specifies the agent's AgentId. + DeviceId: + type: string + description: Specifies the agent's DeviceId. + TaskStatuses: + type: array + items: + type: string + x-nullable: false + description: Specifies a value indicating the task statuses to filter by. + TaskIds: + type: array + items: + type: integer + format: int32 + x-nullable: false + description: Specifies value indicating the task ids to look for. + PolicyRunId: + type: integer + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + format: int32 + TaskType: + type: string + description: Specifies the specific task type to retrieve details for + Concise: + type: boolean + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + x-nullable: false + IgnoreActiveDates: + type: boolean + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + x-nullable: false + TaskTextMatchesOneOf: + type: array + items: + type: string + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Requests information about tasks for the given agent. + PagingQueryFilter: + title: PagingQueryFilter + type: object + properties: + Value: + type: string + description: Gets or sets the value. + Operator: + type: string + description: Gets or sets the operator. + Field: + type: string + description: Gets or sets the field. + IgnoreCase: + type: boolean + description: Gets or sets a value indicating whether to ignore case. + x-nullable: false + description: The paging query filter represents the column filtering options as sent from a Kendo Grid. + SubmitAgentTaskResultStream: + title: SubmitAgentTaskResultStream + required: + - AgentId + - DeviceId + - TaskId + type: object + properties: + RequestStream: + $ref: '#/components/schemas/Stream' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + TaskId: + type: integer + description: Specifies the id of the task. + format: int32 + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Used to submit agent task result data to the hub as a stream. + Stream: + title: Stream + type: object + description: Stream + SubmitAgentTaskResultData: + title: SubmitAgentTaskResultData + type: object + properties: + AgentId: + type: string + description: 'Specifies the agent id. This required for external api callers, but optional internally because the system may update / expire tasks without knowing the AgentId, but external api entry points should ensure it is set to prevent tampering with tasks not owned by the caller.' + DeviceId: + type: string + description: 'Specifies the device id. Note: this is optional as the system knows the device id from the task.' + TaskId: + type: integer + description: Specifies the task id that this data relates to. + format: int32 + x-nullable: false + DataValues: + type: array + items: + $ref: '#/components/schemas/VariableDataValue' + description: Specifies the result data items. + Status: + type: string + description: 'Specifies the status of the task. e.g complete, or error.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Adds report result data for the given agent report, called by the agent. This is the new format used by the Gen 7 agent.' + VariableDataValue: + title: VariableDataValue + type: object + properties: + Requirement: + $ref: '#/components/schemas/VariableDataRequirement' + ItemNameToAttributeValues: + $ref: '#/components/schemas/Dictionary_String_Dictionary_String_String__' + Error: + type: string + description: Specifies the text of any error encountered collecting attribute data for this item. + HasError: + type: boolean + description: Specifies a value indicating whether an error was encountered collecting attribute data for this item. + x-nullable: false + description: Represents the collected data for a VariableDataRequirement. + VariableDataRequirement: + title: VariableDataRequirement + type: object + properties: + TrackerName: + type: string + description: Specifies the tracker name. + ItemType: + type: string + description: Specifies the item type. + AttributeNames: + type: array + items: + type: string + description: Specifies a list of attribute names. + ItemNameSpecifier: + type: string + description: Specifies the item name. + Options: + type: string + description: Specifies the options. Contains regex details for processoutout command items. + VariableNames: + type: array + items: + type: string + description: Spcifies a list of variable names associated with this requirement. + MissingDataAllowed: + type: boolean + description: Specifies a value indicating whether any rule specifies that missing data is allowed when collecting data for this variable. + x-nullable: false + MaxListItems: + type: integer + description: Specifies a value indicating the maximum number of items to return in a variable when concatenated in a string. + format: int32 + x-nullable: false + ConvertSDDLToReadable: + type: boolean + description: Specifies a value indicating whether convert sddl values to readable SecurityPermissionSet entries. + x-nullable: false + MatchItemsUsing: + type: string + description: Specifies a value indicating how to match item names specified in ItemNameSpecifier. + description: Represents a specification for an item of data to be collected for input to a report rule. + Dictionary_String_Dictionary_String_String__: + title: 'Dictionary>' + type: object + additionalProperties: + $ref: '#/components/schemas/Dictionary_String_String_' + description: 'Dictionary>' + SubmitAgentTaskResult: + title: SubmitAgentTaskResult + required: + - AgentId + - DeviceId + - TaskId + type: object + properties: + AgentId: + type: string + description: Specifies the agent id. + DeviceId: + type: string + description: Specifies the device id. + TaskId: + type: integer + description: Specifies the task id. + format: int32 + x-nullable: false + ResultData: + type: string + description: Specifies the result data. If the task result is a single string it may be specified here. Otherwise specify it in ResultDataItems or RuleItemResults. + ResultDataItems: + type: array + items: + $ref: '#/components/schemas/AgentDataItem' + description: 'Specifies the result data items, when the task result is a list of data items (eg get processes).' + Status: + type: string + description: Specifies the task status. + StatusMessage: + type: string + description: 'Specifies the additional status message, if any.' + ReportResultSummary: + $ref: '#/components/schemas/ReportResultSummary' + RuleItemResults: + $ref: '#/components/schemas/Dictionary_String_List_RuleItemResult__' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Adds task result data for the given agent task, called by the agent.' + AgentDataItem: + title: AgentDataItem + type: object + properties: + Name: + type: string + description: Specifies the variable name. + ItemName: + type: string + description: Specifies the item name. + TrackerType: + type: string + description: Specifies the tracker type. + ItemType: + type: string + description: Specifies the item type. + Error: + type: string + description: Specifies any error encountered collecting data. + Attributes: + $ref: '#/components/schemas/Dictionary_String_String_' + description: An agent data item returned from a tracker. + ReportResultSummary: + title: ReportResultSummary + type: object + properties: + TotalScorePercent: + type: number + description: The total score as a percentage. + format: double + x-nullable: false + SummaryText: + type: string + description: The summary text for the report result. + description: The report result summary. + RuleItemResult: + title: RuleItemResult + type: object + properties: + Error: + type: string + description: Specifies the error. + ExpressionEvaluationTrace: + type: string + description: Specifies the explanation of the evaluation of the rule expression tree. + ExpressionResultExplanation: + type: string + description: Specifies the explanation of the result. + FailuresDescriptionExpanded: + type: string + description: Specifies the failures description with tokens and variable values expanded. + NotRelevant: + type: boolean + description: Specifies a value indicating whether the rule expression is not relevant to current OS. + x-nullable: false + PassesDescriptionExpanded: + type: string + description: Specifies the passes description with tokens and variable values expanded. + RuleFailureReason: + type: string + description: Specifies the rule failure reason. + RuleNumberName: + type: string + description: Specifies the rule number and name for reference. + Score: + type: number + description: Specifies the score. + format: double + x-nullable: false + ShowFailuresDescription: + type: boolean + description: Specifies a value indicating whether to show the failures description. + x-nullable: false + ShowPassesDescription: + type: boolean + description: Specifies a value indicating whether to show the passes description. + x-nullable: false + Variables: + type: array + items: + $ref: '#/components/schemas/VariableResult' + description: Specifies the variables. + description: A result for an individual report rule item. + VariableResult: + title: VariableResult + type: object + properties: + DataExtractionTrace: + type: string + description: Specifies the route taken to arrive at this variable value after any functions etc have been applied. + DataType: + type: string + description: Specifies the data type of the result. + Name: + type: string + description: Specifies the name of the variable for this result. + SourceData: + type: string + description: Specifies tjhe source data. + Values: + type: array + items: + type: string + description: Specifies the list of values for this variable. + description: The variable result used to send a representation of the data values used in a rule long with the results. + List_RuleItemResult_: + title: List + type: array + items: + $ref: '#/components/schemas/RuleItemResult' + Dictionary_String_List_RuleItemResult__: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RuleItemResult' + description: 'Dictionary>' + GetCredentials: + title: GetCredentials + type: object + properties: + CredentialsType: + type: string + description: Specifies the credentials type. + Key: + type: string + description: Specifies the key (name) of the required credentials. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get specific credentials for requested type and key (name). + GetPolicyTemplates: + title: GetPolicyTemplates + type: object + properties: + Name: + type: string + description: Specifies a single policy name (id) to search for. + NameContains: + type: string + description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. + Names: + type: array + items: + type: string + description: Specifies a list of policy names (ids) to search for. + ReturnXml: + type: boolean + description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. + x-nullable: false + ReturnSignatures: + type: boolean + description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. + x-nullable: false + IsActive: + type: boolean + description: Get the Active version of a template + IsLatest: + type: boolean + description: Get the Latest version of a template + IsSystem: + type: boolean + description: Get System supplied templates + HasRules: + type: boolean + description: Get templates with Rules + HasTrackers: + type: boolean + description: Get templates with Trackers + TemplateTrackerTypes: + type: array + items: + type: string + description: Specifies the template's tracker types. + TemplateVersion: + type: string + description: Specifies the template version to get. + UsageTags: + type: array + items: + type: string + description: Specifies the policy usage types to get. + IsTrusted: + type: boolean + description: Policy templates which contains commands that are trusted + NotificationRefId: + type: string + description: Policy templates associated with the supplied notification ref id + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets matching config templates. + GetPolicyTemplateVariables: + title: GetPolicyTemplateVariables + type: object + properties: + PolicyTemplateName: + type: string + description: Specifies the report template name. + ReturnConfigAsXml: + type: boolean + description: 'For any config that needs to be applied, return as XML.' + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to get a list of variable definitions from a named report to be collected by the agent. + GetCredentialsForAgentDevice: + title: GetCredentialsForAgentDevice + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to get the names of credentials associated with an agent. + AgentDevice: + title: AgentDevice + type: object + properties: + AgentId: + type: string + description: The agent id for this device. + DeviceId: + type: string + description: The device id for this device. + description: 'The agent device represents an agent device pairing. For example this may be a router that is reported on by an agent with, or it may be an agent reporting on the device it is installed on in which case AgentId and DeviceId will be the same.' + GetDbCredentialForDatabaseAgentDevice: + title: GetDbCredentialForDatabaseAgentDevice + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to get the database credentials associated with a database proxied agent. + GroupMemberships: + title: GroupMemberships + type: object + properties: + MemberName: + type: string + description: Specifies the member name to retrieve group memberships for. + MemberType: + type: string + description: Specifies the member type of the member specified by MemberName (AgentDevice or Group). + ExcludeInherited: + type: boolean + description: 'Specifies a value indicating whether to exclude inherited groups. This defaults to false meaning that all groups including those that are parents of thoseexplicitly set are returned, for example if Windows 7 group is a member of Windows group, and a device is explicitly a member of Windows 7the function will return ''Windows, Windows 7''. If ''ExcludeInherited'' is true, only ''Windows 7'' will be returned.' + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'A request to return groups this agent or group is a member of, including parents of parents etc.' + GetAgents: + title: GetAgents + type: object + properties: + ExcludeTotalCount: + type: boolean + description: Specifies a value indicating whether to calculate the total count returned in the GetAgentsResponse.Total + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + GetAgentGroupDetails: + type: boolean + description: Specifies a value indicating whether to get agent group details. + x-nullable: false + GetRelatedCredentials: + type: boolean + description: Specifies a value indicating whether to get related credentials. + x-nullable: false + GetRelatedPlannedChanges: + type: boolean + description: Specifies a value indicating whether to get related planned changes. + x-nullable: false + GetRelatedProxyAgents: + type: boolean + description: Specifies a value indicating whether to get related proxy agents. + x-nullable: false + GetRelatedTemplates: + type: boolean + description: Specifies a value indicating whether to get templates applied to the returned agents. + x-nullable: false + IncludeMasterInFilter: + type: boolean + description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return agents matching the device filter. + DeviceFilter: + title: DeviceFilter + type: object + properties: + LastModifiedDateUtc: + type: string + description: The last time this definition was edited (for stored filters). + format: date-time + Type: + type: string + description: 'Gets or sets the type, inferred from the presence and number of GroupNames and AgentDeviceIds' + GroupMatch: + type: string + description: Gets or sets the GroupMatchType controlling whether associated sought groups in GroupNames are matched as an exact list or a contains operation. + Name: + type: string + description: Gets or sets the filter name. + CanProxy: + type: boolean + description: Gets or sets a value indicating whether the agents sought can proxy connections to other devices. + ExcludeProxiedDevices: + type: boolean + description: Gets or sets a value indicating whether to exclude proxied devices from the result set. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + AgentDeviceIds: + type: array + items: + type: string + description: Gets or sets the agent ids. + AgentDisplayNames: + type: array + items: + type: string + description: Gets or sets the agent display names. + CredentialKeys: + type: array + items: + type: string + description: Gets or sets the credential keys. + Os: + type: string + description: ' Gets or sets the os to search for.' + DiscoveryId: + type: string + description: ' Gets or sets the discovery id to search for.' + DiscoveryTaskId: + type: string + description: ' Gets or sets the discovery task id to search for.' + ProxyAgentIds: + type: array + items: + type: string + description: 'Gets or sets the proxy agent ids. This is a list of the agent id parts only of the agentDeviceId pairs. Specifying this will return all devices which have these agent ids, i.e. are proxied by the given agents.' + TextSearch: + type: string + description: Gets or sets the text search when getting agents from the repository. By default this is a 'StartsWith' search unless TextSearchExactMatch + TextSearchExactMatch: + type: boolean + description: Gets or sets the a value indicating text search when getting agents from the repository + x-nullable: false + AllSelected: + type: boolean + description: 'Gets a value indicating whether all selected, i.e. no GroupNames or AgentDeviceIds have been specified.' + x-nullable: false + OnlineStatus: + type: string + description: Gets or sets the online status of the devices to return. Optional. + OnlineStatuses: + type: array + items: + type: string + x-nullable: false + description: Gets or sets the online statuses of the devices to return. Optional. + description: 'Represents a selected group of devices, by membership of groups, or by specific attributes (name, OS etc). This can be used on a GetEvents call but also on any api call that can be filtered by device, for example report results.' + RegisterAgent: + title: RegisterAgent + type: object + properties: + AgentName: + type: string + CanProxy: + type: boolean + description: Specifies a value indicating whether the agent can proxy connections to other devices. + x-nullable: false + CredentialKey: + type: string + description: Specifies the credential key. Only allowed for proxied devices. + DbConnection: + $ref: '#/components/schemas/DbConnection' + DeviceName: + type: string + description: Specifies the device name. + DeviceType: + type: string + GroupNames: + type: array + items: + type: string + description: Specifies the group names. Only allowed for proxied devices. + HostName: + type: string + description: Specifies the host name. This is the name or IP address used for agentless access to this device by a proxy. + HostType: + type: string + description: Specifies the host type. + MacAddresses: + type: string + description: Specifies the mac addresses. + IPv4: + type: string + description: Specifies the v4 ip address. + IPv6: + type: string + description: Specifies the v6 ip address. + LegacyHubId: + type: string + description: Specifies the legacy hub id. + DiscoveryId: + type: string + description: Specifies the internal discovery-based id. + DiscoveryTaskId: + type: string + description: Specifies the internal discovery task id. + OnlineDetection: + type: string + description: Specifies the method to use when detecting if a proxed device is online + Os: + type: string + description: Specifies the Operating System full description as reported by the device. + KnownOsName: + type: string + description: Specifies the Operating System from the list of known Os names. + OsUserSpecified: + type: string + description: 'Specifies the operating system as entered by the user. This will override the discovered Os in the UI, if specified.' + PollPeriodSeconds: + type: integer + description: Specifies the poll period in seconds. + format: int32 + ProxiedByAgentId: + type: string + description: Specifies the agent id of the proxy agent this device will be proxied by. + Registered: + type: boolean + description: Specifies a value indicating whether registered. + x-nullable: false + BaselineSendEnabled: + type: boolean + description: Specifies that the agent send baseline events flag should be set according to the value specified in the Agent property. + x-nullable: false + UniqueId: + type: string + description: 'Specifies a value uniquely identifying the agent independent of name or agent id from a previous registration. Used to detect a need to re-register when underlying hub store has been emptied, otherwise the autoincrementing agent id counter can result in clashes as already used ids are reissued to different agents.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Registers the details of an Agent with the system. + DbConnection: + title: DbConnection + type: object + properties: + ConnectionType: + type: string + description: Does the Proxied Agent's db connection rely on a legacy credential or new credential. + DatabasePlatform: + type: string + description: Specifies the database platform for the connection. + TrustedConnection: + type: boolean + description: Is the connection trusted in which case a credential is not required. + x-nullable: false + ConnectionString: + type: string + description: Specifies the connection string used for the database connection. + LegacyConnectionString: + type: string + description: Specifies a legacy connection string if this DbConnection originates from a legacy Db credential. + description: Represents database connection details. + UpdateAgent: + title: UpdateAgent + type: object + properties: + Agent: + $ref: '#/components/schemas/Agent' + CredentialKey: + type: string + description: Specifies the credential key to associate with this agent. e.g ssh credentials. + DbConnection: + $ref: '#/components/schemas/DbConnection' + GroupNames: + type: array + items: + type: string + description: Specifies a list of group names this agent belongs to. + UpdateAgentDeviceName: + type: boolean + description: Specifies that the agent device name should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateAgentHostType: + type: boolean + description: Specifies that the agent host type should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateCredentialKey: + type: boolean + description: Specifies that the agent credential key should be updated according to the value specified. + x-nullable: false + UpdateDbConnectionDetails: + type: boolean + description: Specifies that the agent database connection details should be updated according to the values specified. + x-nullable: false + UpdateDiagnosticModeEnabled: + type: boolean + description: Specifies that the agent diagnostic mode flag should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateEventBlockEnabled: + type: boolean + description: Specifies that the agent events blocked flag should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateGroupNames: + type: boolean + description: Specifies that the agent group names should be updated according to the value specified. + x-nullable: false + UpdateHostName: + type: boolean + description: Specifies that the agent host name should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateIPv4: + type: boolean + description: Specifies that the IPv4 should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateOnlineDetection: + type: boolean + description: Specifies that the agentonline detection mode should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateOsUserSpecified: + type: boolean + description: Specifies that the agent user specified os type should be updated according to the value specified in the Agent property. + x-nullable: false + UpdateBaselineSendEnabled: + type: boolean + description: Specifies that the agent send baseline events flag should be updated according to the value specified in the Agent property. + x-nullable: false + ClearUniqueId: + type: boolean + description: 'Specifies that the agent UniqueId should be cleared, allowing registration by another device of the same name, but different UniqueId.' + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update an Agent's details. + Agent: + title: Agent + type: object + properties: + ModelVersion: + type: integer + description: Gets the model version. + format: int32 + x-nullable: false + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + Version: + type: string + description: Specifies the agent version. + Name: + type: string + description: Specifies the device display name. + DeviceName: + type: string + description: Specifies the device name. + FullyQualifiedDomainName: + type: string + description: Specifies the fully qualified domain name. + DeviceType: + type: string + HostType: + type: string + description: 'Specifies the host type. This broadly indicates whether the device is windows or unix, or a DB or network device.' + Os: + type: string + description: Specifies the operating system as discovered by the agent. + OsUserSpecified: + type: string + description: 'Specifies the operating system as entered by the user. This will override the discovered Os in the UI, if specified.' + KnownOsName: + type: string + description: Specifes a known OS name from a system defined list. + OsVariant: + type: string + description: Specifies the os variant. This is one of the the system defined settings for the selected 'KnownOsName'. For example '64 bit version + Registered: + type: boolean + description: Specifies a value indicating whether the agent has connected yet to pick up its registration. + x-nullable: false + Deleted: + type: boolean + description: Specifies a value indicating whether the device has been deleted. + x-nullable: false + PollPeriodSeconds: + type: integer + description: Specifies the poll period in seconds. + format: int32 + x-nullable: false + LegacyId: + type: string + description: Specifies the legacy RA id for the agent. + DiscoveryId: + type: string + description: Specifies the internal discovery-based id. + DiscoveryTaskId: + type: string + description: Specifies the internal discovery task id. + DiscoveredName: + type: string + description: Specifies the name as originally assigned by device discovery. If the current DeviceName differs from this value the device has been manually renamed. + HostName: + type: string + description: Specifies the host name. This is the name or IP address used for agentless access to this device. + MacAddresses: + type: string + description: Specifies the physical/MAC addresses. + IPv4: + type: string + description: Specifies the IP v4 address. + IPv6: + type: string + description: Specifies the IP v6 address. + LastPollUtc: + type: string + description: Specifies the last time a poll was received from the agent. + format: date-time + x-nullable: false + NextPollUtc: + type: string + description: Specifies the expected next poll time. + format: date-time + x-nullable: false + MembershipChangeTimeUtc: + type: string + description: Specifies the last time group membership changed. + format: date-time + OnlineStatus: + type: string + description: Specifies the online status. + DiagnosticModeEnabled: + type: boolean + description: Specifies a value indicating whether or not diagnostic mode is enabled for this agent / device (i.e. extra logging). + x-nullable: false + EventBlockEnabled: + type: boolean + description: Specifies a value indicating whether the device is blocked from sending events. + x-nullable: false + BaselineSendEnabled: + type: boolean + description: Specifies a value indicating whether the device is enabled for sending baseline events. + x-nullable: false + OnlineDetection: + type: string + description: Specifies the method to use when detecting if a proxed device is online + PingTimeoutSeconds: + type: integer + description: 'Specifies the ''OnlineDetection'' ping timeout seconds, used with ''CredentialsService.Types.OnlineDetection.Ping''.' + format: int32 + x-nullable: false + TcpConnectPort: + type: integer + description: Specifies the port used for 'OnlineDetection' using 'CredentialsService.Types.OnlineDetection.TcpConnect'. + format: int32 + x-nullable: false + CanProxy: + type: boolean + description: Specifies a value indicating whether the agent can proxy connections to other devices. + x-nullable: false + DbConnection: + $ref: '#/components/schemas/DbConnection' + CredentialsTestStatus: + type: string + description: 'Specifies the status of the last credentials test, if any.' + CredentialsTestMessage: + type: string + description: Specifies the a success or failure message associated with the last credentials test. + UniqueId: + type: string + description: 'Specifies a value uniquely identifying the agent independent of name or agent id. Used to detect a need to re-register when underlying hub store has been emptied, otherwise the auto incrementing agent id counter can result in clashes as already used ids are reissued to different agents.' + IsTestAgent: + type: boolean + x-nullable: false + RecentActivity: + $ref: '#/components/schemas/DeviceActivity' + SkipConfigCheckUntilUtc: + type: string + format: date-time + x-nullable: false + AgentType: + type: string + IsBlockingRegistrationBy: + type: string + PublicKeyStringsInUse: + type: string + description: 'Represents a remote NNT Agent. May be a 1.x Agent, Gen7 Agent or Express Agent or a proxied device.' + SearchAgents: + title: SearchAgents + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + MatchText: + type: string + description: Text to search for in the Agents fields. + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to find agents matching the device filter and search criteria. + PreRegisterAgents: + title: PreRegisterAgents + type: object + properties: + Agents: + type: array + items: + $ref: '#/components/schemas/RegisterAgent' + description: A list of agents to pre-register at the hub. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Registers the details of the specified Agents with the system. + GetDeviceConfig: + title: GetDeviceConfig + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentDeviceId: + type: string + description: 'Specifies the combined agent and device id, for example 1,1.' + ReturnDocument: + type: boolean + description: Specifies a value indicating whether return to return a device template object in GetDeviceConfigResponse.DeviceTemplate if trueor an xml string in GetDeviceConfigResponse.Xml if false. + x-nullable: false + ReturnDocumentAsPolicyRuleSet: + type: boolean + description: Specifies a value indicating whether return to return a device template rule-set object in GetDeviceConfigResponse.DeviceTemplate if trueor an xml string in GetDeviceConfigResponse.Xml if false. + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + GetDeviceSettings: + title: GetDeviceSettings + type: object + properties: + AgentId: + type: string + description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. + DeviceId: + type: string + description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. + GroupName: + type: string + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + GetEvents: + title: GetEvents + type: object + properties: + Comment: + type: string + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + TimeZoneId: + type: string + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + EventFilter: + $ref: '#/components/schemas/EventFilter' + StartUtc: + type: string + description: ' Gets or sets the start of the period to return events for, null implies all.' + format: date-time + EndUtc: + type: string + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + format: date-time + StartOffsetSeconds: + type: integer + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + format: int32 + EndOffsetSeconds: + type: integer + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + format: int32 + Status: + type: string + description: Only get events of a certain status + TextSearch: + type: string + description: Gets or sets the text search value. + ReturnedEventType: + type: string + description: ' Gets or sets the returned event type.' + EventId: + type: string + description: Gets or sets the specific event id. + ExcludeTotalCount: + type: boolean + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + x-nullable: false + IncludeHistory: + type: boolean + description: Gets or sets a value indicating wether or not to return event history with the events. + x-nullable: false + RulesFromBaselinePolicyName: + type: string + description: Gets or sets a value indicating wether or not to return event history with the events. + ReturnAllEvents: + type: boolean + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + x-nullable: false + CountTimeMilliseconds: + type: number + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + format: double + FormatDiffs: + type: boolean + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of events from the hub service. + EventFilter: + title: EventFilter + type: object + properties: + Version: + type: integer + description: Gets the object version. + format: int32 + x-nullable: false + UseSuppliedEventTypes: + type: boolean + description: The query engine will attempt to derive the correct event types based on your other parameters. Set this to force it to use the EventTypes property value + x-nullable: false + EventIds: + type: array + items: + type: string + description: Gets or sets the event ids. + EventIdsToExclude: + type: array + items: + type: string + description: Gets or sets the event ids to exclude from the query + BaselineTypes: + type: array + items: + type: string + x-nullable: false + description: Gets or sets the baseline types + EventTypes: + type: array + items: + type: string + x-nullable: false + description: Gets or sets the event types. + AuditMessageTypes: + type: array + items: + type: string + x-nullable: false + description: Gets or sets the audit message types of AuditEvent + PlannedChangeStatuses: + type: array + items: + type: string + x-nullable: false + description: Gets or sets the planned change statuses. + PlannedChangeIds: + type: array + items: + type: string + description: Specifies the planned change instance ids. + ReportInstanceIds: + type: array + items: + type: string + description: Specifies the scheduled report instance ids. + ReportSpecIds: + type: array + items: + type: string + description: Specifies the report spec ids. + PlannedChangeManual: + type: boolean + description: Indicates whether to further restrict the event query to events that were either added to the planned change manually or not (i.e. were added by a rule). + TrackerTypeNames: + type: array + items: + type: string + description: Gets or sets the tracker type names. + ItemTypeNames: + type: array + items: + type: string + description: Gets or sets the item type names. + ItemValues: + type: array + items: + $ref: '#/components/schemas/TextMatch' + description: Gets or sets the item values. + AttributeTypeNames: + type: array + items: + type: string + description: ' Gets or sets the attribute type names.' + AttributeValues: + type: array + items: + $ref: '#/components/schemas/TextMatch' + description: Gets or sets the attribute values. + AttributeNamesAndValues: + $ref: '#/components/schemas/Dictionary_String_TextMatch_' + ChangeType: + type: string + description: Gets or sets the device event change type. + ItemName: + type: string + description: Gets or sets the item name (e.g file name etc). + RuleVariableResults: + $ref: '#/components/schemas/Dictionary_String_TextMatch_' + TaskId: + type: integer + description: ' Gets or sets the task id.' + format: int32 + PolicyTemplateNames: + type: array + items: + type: string + description: ' Gets or sets the report policy template names.' + NotificationRefIds: + type: array + items: + type: string + description: Gets or sets the notification ref ids to search for. + ReportScoreRange: + $ref: '#/components/schemas/ScoreRange' + description: Represents a specification limiting the types of events returned from a GetEvents + TextMatch: + title: TextMatch + type: object + properties: + Text: + type: string + description: Gets or sets the text to match using the given Operator + CaseSensitive: + type: boolean + description: ' Gets or sets a value indicating whether the match is case sensitive.' + x-nullable: false + Operator: + type: string + description: Gets or sets the operator. + TextLowerInvariant: + type: string + description: Gets the text as lowercase invariant. + description: 'The event filter text match specifies text to match, together with and operator an case sensitivity setting.' + Dictionary_String_TextMatch_: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/TextMatch' + description: 'Dictionary' + ScoreRange: + title: ScoreRange + type: object + properties: + Min: + type: number + format: double + x-nullable: false + Max: + type: number + format: double + x-nullable: false + Operator: + type: string + description: ScoreRange + SubmitAlertEvents: + title: SubmitAlertEvents + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + description: Specifies the list of alert events for the hub to process. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of alert events to the system. + AlertEvent: + title: AlertEvent + type: object + properties: + NotificationStatus: + type: string + description: ' Gets or sets the current notification status of the event' + AlertDescription: + type: string + description: ' Gets or sets the alert description.' + Severity: + type: integer + description: Gets or sets the Severity. + format: int32 + x-nullable: false + NotificationType: + type: string + description: Gets or sets the notification type. + NotificationRefIds: + type: array + items: + type: string + description: 'Gets or sets the notification reference ids for the alert event. Used when an event is only relevant to a specific template, to enable notifications to only be sent to users subscribed to events for that group.' + Comment: + type: string + description: Gets or sets the event comment. + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + DeviceName: + type: string + description: Gets or sets the device name. + Id: + type: string + description: Gets or sets the unique event ID + EventType: + type: string + description: Gets or sets the event type. + DateUtc: + type: string + description: Gets or sets the UTC date and time of the event. + format: date-time + x-nullable: false + DateDevice: + type: string + description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + format: date-time + x-nullable: false + DateLocal: + type: string + description: 'Gets or sets the local user''s date and time of the event, based on the GetEvents.UserTimeZoneId specified.' + format: date-time + x-nullable: false + Status: + type: string + description: Gets or sets the current status of the event + PlannedChangeStatus: + type: string + description: Gets or sets the planned change status. + PlannedChangeId: + type: string + description: Gets or sets the planned change id + PlannedChangeManual: + type: boolean + description: Gets or sets whether event was added to the planned change manually or via a rule. + x-nullable: false + Origin: + type: string + description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + TimeZoneId: + type: string + description: Gets or sets the time zone id. + UtcOffsetHours: + type: number + description: Gets or sets the offset of local time as represented by TimeZoneId and Utc time in hours. + format: double + x-nullable: false + Version: + type: integer + description: Gets or sets the object version. + format: int32 + x-nullable: false + Score: + type: number + description: Gets or sets the score - only used when returning 'ranked' events. + format: double + x-nullable: false + Description: + type: string + description: Gets or sets the event description. + ProcessingTimeMs: + type: number + description: Gets or sets the processing time in ms. + format: double + Url: + type: string + description: Gets a URL of the event to get more details. + ExtraInfo: + type: string + description: 'Gets or sets the extra info. Where the event is an alert notification, this contains information about tracker reconfigurations, this property can be used to hold the data in a more easily parsed form.' + UsedInBaselines: + type: array + items: + $ref: '#/components/schemas/UsedInBaseline' + description: 'Gets or sets the links indicating whether the event has been used to create or amend a rule in a baseline report, and the action taken.' + description: The alert event. + UsedInBaseline: + title: UsedInBaseline + type: object + properties: + NotificationRefId: + type: string + Action: + type: string + User: + type: string + DateUtc: + type: string + format: date-time + x-nullable: false + description: UsedInBaseline + SubmitAlertEventsLimited: + title: SubmitAlertEventsLimited + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + description: Specifies the list of alert events for the hub to process. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + SubmitBaselineEvents: + title: SubmitBaselineEvents + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + description: Specifies the list of baseline events for the hub to process. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of baseline events to the system. + BaselineEvent: + title: BaselineEvent + type: object + properties: + BaselineType: + type: string + description: ' Gets or sets the baseline type, from None (normal device change event), current baseline state event, historical baseline event.' + BaselineReason: + type: string + description: 'Gets or sets the baseline reason. ' + ConfigId: + type: string + description: 'Gets or sets the config id, a string that uniquely identifies the device configuration that generated the event. This id is also supplied with the SubmitAlertEvents reconfigured NotificationType.AgentActivityNotification alert, telling the system that baseline events from that configuration should now be marked as historical.' + ProcessingCompleteTimeUtc: + type: string + description: Gets or sets the processing complete UTC time. + format: date-time + NotificationStatus: + type: string + description: Gets or sets the current notification status of the event + ChangeType: + type: string + description: 'Gets or sets the change type, specifies whether this is a new, changed or deleted event of the given Types.EventType' + AttributeSeparators: + $ref: '#/components/schemas/Dictionary_String_String_' + CurrentAttributes: + $ref: '#/components/schemas/Dictionary_String_String_' + Data: + type: string + description: Gets or sets the event data. + ItemName: + type: string + description: 'Gets or sets the name of the item that this event is about. May be a file path, command, windows update id, database table name etc.' + ItemTypeId: + type: integer + description: Gets or sets the item type id. + format: int32 + x-nullable: false + ItemTypeName: + type: string + description: Gets or sets the item type name. + TrackerTypeId: + type: integer + description: Gets or sets the tracker type id. + format: int32 + x-nullable: false + TrackerTypeName: + type: string + description: Gets or sets the tracker name. + NotificationRefIds: + type: array + items: + type: string + description: Gets or sets the notification reference ids for the baseline event. + Comment: + type: string + description: Gets or sets the event comment. + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + DeviceName: + type: string + description: Gets or sets the device name. + Id: + type: string + description: Gets or sets the unique event ID + EventType: + type: string + description: Gets or sets the event type. + DateUtc: + type: string + description: Gets or sets the UTC date and time of the event. + format: date-time + x-nullable: false + DateDevice: + type: string + description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + format: date-time + x-nullable: false + DateLocal: + type: string + description: 'Gets or sets the local user''s date and time of the event, based on the GetEvents.UserTimeZoneId specified.' + format: date-time + x-nullable: false + Status: + type: string + description: Gets or sets the current status of the event + PlannedChangeStatus: + type: string + description: Gets or sets the planned change status. + PlannedChangeId: + type: string + description: Gets or sets the planned change id + PlannedChangeManual: + type: boolean + description: Gets or sets whether event was added to the planned change manually or via a rule. + x-nullable: false + Origin: + type: string + description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + TimeZoneId: + type: string + description: Gets or sets the time zone id. + UtcOffsetHours: + type: number + description: Gets or sets the offset of local time as represented by TimeZoneId and Utc time in hours. + format: double + x-nullable: false + Version: + type: integer + description: Gets or sets the object version. + format: int32 + x-nullable: false + Score: + type: number + description: Gets or sets the score - only used when returning 'ranked' events. + format: double + x-nullable: false + Description: + type: string + description: Gets or sets the event description. + ProcessingTimeMs: + type: number + description: Gets or sets the processing time in ms. + format: double + Url: + type: string + description: Gets a URL of the event to get more details. + ExtraInfo: + type: string + description: 'Gets or sets the extra info. Where the event is an alert notification, this contains information about tracker reconfigurations, this property can be used to hold the data in a more easily parsed form.' + UsedInBaselines: + type: array + items: + $ref: '#/components/schemas/UsedInBaseline' + description: 'Gets or sets the links indicating whether the event has been used to create or amend a rule in a baseline report, and the action taken.' + description: The device event. + SubmitBaselineEventsLimited: + title: SubmitBaselineEventsLimited + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + description: Specifies the list of baseline events for the hub to process. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + SubmitDeviceEvents: + title: SubmitDeviceEvents + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + description: Specifies the list of device events for the hub to process. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of device change events to the system. + DeviceEvent: + title: DeviceEvent + type: object + properties: + BaselineType: + type: string + description: 'Gets or sets the baseline type, from None (normal device change event), current baseline state event, historical baseline event.' + ProcessingCompleteTimeUtc: + type: string + description: ' Gets or sets the processing complete UTC time.' + format: date-time + NotificationStatus: + type: string + description: Gets or sets the current notification status of the event + ChangeType: + type: string + description: 'Gets or sets the change type, specifies whether this is a new, changed or deleted event of the given Types.EventType' + ChangedAttributes: + type: array + items: + type: string + description: 'Gets or sets the names of the changed attributes, if any.' + AttributeSeparators: + $ref: '#/components/schemas/Dictionary_String_String_' + CurrentAttributes: + $ref: '#/components/schemas/Dictionary_String_String_' + Data: + type: string + description: Gets or sets the event data. + ItemName: + type: string + description: 'Gets or sets the name of the item that this event is about. May be a file path, command, windows update id, database table name etc.' + ItemTypeId: + type: integer + description: Gets or sets the item type id. + format: int32 + x-nullable: false + ItemTypeName: + type: string + description: Gets or sets the item type name. + PreviousAttributes: + $ref: '#/components/schemas/Dictionary_String_String_' + TrackerTypeId: + type: integer + description: Gets or sets the tracker type id. + format: int32 + x-nullable: false + TrackerTypeName: + type: string + description: Gets or sets the tracker name. + NotificationRefIds: + type: array + items: + type: string + description: 'Gets or sets the notification reference ids for the device event. Used when an event is only relevant to a specific template, to enable notifications to only be sent to users subscribed to events for that group.' + TextDifferences: + type: array + items: + $ref: '#/components/schemas/TextDifference' + description: 'List of line text differences, for process output tracker content comparison' + Comment: + type: string + description: Gets or sets the event comment. + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + DeviceName: + type: string + description: Gets or sets the device name. + Id: + type: string + description: Gets or sets the unique event ID + EventType: + type: string + description: Gets or sets the event type. + DateUtc: + type: string + description: Gets or sets the UTC date and time of the event. + format: date-time + x-nullable: false + DateDevice: + type: string + description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + format: date-time + x-nullable: false + DateLocal: + type: string + description: 'Gets or sets the local user''s date and time of the event, based on the GetEvents.UserTimeZoneId specified.' + format: date-time + x-nullable: false + Status: + type: string + description: Gets or sets the current status of the event + PlannedChangeStatus: + type: string + description: Gets or sets the planned change status. + PlannedChangeId: + type: string + description: Gets or sets the planned change id + PlannedChangeManual: + type: boolean + description: Gets or sets whether event was added to the planned change manually or via a rule. + x-nullable: false + Origin: + type: string + description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + TimeZoneId: + type: string + description: Gets or sets the time zone id. + UtcOffsetHours: + type: number + description: Gets or sets the offset of local time as represented by TimeZoneId and Utc time in hours. + format: double + x-nullable: false + Version: + type: integer + description: Gets or sets the object version. + format: int32 + x-nullable: false + Score: + type: number + description: Gets or sets the score - only used when returning 'ranked' events. + format: double + x-nullable: false + Description: + type: string + description: Gets or sets the event description. + ProcessingTimeMs: + type: number + description: Gets or sets the processing time in ms. + format: double + Url: + type: string + description: Gets a URL of the event to get more details. + ExtraInfo: + type: string + description: 'Gets or sets the extra info. Where the event is an alert notification, this contains information about tracker reconfigurations, this property can be used to hold the data in a more easily parsed form.' + UsedInBaselines: + type: array + items: + $ref: '#/components/schemas/UsedInBaseline' + description: 'Gets or sets the links indicating whether the event has been used to create or amend a rule in a baseline report, and the action taken.' + description: The device event. + TextDifference: + title: TextDifference + type: object + properties: + ExpectedText: + type: string + ActualText: + type: string + description: TextDifference + SubmitDeviceEventsLimited: + title: SubmitDeviceEventsLimited + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + description: Specifies the list of device events for the hub to process. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + SystemReady: + title: SystemReady + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets whether system is booted and ready for login. + SystemDetails: + title: SystemDetails + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets system version and config settings once logged in. + GetBackgroundTaskStatuses: + title: GetBackgroundTaskStatuses + type: object + properties: + UserName: + type: string + description: 'Specifies a specific user name to retrieve tasks for (Optional, but only Admin users can retrieve tasks for other users or internal system tasks).' + StartDateTimeUtc: + type: string + description: Specifies the start time (in UTC) for a task to be retrieved (Optional). + format: date-time + EndDateTimeUtc: + type: string + description: Specifies the end time (in UTC) for a task to be retrieved (Optional). + format: date-time + Statuses: + type: array + items: + type: string + x-nullable: false + description: Specifies the status of tasks to be retrieved (Optional). + TaskIds: + type: array + items: + type: string + description: Specifies a list of specific task ids to retrieved (Optional). + TaskTypes: + type: array + items: + type: string + description: Specifies a list of specific task types to be retrieved (Optional). + IncludeDependentTasks: + type: boolean + description: Specifies whether to return the tasks that each task depends on in its DependentTasks property (Optional). + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + EventsOnIncomingQueue: + title: EventsOnIncomingQueue + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the number of events currently in the processing queue. + EventMessageStatus: + title: EventMessageStatus + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Returns the number of internal event notification messages received, processed or failed.' + GetPipelineStatus: + title: GetPipelineStatus + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + GetPipelineMetrics: + title: GetPipelineMetrics + type: object + properties: + Interval: + type: string + FromUtc: + type: string + format: date-time + ToUtc: + type: string + format: date-time + PipelineNode: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets system performance metrics. + GetWorkloadStats: + title: GetWorkloadStats + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Returns the pipeline workload. + GetCacheStats: + title: GetCacheStats + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Returns the cache statistics. + GetOpenApi3Yaml: + title: GetOpenApi3Yaml + type: object + description: GetOpenApi3Yaml + GetAvailableReportTypes: + title: GetAvailableReportTypes + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + GetReportTemplate: + title: GetReportTemplate + type: object + properties: + TemplateType: + type: string + RendererType: + type: string + TemplateName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + GetReportTemplates: + title: GetReportTemplates + type: object + properties: + ReportTemplateType: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + GetScheduledReports: + title: GetScheduledReports + type: object + properties: + Id: + type: string + IdType: + type: string + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + UsageTag: + type: string + IncludeAllUsersReports: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + UpdateReportTemplate: + title: UpdateReportTemplate + type: object + properties: + TemplateId: + type: string + TemplateType: + type: string + ReportTemplateName: + type: string + ReportTemplateType: + type: string + TemplateVersion: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + UploadReportTemplate: + title: UploadReportTemplate + type: object + properties: + Name: + type: string + description: Specifies the name. + TemplateType: + type: string + description: Specifies the template type. + OverwriteIfExists: + type: boolean + description: Specifies a flag to indicate wether or not to overwrite the report / config if it already exists + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + DeleteCustomReportTemplate: + title: DeleteCustomReportTemplate + required: + - ReportTemplateType + - TemplateName + - TemplateVersion + type: object + properties: + ReportTemplateType: + type: string + description: Gets or sets the ReportTemplateType of the report template to delete. + TemplateName: + type: string + description: Gets or sets the name of the report template to delete. + TemplateVersion: + type: string + description: Gets or sets the version of the report template to delete. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes a report layout template of the specified type and name + DataSpecDeviceMonitoringReport: + title: DataSpecDeviceMonitoringReport + required: + - DateRange + type: object + properties: + ExcludeEvents: + type: boolean + x-nullable: false + ExcludePlannedChanges: + type: boolean + x-nullable: false + ExcludeTrackerDetails: + type: boolean + x-nullable: false + ExcludeReportDetails: + type: boolean + x-nullable: false + DateRange: + $ref: '#/components/schemas/ReportDateRange' + OnlineStatuses: + type: array + items: + type: string + x-nullable: false + description: Gets or sets the online statuses of the devices to return. Optional. + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + Id: + type: string + description: Specifies the Id of the data query specification + Type: + type: string + description: The Type name of the data query specification + IteratorValues: + type: array + items: + type: string + description: 'Used to specify the list of items to report on, for data query specifications that support this. If this is not supplied, SelectionQuery can be used to specify a query to be performed to find the list of ids to report on' + SelectionQuery: + $ref: '#/components/schemas/SelectionQuery' + Groups: + type: array + items: + type: string + description: Specifies the Groups (and implicitly and child groups) to be reported on in the report. + ItemName: + type: string + description: 'Specifies the descriptive name of the result item, for example ''report'', ''planned change'', ''event'' etc.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to gets the data for a device monitoring report + ReportDateRange: + title: ReportDateRange + type: object + properties: + LastNSeconds: + type: integer + format: int32 + StartUtc: + type: string + format: date-time + EndUtc: + type: string + format: date-time + SnapToWholeUnit: + type: boolean + x-nullable: false + OffsetUnits: + type: integer + format: int32 + x-nullable: false + TimeZoneId: + type: string + description: ReportDateRange + SelectionQuery: + title: SelectionQuery + type: object + properties: + Operator: + type: string + FieldName: + type: string + SearchText: + type: string + description: SelectionQuery + GetRuleResults: + title: GetRuleResults + type: object + properties: + GroupResultsEventId: + type: string + RuleResultStateIds: + type: array + items: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: GetRuleResults + GetComplianceReportSummaryData: + title: GetComplianceReportSummaryData + required: + - ReportItemId + - ReportInstanceId + type: object + properties: + ReportItemId: + type: string + description: Specifies the scheduled report item id. + ReportInstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + IncludeAgentTaskDetails: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: GetComplianceReportSummaryData + GetCurrentPlannedChanges: + title: GetCurrentPlannedChanges + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + PeriodHours: + type: integer + format: int32 + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Stats Service + GetComplianceData: + title: GetComplianceData + required: + - ReportItemId + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + FillInMissingData: + type: boolean + x-nullable: false + LeftmostInstanceId: + type: string + RightmostInstanceId: + type: string + PagingDirection: + type: string + ReportItemId: + type: string + description: Specifies the scheduled report item id. + StartUtc: + type: string + format: date-time + EndUtc: + type: string + format: date-time + ReportName: + type: string + MaxNumberOfSummaries: + type: integer + format: int32 + x-nullable: false + IncludeAdhocRunsInResults: + type: boolean + x-nullable: false + TimeZoneId: + type: string + IncludeDevicesWithNoResults: + type: boolean + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Get report summaries by report, for either individual devices, or as group average.' + GetAvailableComplianceData: + title: GetAvailableComplianceData + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + StartUtc: + type: string + format: date-time + EndUtc: + type: string + format: date-time + ReturnDevices: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get a list of groups or devices that have report data available for them + GetDeviceActivity: + title: GetDeviceActivity + type: object + properties: + MaxDevicesToReturn: + type: integer + format: int32 + x-nullable: false + IncludeTaskActivity: + type: boolean + x-nullable: false + IncludeDeletedDevices: + type: boolean + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a list of inactive devices matching the filter. + GetEventCounts: + title: GetEventCounts + type: object + properties: + UseCachedCounts: + type: boolean + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + TimeZoneId: + type: string + StartUtc: + type: string + format: date-time + EndUtc: + type: string + format: date-time + DateRangeSeconds: + type: integer + format: int32 + x-nullable: false + SummaryWindowSeconds: + type: integer + format: int32 + x-nullable: false + InferDateRangeEndpoints: + type: boolean + x-nullable: false + ReturnAsSingleResult: + type: boolean + x-nullable: false + PlannedChangeStatuses: + type: array + items: + type: string + x-nullable: false + EventTypes: + type: array + items: + type: string + x-nullable: false + PlannedChangeInstanceId: + type: string + TrackerTypeNames: + type: array + items: + type: string + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + GetNoisyDevices: + title: GetNoisyDevices + type: object + properties: + TopN: + type: integer + format: int32 + x-nullable: false + description: 'Gets a summary of event counts for top N noisiest devices in the specified group, for the specified time period.' + ExecuteReport: + title: ExecuteReport + required: + - ReportItemId + type: object + properties: + ReportItemId: + type: string + description: Specifies the scheduled report item id. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + RenderReportIsCached: + title: RenderReportIsCached + type: object + properties: + RendererType: + type: string + ReportItemId: + type: string + description: Specifies the scheduled report item id. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + RuleSetResultEventId: + type: string + description: 'For compliance reports only, if the InstanceId and ReportItemId are not available, the id of a previously stored RuleSetResultEvent can be supplied in this parameter.' + Format: + type: string + RenderingOptions: + $ref: '#/components/schemas/RenderingOptionOverrides' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + RenderingOptionOverrides: + title: RenderingOptionOverrides + type: object + properties: + ShowTableOfContents: + type: string + ContainerReportOptions: + $ref: '#/components/schemas/ReportRenderingOptions' + SubReportOptions: + type: array + items: + $ref: '#/components/schemas/ReportRenderingOptions' + description: RenderingOptionOverrides + ReportRenderingOptions: + title: ReportRenderingOptions + type: object + properties: + ReportSpecId: + type: string + CustomIntroParagraph: + type: string + ElementVisibility: + $ref: '#/components/schemas/ReportElementVisibility' + TemplateName: + type: string + TemplateSubType: + type: string + description: ReportRenderingOptions + ReportElementVisibility: + title: ReportElementVisibility + type: object + properties: + ShowCustomIntro: + type: boolean + x-nullable: false + ShowAgents: + type: boolean + x-nullable: false + ShowEvents: + type: boolean + x-nullable: false + ShowComments: + type: boolean + x-nullable: false + ShowQueryParameters: + type: boolean + x-nullable: false + ShowResultDescriptions: + type: boolean + x-nullable: false + ShowChildComplianceReports: + type: string + ChildComplianceReportScore: + type: number + format: double + x-nullable: false + ShowResultsOptions: + type: string + ChildReportIds: + type: array + items: + $ref: '#/components/schemas/ChildIdDisplay' + FieldVisibility: + type: array + items: + $ref: '#/components/schemas/FieldDisplay' + description: ReportElementVisibility + ChildIdDisplay: + title: ChildIdDisplay + type: object + properties: + Text: + type: string + Value: + type: string + description: ChildIdDisplay + FieldDisplay: + title: FieldDisplay + type: object + properties: + IsPrev: + type: boolean + x-nullable: false + Fmt: + type: string + CalculationType: + type: string + ListSeparators: + type: array + items: + type: string + Hdr: + type: string + AttrPrev: + type: string + AttrCurr: + type: string + FPrev: + type: string + FCurr: + type: string + Name: + type: string + description: FieldDisplay + RenderReport: + title: RenderReport + required: + - ReportItemId + - InstanceId + type: object + properties: + RendererType: + type: string + ReportItemId: + type: string + description: Specifies the scheduled report item id. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Format: + type: string + RenderingOptions: + $ref: '#/components/schemas/RenderingOptionOverrides' + ReturnAttachment: + type: boolean + x-nullable: false + RuleSetResultEventId: + type: string + description: 'For compliance reports only, if the InstanceId and ReportItemId are not available, the id of a previously stored RuleSetResultEvent can be supplied in this parameter.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + RenderReportStart: + title: RenderReportStart + required: + - ReportItemId + - InstanceId + type: object + properties: + RendererType: + type: string + ReportItemId: + type: string + description: Specifies the scheduled report item id. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Format: + type: string + RenderingOptions: + $ref: '#/components/schemas/RenderingOptionOverrides' + RuleSetResultEventId: + type: string + description: 'For compliance reports only, if the InstanceId and ReportItemId are not available, the id of a previously stored RuleSetResultEvent can be supplied in this parameter.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + GetScheduledInstanceOutput: + title: GetScheduledInstanceOutput + type: object + properties: + Id: + type: string + ReturnAttachment: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a previously generated report output file + DeleteScheduledInstanceOutputs: + title: DeleteScheduledInstanceOutputs + type: object + properties: + Ids: + type: array + items: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes previously generated report output files + DeleteScheduledInstance: + title: DeleteScheduledInstance + required: + - ReportItemId + - InstanceId + type: object + properties: + ReportItemId: + type: string + description: Specifies the scheduled report item id. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + UpdateScheduledInstanceLifetime: + title: UpdateScheduledInstanceLifetime + required: + - ReportItemId + - InstanceId + type: object + properties: + ReportItemId: + type: string + description: Specifies the scheduled report item id. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + KeepResultsUntilUtc: + type: string + format: date-time + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + GetScheduledInstanceRendered: + title: GetScheduledInstanceRendered + type: object + properties: + ReportItemId: + type: string + description: Specifies the scheduled report item id. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + AddScheduledReport: + title: AddScheduledReport + required: + - Id + type: object + properties: + Id: + type: string + description: 'The id of the type of report to add, from the list supplied by GetAvailableReportTypes' + IsPublic: + type: boolean + description: Indicates whether the report/query can be seen by everyone + x-nullable: false + IsEditable: + type: boolean + description: 'Indicates whether the report/query can be edited/deleted by everyone. Note, if this is true, IsPublic must also be true' + x-nullable: false + IsHidden: + type: boolean + description: Indicates whether the report/query is visible in the reports list. Used to create temporary items for interactive 'export to csv' functions. + x-nullable: false + AsCopyOf: + type: string + description: Specifies as a copy of an existing the report/query with this Id + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a new schedulable report of the type specified by the Id parameter + UpdateScheduledReport: + title: UpdateScheduledReport + type: object + properties: + Id: + type: string + ShowTableOfContents: + type: string + description: Specifies the updated setting for when a table of content page is shown. + ContainerReport: + $ref: '#/components/schemas/ReportSpecification' + Reports: + type: array + items: + $ref: '#/components/schemas/ReportSpecification' + description: Specifies the updated definition of the sub reports. + KeepUnscheduledResultsForMinutes: + type: integer + description: 'Specifies how long to keep ''adhoc'' (ie non-scheduled) report results for, in minutes.' + format: int32 + x-nullable: false + KeepScheduledResultsForMinutes: + type: integer + description: 'Specifies how long to keep scheduled report results for, in minutes.' + format: int32 + x-nullable: false + WaitForAdhocResultsMinutes: + type: integer + description: 'Specifies long to wait for a run''s queries to complete, in minutes.' + format: int32 + x-nullable: false + OverrideWaitForResults: + type: boolean + description: Specifies whether to override the default behaviour for scheduled queries of waiting until the next scheduled run and use the value specified by WaitForAdhocResultsMinutes instead. + x-nullable: false + Schedule: + $ref: '#/components/schemas/ReportSchedule' + EmailDelivery: + $ref: '#/components/schemas/ReportEmailDelivery' + IsPublic: + type: boolean + description: Specifies whether the report/query can be seen by everyone. + x-nullable: false + IsEditable: + type: boolean + description: Specifies whether the report/query can be edited by everyone. + x-nullable: false + IsHidden: + type: boolean + description: Specifies whether the report/query can be seen in the UI. + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + ReportSpecification: + title: ReportSpecification + type: object + properties: + ReportTemplateId: + type: string + ReportSpecId: + type: string + DataSpecId: + type: string + DataSpecType: + type: string + DataSpec: + $ref: '#/components/schemas/DataSpecBase' + Iterator: + $ref: '#/components/schemas/IteratorValueSupply' + DisplayName: + type: string + DisplayNameDefault: + type: string + RenderingOptions: + $ref: '#/components/schemas/ReportRenderingOptions' + description: ReportSpecification + DataSpecBase: + title: DataSpecBase + type: object + properties: + Id: + type: string + description: Specifies the Id of the data query specification + Type: + type: string + description: The Type name of the data query specification + IteratorValues: + type: array + items: + type: string + description: 'Used to specify the list of items to report on, for data query specifications that support this. If this is not supplied, SelectionQuery can be used to specify a query to be performed to find the list of ids to report on' + SelectionQuery: + $ref: '#/components/schemas/SelectionQuery' + Groups: + type: array + items: + type: string + description: Specifies the Groups (and implicitly and child groups) to be reported on in the report. + ItemName: + type: string + description: 'Specifies the descriptive name of the result item, for example ''report'', ''planned change'', ''event'' etc.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: The base class common to all report data query specifications + IteratorValueSupply: + title: IteratorValueSupply + type: object + properties: + IteratorType: + type: string + ValueList: + type: array + items: + type: string + ValuePropertyName: + type: string + description: IteratorValueSupply + ReportSchedule: + title: ReportSchedule + type: object + properties: + DateMinUtc: + type: string + format: date-time + x-nullable: false + DateMaxUtc: + type: string + format: date-time + x-nullable: false + Enabled: + type: boolean + description: Specifies a flag to indicate whether the schedule is enabled + x-nullable: false + EnabledStartUtc: + type: string + format: date-time + x-nullable: false + EnabledEndUtc: + type: string + format: date-time + x-nullable: false + RepeatStartUtc: + type: string + format: date-time + x-nullable: false + RepeatEveryNPeriods: + type: integer + format: int32 + x-nullable: false + PeriodSizeSeconds: + type: integer + format: int32 + x-nullable: false + TimeZone: + type: string + description: Represents the schedule on which to produce and deliver the report. + ReportEmailDelivery: + title: ReportEmailDelivery + type: object + properties: + SendEmail: + type: boolean + description: Specifies a flag to indicate whether to send an email + x-nullable: false + EmailUsers: + type: array + items: + type: string + description: Specifies a list of system user names to send email to + Attachment1Format: + type: string + description: Specifies the format of the first optional formatted report email attachment. + Attachment2Format: + type: string + description: Specifies the format of the second optional formatted report email attachment. + Attachment3Format: + type: string + description: Specifies the format of the third optional formatted report email attachment. + Attachment1TemplateName: + type: string + description: Specifies the template name used for the first optional formatted report email attachment. + Attachment2TemplateName: + type: string + description: Specifies the template name used for the second optional formatted report email attachment. + Attachment3TemplateName: + type: string + description: Specifies the template name used for the third optional formatted report email attachment. + DontSendIfNoResultsReturned: + type: boolean + description: Specifies a flag to indicate whether or not the results should be sent (notified) if no results where returned + x-nullable: false + SuppressResultsLink: + type: boolean + description: Specifies a flag to include suppress the link to the results in notification email? + x-nullable: false + AdditionalEmailAddresses: + type: string + description: Specifies a list of additional email addresses to send the notification to (i.e people that may exist outside the CT system). Semicolon separated. + ZipAttachments: + type: boolean + description: Specifies a flag to include that attachments should be zipped + x-nullable: false + ZipPassword: + type: string + description: Specifies the password for zipfile when ZipAttachments is used + DontSendAttachmentsIfLargerThanKb: + type: integer + description: Specifies a maxmimum allowed size for attachements in kilobytes. Default 0 means no limit. + format: int32 + x-nullable: false + description: ReportEmailDelivery + DeleteScheduledReports: + title: DeleteScheduledReports + type: object + properties: + Ids: + type: array + items: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + GetScheduledInstances: + title: GetScheduledInstances + required: + - ReportItemId + - InstanceId + type: object + properties: + SummaryOnly: + type: boolean + description: Returns only summary information for use in reporting UI page + x-nullable: false + ReportItemId: + type: string + description: Specifies the scheduled report item id. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Report Service + UploadAgentUpdate: + title: UploadAgentUpdate + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Upload an Agent Update + UpdateHubDetails: + title: UpdateHubDetails + type: object + properties: + AgentDeviceIds: + type: array + items: + type: string + GroupName: + type: string + HubServerUrl: + type: string + HubAgentUsername: + type: string + HubAgentPassword: + type: string + HubAgentNamePrefix: + type: string + HubAgentNameSuffix: + type: string + NewTrustedThumbprint: + type: string + NewTrustedPublicKey: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update the HUbDetails.xml file for the specified agents / groups + DownloadUpdate: + title: DownloadUpdate + type: object + properties: + VersionRequested: + type: string + description: 'Used when requesting an update file from the hub, specifies the specific version required.' + UpdateType: + type: string + description: 'Specifies the update type to download (e,g RPM, DEB etc).' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Download an update package for the agent. + DeleteAgentUpdate: + title: DeleteAgentUpdate + type: object + properties: + Id: + type: string + description: Specifies the agent update ID to delete. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes the specified Agent update. + GetAgentUpdates: + title: GetAgentUpdates + type: object + properties: + VersionRequested: + type: string + description: Specifies the (optional) version to get details for. + Id: + type: string + description: Specifies the specific agent update ID to get. + UpdateType: + type: string + description: 'Gets or sets the update type (deb, rpm etc)' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets a list of Agent updates, by version or specific ID.' + GetAgentSoftwareUpdateScheduleForGroup: + title: GetAgentSoftwareUpdateScheduleForGroup + type: object + properties: + GroupName: + type: string + description: Specifies the group name to remove the schedule for. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the agent software update schedule for a group. + DeleteAgentSoftwareUpdateScheduleFromGroup: + title: DeleteAgentSoftwareUpdateScheduleFromGroup + type: object + properties: + GroupName: + type: string + description: Specifies the group name to remove the schedule for. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Remove (delete) the agent software update schedule for a group. + UpdateAgentSoftwareUpdateScheduleForGroup: + title: UpdateAgentSoftwareUpdateScheduleForGroup + type: object + properties: + GroupName: + type: string + description: Gets or sets the group name that the update scheduled applies to. + AgentUpdateSchedule: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update the agent software update schedule for a group. + GroupAgentUpdateSchedule: + title: GroupAgentUpdateSchedule + type: object + properties: + UpdateId: + type: string + description: Specifies the Update ID from the AgentSoftwareUpdateService + AgentVersion: + type: string + description: Specifies the version to be downloaded + UpdateType: + type: string + description: Specifies the update type to be downloaded + StartTimeUtc: + type: string + description: Specifies the start date / time for the update to take place + format: date-time + x-nullable: false + EndTimeUtc: + type: string + description: Specifies the end date / time for the update to take place + format: date-time + x-nullable: false + GroupName: + type: string + description: Specifies the group name this update applies to + UpgradeToNetCore: + type: boolean + description: Specifies whether non-netcore agents will be upgraded to a netcore version + x-nullable: false + description: Defines a schedule for a group to receive an agent software update + SetAgentSoftwareUpdateScheduleForGroup: + title: SetAgentSoftwareUpdateScheduleForGroup + type: object + properties: + GroupName: + type: string + description: Specifies the group name to associate this schedule with. + AgentUpdateSchedule: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add (set) an agent update schedule for a specific group. Only one schedule is permitted per group at the current time. + GetSyncServiceConfigItems: + title: GetSyncServiceConfigItems + type: object + properties: + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of SyncService configuration items. + AddSyncServiceConfigItem: + title: AddSyncServiceConfigItem + required: + - Key + - Value + type: object + properties: + Key: + type: string + description: The configuration key + Value: + type: string + description: The configuration value + Hidden: + type: boolean + description: Indicates whether this configuration value should be stored as a secret + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a new SyncService configuration item. + UpdateSyncServiceConfigItem: + title: UpdateSyncServiceConfigItem + required: + - Key + - Value + type: object + properties: + Key: + type: string + description: The configuration key + Value: + type: string + description: The configuration value + Hidden: + type: boolean + description: Indicates whether this configuration value should be stored as a secret + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Updates an existing SyncService configuration item. + DeleteSyncServiceConfigItem: + title: DeleteSyncServiceConfigItem + required: + - Key + type: object + properties: + Key: + type: string + description: The configuration key + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes a SyncService configuration item. + GetConfigItems: + title: GetConfigItems + type: object + properties: + Id: + type: string + description: Specifies a specific configuration item to retrieve (Optional). + Key: + type: string + description: Specifies a specific configuration parameter 'Key' to retrieved (Optional). + KeyList: + type: array + items: + type: string + description: Specifies a list of specific configuration parameter 'Keys' to retrieved (Optional). + IncludeHidden: + type: boolean + description: 'Include hidden, ''system'', parameters.' + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of hub configuration parameters. + AddConfigItems: + title: AddConfigItems + type: object + properties: + ConfigItems: + $ref: '#/components/schemas/Dictionary_String_String_' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a list of hub configuration parameters. + UpdateConfigItems: + title: UpdateConfigItems + type: object + properties: + ConfigItems: + type: array + items: + $ref: '#/components/schemas/UpdateConfigItem' + description: A list of config items to update. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update a a list of hub configuration parameters. + UpdateConfigItem: + title: UpdateConfigItem + type: object + properties: + Id: + type: string + description: The specific config value to update (can be used if a multi-value key is being updated or if a key is to be changed). + Key: + type: string + description: The new key value in the case of updating by Id or a the key to search for if updating by key. + Value: + type: string + description: The new value for this config key / id. + Hidden: + type: boolean + description: A boolean indicating whether or not to hide this config item from the UI. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update a single hub configuration parameter by either ID or Key. + DeleteConfigItem: + title: DeleteConfigItem + type: object + properties: + Id: + type: string + description: Specifies the specific config item to remove. + Key: + type: string + description: 'Specifies the config item key to remove. Note : will remove all instances of config items with the same key.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Remove a hub configuration parameter by either ID or Key. + AddConfigItem: + title: AddConfigItem + type: object + properties: + Key: + type: string + description: The configuration key you wish to add + Value: + type: string + description: The value of the key + Hidden: + type: boolean + description: A boolean indicating whether or not this is a 'hidden' key (i.e internal not intended for users to change) + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a hub configuration parameter by Key. + DateTransmissionTest: + title: DateTransmissionTest + type: object + properties: + DateTime: + type: string + description: The date to send to the hub that will be then sent back as the response to ensure no loss of accuracy occurs + format: date-time + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Echos the specified date/time value to ensure that no serialization issues exist between hub and client. + AddCredentials: + title: AddCredentials + type: object + properties: + Credentials: + $ref: '#/components/schemas/Credentials' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add credentials for specified type and key. + Credentials: + title: Credentials + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + CredentialType: + type: string + description: Specifies the credential type. + LegacyDbCredential: + type: boolean + description: Specifies whether the credential is a legacy db credential. + x-nullable: false + DeviceOnlineDetection: + type: string + Key: + type: string + description: Specifies the key. + PublicKeys: + type: array + items: + type: string + description: Specifies the public keys. + Parameters: + $ref: '#/components/schemas/Dictionary_String_String_' + Prompts: + type: array + items: + type: string + description: Specifies the prompts. + DecryptionErrors: + $ref: '#/components/schemas/Dictionary_String_String_' + LastModifiedDateUtc: + type: string + format: date-time + x-nullable: false + IsTrusted: + type: boolean + x-nullable: false + NotTrustedReason: + type: string + DiscoveryTaskId: + type: integer + format: int32 + x-nullable: false + DiscoveryStatusMessage: + type: string + DiscoveryTaskStatus: + type: string + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + UpdateCredentials: + title: UpdateCredentials + type: object + properties: + CredentialsType: + type: string + description: Specifies the original credential type. + Key: + type: string + description: Specifies the original key + Credentials: + $ref: '#/components/schemas/Credentials' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update credentials for specified type and key. + RemoveCredentials: + title: RemoveCredentials + type: object + properties: + CredentialsType: + type: string + description: Specifies the credentials type. + Key: + type: string + description: Specifies the key. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Remove credentials for specified type and key. + GetCredentialsKeyedByType: + title: GetCredentialsKeyedByType + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Get a list of all the known credentials, keyed by the type.' + GetCredentialsList: + title: GetCredentialsList + type: object + properties: + CredentialType: + type: string + description: Specifies the type of credentials to return + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a list of all credentials of the specified type. + GetAgentTaskStatuses: + title: GetAgentTaskStatuses + type: object + properties: + Ids: + type: array + items: + type: integer + format: int32 + x-nullable: false + description: Specifies the task ids. + PolicyRunId: + type: integer + description: Specifies the policy run id. + format: int32 + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + SubmitAgentTasks: + title: SubmitAgentTasks + type: object + properties: + Tasks: + type: array + items: + $ref: '#/components/schemas/AgentTask' + description: Specifies the list of tasks that will be submitted. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a list of tasks for the given agent. + AgentTask: + title: AgentTask + type: object + properties: + Id: + type: integer + description: Specifies the task id. + format: int32 + x-nullable: false + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + GroupNames: + type: array + items: + type: string + description: A list of names the agent device was a member of when the task was defined. + AgentTaskType: + type: string + description: Specifies the agent task type. + PolicyTemplateName: + type: string + description: Specifies the policy template name. Only relevant for certain types of report execution tasks for which it preserves a trace of the source policy name the report is based on. + PolicyTemplateSignature: + type: string + description: Specifies the policy template signature. In combination with the 'PolicyTemplateName' this is used by agents that hold a local cache of report definitions to determine whether the cached version is up to date.. + Text: + type: string + description: Specifies the text of the task command. + Command: + type: string + description: Specifies the agent task command - this is an abbreviated form of the Text above with just the command and parameters but no XML + PolicyRunId: + type: integer + description: Specifies run id (a collection of related tasks ids across multiple agent/devices) if party of a scheduled polocy run + format: int32 + x-nullable: false + SendProgressEveryNSeconds: + type: integer + description: Specifies whether task progress updates are sent every N seconds. A value of zero indicates no percentage progress values are sent. + format: int32 + x-nullable: false + Status: + type: string + description: 'Specifies the status, ''in progress'', ''complete'' etc. See ''AgentTaskStatus''.' + StatusMessage: + type: string + description: 'Specifies the additional status message, if any.' + StatusUpdatedUtc: + type: string + description: Specifies the utc time the status of the task was updated. + format: date-time + x-nullable: false + AgentTaskCreationDateUtc: + type: string + description: Specifies the utc time the task was created. + format: date-time + x-nullable: false + ResultData: + type: string + description: Specifies the result data. + StartDate: + type: string + description: Specifies the start date after which this task is active. If null the task will be picked up by the agent immediately. + format: date-time + EndDate: + type: string + description: Specifies the end date after which this task is no longer active. If null the task will be picked up by the agent whenever it calls in for new tasks. + format: date-time + ResultDataItems: + type: array + items: + $ref: '#/components/schemas/AgentDataItem' + description: Specifies the result data items. + ExternalResultDataItemsFileId: + type: string + description: Specifies the external file id (used if the ResultDataItems above exceeds 16mb) + ReplyByUtc: + type: string + description: Specifies the Utc time by which a reply must be received. Mainly used for report tasks which will be expired when the next run is started. Null if no specific reply-by time + format: date-time + ReportItemId: + type: string + description: Specifies the scheduled report item Id that this task is associated with. Only applicable to report execution tasks. + ReportInstanceId: + type: string + description: Specifies the scheduled report instance Id that this task is associated with. Only applicable to report execution tasks. + description: An agent task. + DownloadFileHashBinary: + title: DownloadFileHashBinary + type: object + properties: + ReturnUrl: + type: boolean + description: Specifies a flag that indicates wether or not to return a URL or the file directly + x-nullable: false + HostType: + type: string + description: 'Specifies the host type the file hash binary is required for (e.g Unix, Windows etc)' + OperatingSystem: + type: string + description: Specifies the operating system naame (as defined in KnownOsNames). Optional + Variant: + type: string + description: 'Specifies the operating system / host variant. e.g x64, 10 SPARC etc' + FileId: + type: string + description: Specifies the specific file id + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Download the filehasing utility app for remote monitoring. + GetFileHashBinaries: + title: GetFileHashBinaries + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves the list of file hash binaries available to download from the hub. + GetPlannedChangeInstanceMembers: + title: GetPlannedChangeInstanceMembers + required: + - InstanceId + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the group and device members of the specified planned change instance. + DeletePlannedChangeInstance: + title: DeletePlannedChangeInstance + required: + - InstanceId + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + DeletePlannedChange: + type: boolean + description: Delete the 'parent' planned change also? + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes an instance of a planned change from the system. + DeletePlannedChangeInstanceMember: + title: DeletePlannedChangeInstanceMember + required: + - InstanceId + type: object + properties: + GroupName: + type: string + description: Specifies the group to remove from the planned change. + AgentDeviceId: + type: string + description: Specifies individual device remove from the planned change. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Removes a group or device from a planned change + AddPlannedChangeInstance: + title: AddPlannedChangeInstance + type: object + properties: + PlannedChangeName: + type: string + description: 'Specifies the planned change definition name. Optional, if not supplied a new empty planned change ruleset is created and returned in the response.' + DisplayName: + type: string + description: Specifies the DisplayName. Required. + Description: + type: string + description: Specifies the description. Required. + AssignedTo: + type: string + description: Specifies the Assigned To Name. + Origin: + type: string + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when created by sync service.' + MemberGroups: + type: array + items: + type: string + description: Specifies the groups that are members of the planned change. Optional. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies the devices that are explicit members of the planned change. Optional. + StartTimeUtc: + type: string + description: Specifies the UTC start time of the instance. Optional. + format: date-time + EndTimeUtc: + type: string + description: Specifies the UTC end time of the instance. Optional. + format: date-time + PeriodicityCount: + type: integer + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + format: int32 + x-nullable: false + PeriodicityUnit: + type: string + description: Specifies a value indicating the periodicity unit. + PeriodDurationCount: + type: integer + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + format: int32 + x-nullable: false + PeriodDurationUnit: + type: string + description: Specifies a value indicating the period duration unit. + Disabled: + type: boolean + description: Specifies a value indicating whether to create the planned change instance in a disabled state. + x-nullable: false + DisallowRules: + type: boolean + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + x-nullable: false + UseAttributeRules: + type: boolean + description: 'TODO: How do we deal with this? TEMP used to trigger the new file hash based attribute rule generation. Eventually this will be the norm and this property can be removed.' + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a planned change instance. + UpdatePlannedChangeInstance: + title: UpdatePlannedChangeInstance + required: + - InstanceId + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Description: + type: string + description: Specifies the description. Optional. + PlannedChangeName: + type: string + description: Specifies the id (Name) of the ruleset used by this planned change. Optional. + AssignedTo: + type: string + description: Specifies the Assigned To Name. + MemberGroups: + type: array + items: + type: string + description: Specifies the groups that are members of the planned change. Optional. + StartTimeUtc: + type: string + description: Specifies the UTC start time of the instance. Optional. + format: date-time + EndTimeUtc: + type: string + description: Specifies the UTC end time of the instance. Optional. + format: date-time + Started: + type: boolean + description: Specifies a value indicating whether the planned change has been started. Optional. + Ended: + type: boolean + description: Specifies a value indicating whether the planned change has been ended. Optional. + Disabled: + type: boolean + description: Specifies a value indicating whether the planned change instance is disabled. Optional. + DisallowRules: + type: boolean + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events. Optional.' + PeriodicityCount: + type: integer + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + format: int32 + PeriodicityUnit: + type: string + description: Specifies a value indicating the periodicity unit. + PeriodDurationCount: + type: integer + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + format: int32 + PeriodDurationUnit: + type: string + description: Specifies a value indicating the period duration unit. + DisplayName: + type: string + description: Specifies the Display Name. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies the devices that are explicit members of the planned change. Optional. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update a planned change instance + ClonePlannedChangeInstance: + title: ClonePlannedChangeInstance + required: + - InstanceId + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + CloneDefinition: + type: boolean + description: Specifies the whether to clone the associated PlannedChangeDefinition + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Clone a planned change instance. + GetPlannedChangeInstancesNameValue: + title: GetPlannedChangeInstancesNameValue + type: object + properties: + InstanceIds: + type: array + items: + type: string + description: Specifies the instance id. Optional. + MemberGroups: + type: array + items: + type: string + description: Specifies the member groups to filter by. This is a list of groups that are members of the planned changes instances returned. Optional. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies the ids of member devices. + Description: + type: string + description: Specifies the planned change instance description to find. Optional. + PlannedChangeName: + type: string + description: Specifies the planned change definition name to find instances of. Optional. + DisplayName: + type: string + description: Specifies the planned change display name to find instances of. Optional. + DisplayNameContains: + type: string + description: Specifies the planned change instance name fragment to find. Optional. + ExcludeDisabled: + type: boolean + description: 'Specifies a value indicating whether to exclude disabled instances from the list. Optional, defaults to false.' + x-nullable: false + ExcludeOutOfSchedule: + type: boolean + description: 'Specifies a value indicating whether to exclude instances whose schedule is not currently active from the list. Optional, defaults to false.' + x-nullable: false + DisallowRules: + type: boolean + description: Specifies an optional value indicating whether the planned change instances returned are allowed to have rules. + StartDateUtc: + type: string + description: Gets or sets the Date/Time of the start date UTC of the Planned Changes to be returned. + format: date-time + EndDateUtc: + type: string + description: Gets or sets the Date/Time of the end date UTC of the Planned Changes to be returned. + format: date-time + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + AddPlannedChangeInstanceMember: + title: AddPlannedChangeInstanceMember + required: + - InstanceId + type: object + properties: + MemberGroups: + type: array + items: + type: string + description: Specifies names of groups of devices to add to the planned change. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies individual device ids to add to the planned change. + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a list of groups to a planned change + AddOrUpdatePlannedChangeInstanceFromEvents: + title: AddOrUpdatePlannedChangeInstanceFromEvents + required: + - InstanceId + type: object + properties: + AllEventsSelected: + type: boolean + description: Indicates that the All Events option has been selected. + x-nullable: false + EventsQuery: + $ref: '#/components/schemas/GetEvents' + Name: + type: string + description: Specifies the name of the 'PlannedChangeDefinition' to create. + UpdateExisting: + type: boolean + description: Specifies the flag indicating whether or not we're updating an existing planned change + x-nullable: false + UseMinimumRules: + type: boolean + description: Specifies a value indicating whether to use the minimum possible number rules to match the items. + x-nullable: false + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + MemberGroups: + type: array + items: + type: string + description: Specifies the groups that are members of the planned change. Optional. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies the devices that are explicit members of the planned change. Optional. + ReconsiderEventsFromUtc: + type: string + description: Specifies the UTC time to reconsider matching events from. If null no events are reprocessed. + format: date-time + RuleBuilderItems: + type: array + items: + $ref: '#/components/schemas/RuleBuilderItem' + description: Specifies the events that make up the initial filter rules of the new 'PlannedChangeInstance'. The matching 'PlannedChangeFilterRuleInferenceOptions' provide details about how the event filter rule is to be constructed. + PreviewOnly: + type: boolean + description: Specifies a value indicating whether to preview the settings for the resulting 'PlannedChangeInstance' or to really created it + x-nullable: false + EndDateUtc: + type: string + description: Specifies the UTC end date for the new PlannedChangeInstance. If this is null the PlannedChangeInstance is open-ended. + format: date-time + Origin: + type: string + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to add a new planned change and planned change instance based on the given events. + RuleBuilderItem: + title: RuleBuilderItem + type: object + properties: + EventType: + type: string + description: Specifies the event type of the events in 'EventIds'. Default if not specified is 'DeviceEvent'. + EventIds: + type: array + items: + type: string + description: Specifies the event ids. + PlannedChangeFilterRuleInferenceOptions: + $ref: '#/components/schemas/PlannedChangeFilterRuleInferenceOptions' + description: Rule Builder containing Events and Planned Change Filter Rule Options + PlannedChangeFilterRuleInferenceOptions: + title: PlannedChangeFilterRuleInferenceOptions + type: object + properties: + FilterByTracker: + type: boolean + description: Specifies a value indicating whether to filter by tracker. + x-nullable: false + FilterByItemType: + type: boolean + description: Specifies a value indicating whether to filter by item type. + x-nullable: false + FilterByItemValue: + type: boolean + description: Specifies a value indicating whether to filter by item value. + x-nullable: false + FilterByAttribute: + type: boolean + description: Specifies a value indicating whether to filter by item attribute. + x-nullable: false + ItemValueTextMatchOperator: + type: string + description: Specifies the item value text match operator. + ItemValueCaseSensitive: + type: boolean + description: Specifies a value indicating whether item value matches are case sensitive. + x-nullable: false + ItemValueToMatch: + type: string + description: Specifies the item value to match. + description: The filter rule inference options specify how to create a planned change filter rule from a Device Event + AddReEvaluationOfPlannedChangeInstanceEvents: + title: AddReEvaluationOfPlannedChangeInstanceEvents + required: + - InstanceId + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + EarliestEventTimeUtc: + type: string + description: Specifies the earliest UTC event time. This is the time of earliest events to re-consider for retrospective inclusion in the planned change. + format: date-time + LastEventTimeUtc: + type: string + description: Specifies the latest UTC event time. This is the time of the last events to re-consider for retrospective inclusion in the planned change. + format: date-time + PlannedChangeManual: + type: boolean + description: Indicates whether to further restrict the event query to events that were either added to the planned change manually or not (i.e. were added by a rule) + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to re-evaluate the events associated with the specified planned change. + GetPlannedChangeInstances: + title: GetPlannedChangeInstances + type: object + properties: + InstanceIds: + type: array + items: + type: string + description: Specifies the instance id. Optional. + MemberGroups: + type: array + items: + type: string + description: Specifies the member groups to filter by. This is a list of groups that are members of the planned changes instances returned. Optional. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies the ids of member devices. + Description: + type: string + description: Specifies the planned change instance description to find. Optional. + PlannedChangeName: + type: string + description: Specifies the planned change definition name to find instances of. Optional. + DisplayName: + type: string + description: Specifies the planned change display name to find instances of. Optional. + DisplayNameContains: + type: string + description: Specifies the planned change instance name fragment to find. Optional. + ExcludeDisabled: + type: boolean + description: 'Specifies a value indicating whether to exclude disabled instances from the list. Optional, defaults to false.' + x-nullable: false + ExcludeOutOfSchedule: + type: boolean + description: 'Specifies a value indicating whether to exclude instances whose schedule is not currently active from the list. Optional, defaults to false.' + x-nullable: false + DisallowRules: + type: boolean + description: Specifies an optional value indicating whether the planned change instances returned are allowed to have rules. + OmitPlannedChangeDefinitions: + type: boolean + description: 'Specifies an optional value indicating whether to omit returning the PlannedChangeDefinition on the returned PlannedChangeInstance, useful if you only want a list of instances without the potentially large definitions embedded.' + x-nullable: false + OmitExceptKeyValue: + type: boolean + x-nullable: false + StartDateUtc: + type: string + description: Gets or sets the Date/Time of the start date UTC of the Planned Changes to be returned. + format: date-time + EndDateUtc: + type: string + description: Gets or sets the Date/Time of the end date UTC of the Planned Changes to be returned. + format: date-time + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets planned change instances, filtering by name, id or groups that are members.' + AddPlannedChange: + title: AddPlannedChange + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + Name: + type: string + description: Specifies the internally identifying name. + DisplayName: + type: string + description: Specifies the display name. + Description: + type: string + description: Specifies the description text. + Origin: + type: string + description: 'Specifies the origin of the planned change ruleset. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + CreationDateUtc: + type: string + description: Specifies the UTC creation date of the planned change. + format: date-time + x-nullable: false + LastModifiedDateUtc: + type: string + description: Specifies the UTC last modified date of the planned change. + format: date-time + x-nullable: false + DisallowRules: + type: boolean + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + x-nullable: false + Rules: + $ref: '#/components/schemas/Dictionary_String_PlannedChangeRule_' + RuleCombinationOperator: + type: string + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the'Rules'. + description: Add a planned change definition. + PlannedChangeRule: + title: PlannedChangeRule + type: object + properties: + RuleType: + type: string + description: Specifies the rule type. + Id: + type: string + description: Specifies the rule id. Unique within the context of the 'PlannedChange'. + Name: + type: string + description: Specifies the name. Optional. + Order: + type: integer + description: Specifies the order id governing order of evaluation of the rules. + format: int32 + x-nullable: false + TrackerTypeName: + type: string + description: Specifies the tracker type name. + ItemTypeName: + type: string + description: Specifies the item type name. + NameMatchText: + type: string + description: Specifies the name match text. + NameMatchOperator: + type: string + description: Specifies the name match operator. + NameMatchCaseSensitive: + type: boolean + description: Specifies a value indicating whether the name match is case sensitive. + x-nullable: false + NameMatchTextLowered: + type: string + description: Specifies the 'NameMatchText' in lowered case. + NameMatchTextUsingCaseSensitivity: + type: string + description: Gets the name match text using case sensitivity. + Description: + type: string + description: Gets the description. + ListFilterAttribute: + type: string + description: 'When the RuleType is ListFilter, specifies the name of the attribute used as the source for comparison with the List' + ListFilterSeparator: + type: string + description: Gets or sets the list filter separators. + List: + type: array + items: + type: string + description: 'When the RuleType is a ListFilter, specifies the list of List Filter Attribute values used as the source for comparison when the rule is evaluated.' + description: Represents a rule specifying a requirement that an event be of a particular type. + Dictionary_String_PlannedChangeRule_: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + UploadPlannedChange: + title: UploadPlannedChange + type: object + properties: + OverwriteIfExists: + type: boolean + description: Specifies a flag to indicate wether or not to overwrite the planned change ruleset if it already exists + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Upload a planned change ruleset json file + DownloadPlannedChange: + title: DownloadPlannedChange + type: object + properties: + Id: + type: string + description: Specifies the planned change rule set id + IncludeAttributeRuleList: + type: boolean + description: Specifies whether to return the List property for attribute list rules. Defaults to false. + x-nullable: false + IncludeAttributeRuleText: + type: boolean + description: Specifies whether to return the list in the MatchText property for attribute list rules. Defaults to true. + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Download a planned change ruleset json file + UpdatePlannedChange: + title: UpdatePlannedChange + type: object + properties: + Name: + type: string + description: Specifies the internal Name identifying the planned change. This cannot be updated. + DisplayName: + type: string + description: Specifies the display name. + Description: + type: string + description: Specifies the description text. + RuleCombinationOperator: + type: string + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the 'PlannedChangeDefinition.Rules'. + DisallowRules: + type: boolean + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + Rules: + $ref: '#/components/schemas/Dictionary_String_PlannedChangeRule_' + Origin: + type: string + description: 'Specifies the origin of the planned change update. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when updated by sync service.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update a planned change definition + ClonePlannedChange: + title: ClonePlannedChange + type: object + properties: + Name: + type: string + description: Specifies the internal Name identifying the planned change to clone. This cannot be updated. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Clone a planned change definition. + AnalyzePlannedChange: + title: AnalyzePlannedChange + type: object + properties: + Name: + type: string + description: Specifies the planned change Name. This cannot be updated. + ReduceRuleIds: + type: array + items: + type: string + description: Specifies the list of rule ids to be automatically reduced to the minimum set to catch at least the same events. For example two exact name matches of files in the same directory will be reduced to one rule that matches any file in the directory. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + ApplyPlannedChangePlan: + title: ApplyPlannedChangePlan + type: object + properties: + Name: + type: string + description: Specifies the planned change Name. This cannot be updated. + RuleIdsToRemove: + type: array + items: + type: string + description: Specifies the rule ids to remove. + RuleReductionPlan: + $ref: '#/components/schemas/RuleReductionPlan2' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + RuleReductionPlan2: + title: RuleReductionPlan2 + type: object + properties: + Count: + type: integer + description: Gets or sets the count. + format: int32 + x-nullable: false + Rules: + type: array + items: + $ref: '#/components/schemas/PlannedChangeRule' + description: Gets or sets the Planned Change rules. + description: Rule Reduction Plan containing Planned Change Rules + UpdatePlannedChangeRule: + title: UpdatePlannedChangeRule + type: object + properties: + PlannedChangeName: + type: string + Rule: + $ref: '#/components/schemas/PlannedChangeRule' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Updates a rule in a planned change + UpdatePlannedChangeRules: + title: UpdatePlannedChangeRules + type: object + properties: + PlannedChangeName: + type: string + description: Specifies the planned change definition name. + Rules: + $ref: '#/components/schemas/Dictionary_String_PlannedChangeRule_' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Updates the entire rule set in a planned change + DeletePlannedChangeRule: + title: DeletePlannedChangeRule + type: object + properties: + PlannedChangeName: + type: string + description: Specifies the planned change definition name. + Id: + type: string + description: Specifies the rule id. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Removes a rule from a planned change + DeletePlannedChange: + title: DeletePlannedChange + type: object + properties: + Name: + type: string + description: Specifies the planned change ruleset definition name to remove. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Delete a planned change ruleset definition from the system. + AddPlannedChangeRule: + title: AddPlannedChangeRule + type: object + properties: + PlannedChangeName: + type: string + description: Specifies the name of the planned change to which the new rule will be added. + Rule: + $ref: '#/components/schemas/PlannedChangeRule' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a rule to a planned change + GetPlannedChanges: + title: GetPlannedChanges + type: object + properties: + Name: + type: string + description: Specifies the planned change definition name to find. + DisplayName: + type: string + description: Specifies the planned change display name to find. + DisplayNameContains: + type: string + description: Specifies the partial planned change display name to find. + DisallowRules: + type: boolean + description: Specifies an optional value indicating whether the planned changes returned are allowed to have rules. + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + ParseCommands: + title: ParseCommands + type: object + properties: + CommandLines: + type: array + items: + type: string + description: Specifies the command line + CheckGlobalWhiteList: + type: boolean + x-nullable: false + ParserNames: + type: array + items: + type: string + ReportTemplateName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + CreateWhitelistedCommandComponent: + title: CreateWhitelistedCommandComponent + type: object + properties: + ComponentType: + type: string + Value: + type: string + Language: + type: string + Comment: + type: string + IsTrusted: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Attempts to whitelist the supplied command component. + GetWhitelistedCommandComponent: + title: GetWhitelistedCommandComponent + type: object + properties: + Value: + type: string + ComponentType: + type: string + Language: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the whitelisted command component. + GetAllWhitelistedCommandComponents: + title: GetAllWhitelistedCommandComponents + type: object + properties: + ValueSearchText: + type: string + ComponentTypes: + type: array + items: + type: string + x-nullable: false + LanguageNames: + type: array + items: + type: string + TemplateNames: + type: array + items: + type: string + IncludeUntrustedOnly: + type: boolean + x-nullable: false + ExcludeUntrusted: + type: boolean + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Attempts to get all the whitelisted command components. + UpdateWhitelistedCommandComponent: + title: UpdateWhitelistedCommandComponent + type: object + properties: + Id: + type: string + Value: + type: string + Language: + type: string + Comment: + type: string + IsTrusted: + type: boolean + TrustChangeReason: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Attempts to update the supplied command component by id. + UpdateWhitelistedCommandComponents: + title: UpdateWhitelistedCommandComponents + type: object + properties: + Ids: + $ref: '#/components/schemas/IReadOnlyCollection_String_' + IsTrusted: + type: boolean + x-nullable: false + TrustChangeReason: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Attempts to bulk update the whitelisted command component with the supplied ids. + IReadOnlyCollection_String_: + title: IReadOnlyCollection`1 + type: object + description: IReadOnlyCollection + AddTemplatesToCommandComponent: + title: AddTemplatesToCommandComponent + type: object + properties: + TemplateNames: + type: array + items: + type: string + CommandComponentId: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds the given template(s) to a command component. + RemoveTemplatesFromCommandComponent: + title: RemoveTemplatesFromCommandComponent + type: object + properties: + TemplateNames: + type: array + items: + type: string + CommandComponentId: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Attempts to remove the given template(s) from a command component. + GetAllCommandComponentTemplates: + title: GetAllCommandComponentTemplates + type: object + properties: + CommandComponentId: + type: string + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets all templates of a command component. + GetAllCommandComponentsTemplates: + title: GetAllCommandComponentsTemplates + type: object + properties: + CommandComponentIds: + $ref: '#/components/schemas/IReadOnlyCollection_String_' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets all templates of multiple command components. + SetAllTemplatesOfCommandComponent: + title: SetAllTemplatesOfCommandComponent + type: object + properties: + TemplateNames: + type: array + items: + type: string + CommandComponentId: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Attempts to set the given template(s) to a command component, clearing old templates if they exist.' + GetCloudTemplateCreationStatus: + title: GetCloudTemplateCreationStatus + type: object + properties: + ProspectiveName: + type: string + description: Specifies the prospective name of a Cloud System so that a check can be made to determine if any of the components already exist + ReportSpecId: + type: string + description: Specifies the id of the ReportSpecification representing this scheduled cloud report + IncludeIfHidden: + type: boolean + description: Whether or not the report associated with the ReportSpecification id will get found if it's in a hidden state + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. + SetupPolicyTemplate: + title: SetupPolicyTemplate + type: object + properties: + PolicyTemplateName: + type: string + description: Specifies the policy template name + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + GetPolicyTemplateCreationStatus: + title: GetPolicyTemplateCreationStatus + type: object + properties: + PolicyTemplateName: + type: string + description: Specifies the policy template name to query + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + AddPolicyTemplate: + title: AddPolicyTemplate + type: object + properties: + Template: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + UsageTags: + type: array + items: + type: string + description: 'Specifies the policy usages type to store on the Template e.g. Baseline, Tracking etc...' + ChangeComment: + type: string + description: Specifies a short description of the change for auditing purposes. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a device config template. + PolicyTemplateRuleSet: + title: PolicyTemplateRuleSet + type: object + properties: + RuleSetName: + type: string + RuleSetVersion: + type: string + RuleSetEdited: + type: string + Summary: + type: string + Variables: + type: array + items: + $ref: '#/components/schemas/InputVariableType' + Section: + type: array + items: + $ref: '#/components/schemas/SectionType' + AutoNumber: + type: boolean + x-nullable: false + Version: + type: integer + description: Gets the version. + format: int32 + x-nullable: false + Config: + $ref: '#/components/schemas/DeviceConfiguration' + Name: + type: string + description: Specifies the name. + DisplayName: + type: string + description: Specifies the display name. + UpdatedDateUtc: + type: string + description: Specifies the UTC date the template was updated. + format: date-time + x-nullable: false + UsageTags: + $ref: '#/components/schemas/UsageTagsType' + Audit: + $ref: '#/components/schemas/AuditType' + description: Represents a named policy tracking configuration and rule-set template. + InputVariableType: + title: InputVariableType + type: object + properties: + Item: + $ref: '#/components/schemas/BaseValueType' + DataExtraction: + $ref: '#/components/schemas/DataExtractionType' + PostProcessing: + $ref: '#/components/schemas/PostProcessingType' + Name: + type: string + Description: + type: string + DataType: + type: string + DataItemsUsed: + type: string + description: InputVariableType + BaseValueType: + title: BaseValueType + type: object + description: BaseValueType + DataExtractionType: + title: DataExtractionType + type: object + properties: + Regex: + $ref: '#/components/schemas/RegexType' + description: DataExtractionType + RegexType: + title: RegexType + type: object + properties: + IgnoreCase: + type: boolean + x-nullable: false + Value: + type: string + description: RegexType + PostProcessingType: + title: PostProcessingType + type: object + properties: + RegexReplace: + $ref: '#/components/schemas/RegexType' + RegexReplacements: + $ref: '#/components/schemas/PostProcessingTypeRegexReplacements' + TokenReplacements: + $ref: '#/components/schemas/PostProcessingTypeTokenReplacements' + MissingValueReplacement: + $ref: '#/components/schemas/PostProcessingTypeMissingValueReplacement' + ConvertSDDLToReadable: + type: boolean + x-nullable: false + TrimValue: + type: boolean + x-nullable: false + RemoveEmptyValues: + type: boolean + x-nullable: false + RemoveChars: + type: string + ListSeparator: + type: string + ChangeCase: + type: string + ChangeCaseSpecified: + type: boolean + x-nullable: false + description: PostProcessingType + PostProcessingTypeRegexReplacements: + title: PostProcessingTypeRegexReplacements + type: object + properties: + Replace: + type: array + items: + $ref: '#/components/schemas/PostProcessingTypeRegexReplacementsReplace' + description: PostProcessingTypeRegexReplacements + PostProcessingTypeRegexReplacementsReplace: + title: PostProcessingTypeRegexReplacementsReplace + type: object + properties: + From: + type: string + To: + type: string + description: PostProcessingTypeRegexReplacementsReplace + PostProcessingTypeTokenReplacements: + title: PostProcessingTypeTokenReplacements + type: object + properties: + TokenNames: + type: string + description: PostProcessingTypeTokenReplacements + PostProcessingTypeMissingValueReplacement: + title: PostProcessingTypeMissingValueReplacement + type: object + properties: + Substitute: + type: string + description: PostProcessingTypeMissingValueReplacement + SectionType: + title: SectionType + type: object + properties: + TextPara: + type: array + items: + $ref: '#/components/schemas/TextParaType' + Category: + type: array + items: + $ref: '#/components/schemas/SectionTypeCategory' + Name: + type: string + Number: + type: string + description: SectionType + TextParaType: + title: TextParaType + type: object + properties: + Icon: + type: string + Title: + type: string + Value: + type: string + description: TextParaType + SectionTypeCategory: + title: SectionTypeCategory + type: object + properties: + TextPara: + type: array + items: + $ref: '#/components/schemas/TextParaType' + SubCategory: + type: array + items: + $ref: '#/components/schemas/SectionTypeCategorySubCategory' + Name: + type: string + Number: + type: string + description: SectionTypeCategory + SectionTypeCategorySubCategory: + title: SectionTypeCategorySubCategory + type: object + properties: + TextPara: + type: array + items: + $ref: '#/components/schemas/TextParaType' + Rule: + type: array + items: + $ref: '#/components/schemas/RuleType' + Name: + type: string + Number: + type: string + description: SectionTypeCategorySubCategory + RuleType: + title: RuleType + type: object + properties: + Description: + type: string + InputVariableRef: + type: array + items: + type: string + InputVariableSource: + type: array + items: + $ref: '#/components/schemas/RuleTypeInputVariableSource' + InputVariable: + type: array + items: + $ref: '#/components/schemas/InputVariableType' + RuleExpression: + type: array + items: + $ref: '#/components/schemas/RuleExpressionType' + ResultText: + $ref: '#/components/schemas/RuleTypeResultText' + Number: + type: string + Name: + type: string + NoExpansionOfEnvironmentVariables: + type: boolean + x-nullable: false + RuleExpressionPassesRequired: + type: string + ScoreType: + type: integer + format: int32 + x-nullable: false + Severity: + type: string + description: RuleType + RuleTypeInputVariableSource: + title: RuleTypeInputVariableSource + type: object + properties: + Name: + type: string + Value: + type: string + description: RuleTypeInputVariableSource + RuleExpressionType: + title: RuleExpressionType + type: object + properties: + UsageTags: + $ref: '#/components/schemas/UsageTagsType' + Rule: + type: string + ShowFailuresExpression: + type: string + FailuresExpression: + type: string + FailuresExpressionMaxChars: + type: integer + format: int32 + x-nullable: false + ShowPassesExpression: + type: string + PassesExpression: + type: string + PassesExpressionMaxChars: + type: integer + format: int32 + x-nullable: false + AllowMissingDataInNamedVariables: + type: string + description: RuleExpressionType + UsageTagsType: + title: UsageTagsType + type: object + properties: + UsageTag: + type: array + items: + type: string + x-nullable: false + description: UsageTagsType + RuleTypeResultText: + title: RuleTypeResultText + type: object + properties: + GeneralPreamble: + type: string + ShowGeneralPreamble: + type: string + FailuresSeparator: + type: string + FailuresPreamble: + type: string + ShowFailuresPreamble: + type: string + PassesSeparator: + type: string + NewlineToken: + type: string + PassesPreamble: + type: string + ShowPassesPreamble: + type: string + EndSummary: + type: string + ShowEndSummary: + type: string + GeneralPreambleExpanded: + type: string + PassesPreambleExpanded: + type: string + FailuresPreambleExpanded: + type: string + description: RuleTypeResultText + DeviceConfiguration: + title: DeviceConfiguration + type: object + properties: + Version: + type: integer + description: Gets the version. + format: int32 + x-nullable: false + FilePathMatches: + type: array + items: + $ref: '#/components/schemas/FilePathMatch' + description: Specifies the file path matches. + RegistryPathMatches: + type: array + items: + $ref: '#/components/schemas/RegistryPathMatch' + description: Specifies the registry path matches. + Name: + type: string + description: Specifies the name. This is usually set to the same name as its parent 'DeviceTemplate'. + RegistryTrackerChangesFilters: + type: array + items: + $ref: '#/components/schemas/RegistryTrackerChangesFilter' + description: Gets or sets the registry tracker changes filters + FileTrackerChangesFilters: + type: array + items: + $ref: '#/components/schemas/FileTrackerChangesFilter' + description: Gets or sets the file tracker changes filters. + FileSystemTracker: + $ref: '#/components/schemas/FileSystemTracker' + DatabaseTracker: + $ref: '#/components/schemas/DatabaseTracker' + RegistryTracker: + $ref: '#/components/schemas/RegistryTracker' + ProcessTracker: + $ref: '#/components/schemas/ProcessTracker' + InstalledSoftwareTracker: + $ref: '#/components/schemas/InstalledSoftwareTracker' + SecurityPolicyTracker: + $ref: '#/components/schemas/SecurityPolicyTracker' + ProcessOutputTracker: + $ref: '#/components/schemas/ProcessOutputTracker' + FileContentTracker: + $ref: '#/components/schemas/FileContentTracker' + WindowsAccountTracker: + $ref: '#/components/schemas/WindowsAccountTracker' + NetworkPortTracker: + $ref: '#/components/schemas/NetworkPortTracker' + SplunkTracker: + $ref: '#/components/schemas/SplunkTracker' + AgentTracker: + $ref: '#/components/schemas/AgentTracker' + NotificationRefId: + type: string + description: 'Specifies a value indicating the default NotificationRefId for the template, used for future trackers' + description: The device tracker configuration applied to a device via a Device Template + FilePathMatch: + title: FilePathMatch + type: object + properties: + Name: + type: string + description: Gets or sets the name. + Description: + type: string + description: Gets or sets the description. + FolderMatchType: + type: string + description: Gets or sets the type of the folder match. + FolderMatchExpression: + type: string + description: Gets or sets the folder match expression. + FileMatchType: + type: string + description: Gets or sets the type of the file match. + FileMatchExpression: + type: string + description: Gets or sets the file match expression. + RecursionLevel: + type: integer + description: 'Specifies the level of recursion into subfolders. Zero means none, ie tracking this folder only, one means one level down etc.' + format: int32 + x-nullable: false + SkipRootFolder: + type: boolean + description: Gets or sets a value indicating whether the skip root folder. + x-nullable: false + IsSystem: + type: boolean + description: 'Specifies a value indicating whether this is a system item, or local to the template.' + x-nullable: false + description: The file path match represents the path match specifications for a file. + RegistryPathMatch: + title: RegistryPathMatch + type: object + properties: + Name: + type: string + description: Gets or sets the name of the Registry Path Match. + Description: + type: string + description: Gets or sets the description of the Registry Path Match. + KeyMatchType: + type: string + description: Gets or sets the type of the key match. + KeyMatchExpression: + type: string + description: Gets or sets the key match expression. + ValueMatchType: + type: string + description: Gets or sets the type of the value match. + ValueMatchExpression: + type: string + description: Gets or sets the value match expression. + RecursionLevel: + type: integer + description: Gets or sets the recursion level. + format: int32 + x-nullable: false + SkipRootKey: + type: boolean + description: Gets or sets a value indicating whether to skip the root key. + x-nullable: false + IsSystem: + type: boolean + description: 'Specifies a value indicating whether this is a system item, or local to the template.' + x-nullable: false + description: The registry path match represents the path match specifications for a registry key and values. + RegistryTrackerChangesFilter: + title: RegistryTrackerChangesFilter + type: object + properties: + Name: + type: string + description: Specifies the name of the group of filter settings. + Description: + type: string + description: Specifies the description of the group of filter settings. + WatchRegKey: + type: boolean + description: Specifies a value indicating whether to report changes to registry keys. + x-nullable: false + DataValue: + type: boolean + description: Specifies a value indicating whether to report changes to registry key values. + x-nullable: false + DataType: + type: boolean + description: Specifies a value indicating whether to report changes to registry key data types. + x-nullable: false + Security: + type: boolean + description: Specifies a value indicating whether to report changes to security descriptor. + x-nullable: false + IsSystem: + type: boolean + description: 'Specifies a value indicating whether this is a system item, or local to the template.' + x-nullable: false + description: The registry tracker changes filter represents the types of changes to registry keys and values to be monitored. + FileTrackerChangesFilter: + title: FileTrackerChangesFilter + type: object + properties: + Name: + type: string + description: Specifies the name of the group of filter settings. + Description: + type: string + description: Specifies the description of the group of filter settings. + WatchDirectories: + type: boolean + description: Specifies a value indicating whether to report changes to directories. + x-nullable: false + WatchFiles: + type: boolean + description: Specifies a value indicating whether to report changes to files. + x-nullable: false + Created: + type: boolean + description: Specifies a value indicating whether to report changes to created date and time. + x-nullable: false + Length: + type: boolean + description: Specifies a value indicating whether to report changes to file length (ignored for directories). + x-nullable: false + DataStreams: + type: boolean + description: Specifies a value indicating whether to report changes to datastreams. + x-nullable: false + LastAccess: + type: boolean + description: Specifies a value indicating whether to report changes to last access date and time. + x-nullable: false + LastWrite: + type: boolean + description: Specifies a value indicating whether to report changes to last write date and time. + x-nullable: false + FileName: + type: boolean + description: Specifies a value indicating whether to report changes to file names. + x-nullable: false + DirectoryName: + type: boolean + description: Specifies a value indicating whether to report changes to directory names. + x-nullable: false + Attributes: + type: boolean + description: 'Specifies a value indicating whether to report changes to file attributes (readonly, archive, hidden etc).' + x-nullable: false + Security: + type: boolean + description: Specifies a value indicating whether to report changes to security descriptor. + x-nullable: false + Content: + type: boolean + description: Specifies a value indicating whether to report changes to file content. + x-nullable: false + IsSystem: + type: boolean + description: 'Specifies a value indicating whether this is a system item, or local to the template.' + x-nullable: false + All: + type: boolean + description: Gets or sets a value indicating whether to use all filters + x-nullable: false + description: The file tracker changes filter represents the types of changes to files and folders to be monitored. + FileSystemTracker: + title: FileSystemTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + Name: + type: string + description: Gets or sets the name of the File System Tracker. + Description: + type: string + description: ' Gets or sets the description of the File System Tracker.' + FolderDetails: + type: array + items: + $ref: '#/components/schemas/FolderDetail' + description: Gets or sets the folder details. + FolderExcludes: + type: array + items: + $ref: '#/components/schemas/FolderExclude' + description: Specifies the folder excludes. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether the send baseline data. + x-nullable: false + description: The file system tracker specifies file tracker settings in a Device Configuration + TrackerSchedule: + title: TrackerSchedule + type: object + properties: + StartDateUtc: + type: string + description: Gets or sets the start date UTC. + format: date-time + PeriodMinutes: + type: integer + description: Gets or sets the period minutes. + format: int32 + x-nullable: false + Description: + type: string + description: Gets the Tracker Schedule description. + description: The tracker schedule specifies tracker schedule in a Device Configuration + FolderDetail: + title: FolderDetail + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_FolderDetail_' + FilterName: + type: string + description: 'Specifies the filter name. If this is set and ''FileTrackerChangesFilter'' is not set, the FilterName is assumed to be a reference to a system defined match. If FileTrackerChangesFilter is set and FilterName not set, the FileTrackerChangesFilter is assumed to be specific to this FolderDetail and will be stored with a system created unique name.' + Hashing: + type: string + description: Gets or sets the hashing. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + Path: + type: string + description: ' Gets or sets the full pathname of the file.' + PathMatchName: + type: string + description: 'Specifies the path match name. If this is set and ''FilePathMatch'' is not set, the PathMatchName is assumed to be a reference to a system defined match. If FilePathMatch is set and PathMatchName not set, the FilePathMatch is assumed to be specific to this FolderDetail and will be stored with a system created unique name.' + FilePathMatch: + $ref: '#/components/schemas/FilePathMatch' + IsSystemDefinedPathMatch: + type: boolean + description: Specifies a value indicating whether the 'FilePathMatch' is system defined. + x-nullable: false + FileTrackerChangesFilter: + $ref: '#/components/schemas/FileTrackerChangesFilter' + IsSystemDefinedChangesFilter: + type: boolean + description: Specifies a value indicating whether is system defined changes filter. + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: The folder detail specifies details of a folder to track in a Device Configuration + IEqualityComparer_FolderDetail_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + FolderExclude: + title: FolderExclude + type: object + properties: + Path: + type: string + description: 'Gets or sets the full pathname of the file. ' + PathMatchName: + type: string + description: 'Specifiesthe path match name. If this is set and ''FilePathMatch'' is not set, the PathMatchName is assumed to be a reference to a system defined match. If FilePathMatch is set and PathMatchName not set, the FilePathMatch is assumed to be specific to this FolderDetail and will be stored with a system created unique name.' + FilePathMatch: + $ref: '#/components/schemas/FilePathMatch' + IsSystemDefinedPathMatch: + type: boolean + description: Specifies a value indicating whether the 'FilePathMatch' is system defined. + x-nullable: false + description: A folder exclude. + DatabaseTracker: + title: DatabaseTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + Name: + type: string + description: Gets or sets the Database Tracker name. + Description: + type: string + description: Gets or sets the description. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + TrackUserAccounts: + type: boolean + description: Gets or sets a value indicating whether to track user accounts. + x-nullable: false + TrackUserRoles: + type: boolean + description: Gets or sets a value indicating whether to track user roles. + x-nullable: false + TrackSchemas: + type: boolean + description: Gets or sets a value indicating whether to track schemas. + x-nullable: false + DatabasePlatform: + type: string + description: Gets or sets the database platform. + Instances: + type: array + items: + $ref: '#/components/schemas/DatabaseInstanceTracked' + description: Gets or sets the database instances to be tracked. + description: The database tracker specifies database settings in a Device Configuration + DatabaseInstanceTracked: + title: DatabaseInstanceTracked + type: object + properties: + DatabasePlatform: + type: string + description: Specifies the database platform. + CredentialsKey: + type: string + description: Specifies the credentials key. + VersionNumber: + type: number + description: Specifies the database platform version number. + format: float + x-nullable: false + IgnoreCase: + type: boolean + description: Specifies a value indicating whether to ignore case in object names etc. + x-nullable: false + Databases: + type: array + items: + $ref: '#/components/schemas/DatabaseTracked' + description: Gets the databases. + Name: + type: string + description: Specifies the Name. This is a name to use in the user interface and doesn't necessarily need to match the server or instance name as these are typically held in the data provided via the 'CredentialsKey' lookup. + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Describes the tracking options on a specific database instance on a single server. + DatabaseTracked: + title: DatabaseTracked + type: object + properties: + Name: + type: string + description: Gets or sets the database tracker name. + Instance: + $ref: '#/components/schemas/DatabaseInstanceTracked' + TableMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: '>Gets or sets the table matches.' + UserMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: Gets or sets the user matches. + ConfigItemMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: Gets or sets the configuration item matches. + ViewMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: Gets or sets the view matches. + TriggerMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: Gets or sets the trigger matches. + ProcedureMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: Gets or sets the procedure matches. + AuditOptionMatches: + type: array + items: + $ref: '#/components/schemas/InclusionItemMatch' + description: Gets or sets the audit option matches. + description: Specifies the database tracker settings. + InclusionItemMatch: + title: InclusionItemMatch + type: object + properties: + IncludedIfMatches: + type: boolean + description: summary + x-nullable: false + ItemMatchPattern: + type: string + description: Gets or sets the item match pattern. + ItemMatchType: + type: string + description: Gets or sets the type of the item match. + CaseSensitive: + type: boolean + description: Gets or sets a value indicating whether the match is case sensitive. + x-nullable: false + description: summary + RegistryTracker: + title: RegistryTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + Name: + type: string + description: Gets or sets the Registry Tracker name. + Description: + type: string + description: Gets or sets the Registry Tracker description. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + RegKeyDetails: + type: array + items: + $ref: '#/components/schemas/RegKeyDetail' + description: Gets or sets the reg key details. + RegKeyExcludes: + type: array + items: + $ref: '#/components/schemas/RegKeyExclude' + description: Specifies the folder excludes. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + description: The registry tracker specifies registry tracker settings in a DeviceConfiguration. + RegKeyDetail: + title: RegKeyDetail + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_RegKeyDetail_' + FilterName: + type: string + description: 'Specifies the filter name. If this is set and ''FileTrackerChangesFilter'' is not set, the FilterName is assumed to be a reference to a system defined match. If FileTrackerChangesFilter is set and FilterName not set, the FileTrackerChangesFilter is assumed to be specific to this FolderDetail and will be stored with a system created unique name.' + Path: + type: string + description: Gets or sets the path. + PathMatchName: + type: string + description: 'Specifies the path match name. If this is set and ''RegistryPathMatch'' is not set, the PathMatchName is assumed to be a reference to a system defined match. If RegistryPathMatch is set and PathMatchName not set, the RegistryPathMatch is assumed to be specific to this RegKeyDetail and will be stored with a system created unique name.' + RegistryPathMatch: + $ref: '#/components/schemas/RegistryPathMatch' + IsSystemDefinedPathMatch: + type: boolean + description: Specifies a value indicating whether the 'RegistryPathMatch' is system defined. + x-nullable: false + RegistryTrackerChangesFilter: + $ref: '#/components/schemas/RegistryTrackerChangesFilter' + IsSystemDefinedChangesFilter: + type: boolean + description: Specifies a value indicating whether is system defined changes filter. + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: The Reg Key detail specfies details of a Reg Key to track in a Device Configuration + IEqualityComparer_RegKeyDetail_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + RegKeyExclude: + title: RegKeyExclude + type: object + properties: + Path: + type: string + description: Gets or sets the path. + PathMatchName: + type: string + description: 'Specifies the path match name. If this is set and ''RegistryPathMatch'' is not set, the PathMatchName is assumed to be a reference to a system defined match. If RegistryPathMatch is set and PathMatchName not set, the RegistryPathMatch is assumed to be specific to this RegKeyExclude and will be stored with a system created unique name.' + RegistryPathMatch: + $ref: '#/components/schemas/RegistryPathMatch' + IsSystemDefinedPathMatch: + type: boolean + description: Specifies a value indicating whether the 'RegistryPathMatch' is system defined. + x-nullable: false + description: summary + ProcessTracker: + title: ProcessTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + LogWhiteListedActivity: + type: boolean + description: Gets or sets a value indicating whether to log white listed activity. + x-nullable: false + ReportUnCategorised: + type: boolean + description: Gets or sets a value indicating whether to report uncategorised Processes + x-nullable: false + ReportChanges: + type: boolean + description: Specifies a value indicating whether to report process and service start-stop change events. Setting this true means the tracker will alert on every process and service start and stop event. + x-nullable: false + Processes: + type: array + items: + $ref: '#/components/schemas/Process' + description: Gets or sets a list of processes. + Services: + type: array + items: + $ref: '#/components/schemas/Service' + description: Gets or sets a list of services. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Tracker for Processes + Process: + title: Process + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_Process_' + Name: + type: string + description: Gets or sets the Process name. + Category: + type: string + description: Gets or sets the category. + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: ' Represents an expected process state as tracked by the Process Tracker' + IEqualityComparer_Process_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + Service: + title: Service + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_Service_' + Name: + type: string + description: Gets or sets the Service name. + State: + type: string + description: Gets or sets the Service's state. + StartMode: + type: string + description: Gets or sets the start mode. + Caption: + type: string + description: Gets or sets the caption. + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Represents an expected service state as tracked by the Process Tracker + IEqualityComparer_Service_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + InstalledSoftwareTracker: + title: InstalledSoftwareTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: '>Gets or sets a value indicating whether to send baseline data.' + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Tracker for Installed Software + SecurityPolicyTracker: + title: SecurityPolicyTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Tracker for Security Policies + ProcessOutputTracker: + title: ProcessOutputTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + ProcessOutput: + type: array + items: + $ref: '#/components/schemas/ProcessOutput' + description: Gets or sets the process output. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data + x-nullable: false + description: Tracker for Process Output + ProcessOutput: + title: ProcessOutput + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_ProcessOutput_' + Name: + type: string + description: Gets or sets the Process Output name. + CommandLine: + type: string + description: Gets or sets the command line. + CommandLineScript: + type: string + description: 'Gets or sets the multi-line command script, when CommandType is PowerShellScript.' + CommandType: + type: string + description: Gets or sets the type of the command. + RegularExpression: + type: string + description: Gets or sets the regular expression. + RegularExpressionIgnoreCase: + type: boolean + description: Gets or sets a value indicating whether a regular expression will ignore case + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Represents a process output as tracked by the Process Output Tracker + IEqualityComparer_ProcessOutput_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + FileContentTracker: + title: FileContentTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + Name: + type: string + description: Gets or sets the name + Description: + type: string + description: Gets or sets the description. + Files: + type: array + items: + $ref: '#/components/schemas/File' + description: Gets or sets the files. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: 'Gets or sets a value indicating whether the send baseline data. ' + x-nullable: false + description: he file content tracker specifies file content settings in a Device Configuration + File: + title: File + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_File_' + RegularExpressionIgnoreCase: + type: boolean + description: Specifies a value indicating whether the regular expression should ignore case. + x-nullable: false + RegularExpression: + type: string + description: Specifies the regular expression. Optional. + Path: + type: string + description: Specifies the path to the file to be tracked. + Name: + type: string + description: 'Specifies the name. Identifies the meaning of the file, e.g. ''web application configuration file'', or where a ''RegularExpression'' is specified this name can be used to identify the part of the file that is being extracted. E.g. ''Apache release version''.' + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: ' Represents a file tracked by the File Content Tracker' + IEqualityComparer_File_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + WindowsAccountTracker: + title: WindowsAccountTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + TrackingStyle: + type: string + description: Gets or sets the tracking style. + TrackDomainControllerAccounts: + type: boolean + description: Gets or sets a value indicating whether to track domain controller accounts. + x-nullable: false + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: Tracker for Windows Accounts + NetworkPortTracker: + title: NetworkPortTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + Description: + type: string + description: Gets or sets the description for the network port tracker. + PortIncludes: + type: array + items: + $ref: '#/components/schemas/PortRangeDetail' + description: Specifies the port include ranges. + PortExcludes: + type: array + items: + $ref: '#/components/schemas/PortRangeDetail' + description: Specifies the port exclude ranges. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + description: The network ports tracker specifies port tracker settings in a Device Configuration + PortRangeDetail: + title: PortRangeDetail + type: object + properties: + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_PortRangeDetail_' + Start: + type: integer + description: Specifies the port range start. + format: int32 + x-nullable: false + End: + type: integer + description: Specifies the port range end. + format: int32 + x-nullable: false + Description: + type: string + description: Specifies the description. + Protocols: + type: string + description: Specifies the protocols. + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + description: The port range detail specfies details of a port range to track or exclude in a Device Configuration + IEqualityComparer_PortRangeDetail_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + SplunkTracker: + title: SplunkTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + SplunkQuery: + type: array + items: + $ref: '#/components/schemas/SplunkQuery' + description: Gets or sets the search queries. + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data + x-nullable: false + description: Tracker for Splunk integration + SplunkQuery: + title: SplunkQuery + type: object + properties: + Name: + type: string + description: Gets or sets the Splunk name. + SearchQuery: + type: string + description: Gets or sets the Splunk Search Query. + NotificationRefId: + type: array + items: + type: string + description: Specifies a value indicating the template(s) the tracked entity was present in + CompareExcludingNotificationRefId: + $ref: '#/components/schemas/IEqualityComparer_SplunkQuery_' + description: Represents a Splunk Query as tracked by the Splunk Tracker + IEqualityComparer_SplunkQuery_: + title: IEqualityComparer`1 + type: object + description: IEqualityComparer + AgentTracker: + title: AgentTracker + type: object + properties: + Schedule: + $ref: '#/components/schemas/TrackerSchedule' + TrackingStyle: + type: string + description: Gets or sets the tracking style. + SendBaselineData: + type: boolean + description: Gets or sets a value indicating whether to send baseline data. + x-nullable: false + description: The agent tracker returns the current state of the agent. + AuditType: + title: AuditType + type: object + properties: + Edit: + type: array + items: + $ref: '#/components/schemas/EditType' + description: AuditType + EditType: + title: EditType + type: object + properties: + Change: + type: array + items: + $ref: '#/components/schemas/ChangeType' + UserName: + type: string + Date: + type: string + format: date-time + x-nullable: false + NewVersion: + type: string + Comment: + type: string + description: EditType + ChangeType: + title: ChangeType + type: object + properties: + Type: + type: string + Item: + type: string + Detail: + type: string + Value: + type: string + description: ChangeType + GetMostRecentPolicyResults: + title: GetMostRecentPolicyResults + type: object + properties: + UsageTag: + type: string + description: Restricts the results returned to compliance policies marked with the specified UsageTagsApplicable. + GroupName: + type: string + description: Specifies the group name. + ExcludePoliciesWithNoDevices: + type: boolean + description: Restricts the results returned to policies run on groups containing at least one device. + x-nullable: false + ExcludePoliciesNotSetup: + type: boolean + description: Baselines only - excludes policies not yet fully setup from the results. + x-nullable: false + ExcludePoliciesWithNoResults: + type: boolean + description: Baselines only - excludes policies with no results in the time period from the results. + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the most recent policy run results for each matching policy in the time range. + AddPolicyTemplateRules: + title: AddPolicyTemplateRules + type: object + properties: + Name: + type: string + description: Specifies the policy template name to add rules to + AddDeviceInformationRule: + type: boolean + description: Specifies whether to add the device information section at the start of the report + x-nullable: false + ChangeComment: + type: string + description: Specifies a short description of the change for auditing purposes. + PreviewChanges: + type: boolean + description: Specifies if the rule changes should only be previewed and not saved to the template. + x-nullable: false + ProposedChanges: + type: array + items: + $ref: '#/components/schemas/ProposedPolicyChange' + StartUtc: + type: string + description: 'Gets or sets the start of the period to return events for, null implies all.' + format: date-time + ApplyProcessPortRange: + type: boolean + x-nullable: false + RuleOptions: + type: array + items: + $ref: '#/components/schemas/RuleBuilderOptions' + description: Specifies any Rule Builder Options. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a rules to a baseline policy based on events + ProposedPolicyChange: + title: ProposedPolicyChange + type: object + properties: + ChangeType: + type: string + EventFilter: + $ref: '#/components/schemas/EventFilter' + Id: + type: string + description: Specifies the rule result id to base the new rule on. + MissingValuePasses: + type: boolean + description: Specifies if the generated rule will pass if the associated data item is empty e.g. software not installed or file missing. + x-nullable: false + ExtendExistingRule: + type: boolean + description: Specifies if the rule should be extended or replaced. + x-nullable: false + AddNoOthersRule: + type: boolean + description: Specifies if a No Others rule is added + x-nullable: false + PortProcEphemeralRange: + type: boolean + description: 'Specifies if true, that only ports in the ephemeral range opened by known processes are allowed' + x-nullable: false + NoOthersRuleTrackerName: + type: string + description: Specifies the tracker name associated with a No Others Rule + NoOthersRuleTrackerItemType: + type: string + description: Specifies the tracker type associated with a No Others Rule + description: ProposedPolicyChange + RuleBuilderOptions: + title: RuleBuilderOptions + type: object + properties: + TrackerTypeName: + type: string + ItemTypeName: + type: string + AttributeTypeNames: + type: array + items: + type: string + OneAttributePerRule: + type: boolean + x-nullable: false + OneValuePerRule: + type: boolean + x-nullable: false + ExtendExistingRule: + type: boolean + x-nullable: false + RulePassExpression: + type: string + RuleFailureExpression: + type: string + AllowMissingDataInVariable: + type: boolean + x-nullable: false + RuleName: + type: string + MissingValuePasses: + type: boolean + x-nullable: false + DataExtractionRegex: + type: string + CaseInsensitiveRule: + type: boolean + x-nullable: false + ScoreType: + type: integer + format: int32 + x-nullable: false + Severity: + type: string + NetworkPortRangeStart: + type: integer + format: int32 + x-nullable: false + NetworkPortRangeEnd: + type: integer + format: int32 + x-nullable: false + UseProcessPortRange: + type: boolean + x-nullable: false + Name: + type: string + IgnoreMissingValuePassesForIsApplicable: + type: boolean + x-nullable: false + description: RuleBuilderOptions + AddPolicyTemplateXml: + title: AddPolicyTemplateXml + type: object + properties: + Name: + type: string + description: Specifies the name. + Xml: + type: string + description: Specifies the xml. + PassMark: + type: number + description: Specifies the pass mark. Only relevant for 'TemplateType' of 'PolicyTemplateType.ComplianceReport'. + format: double + x-nullable: false + AsCopyOf: + type: string + description: Specifies as a copy of an existing template named this + CopyTemplateValues: + type: boolean + description: 'Specifies a copy of an existing template should only copy the tracking information, not the values' + x-nullable: false + AsCopyOfVersion: + type: string + description: Specifies version to copy when using AsCopyOf + AdditionalUsageTags: + type: array + items: + type: string + x-nullable: false + description: 'Specifies extra UsageTagsApplicable to record against the template, in addition to those specified in the Xml' + OverwriteIfExists: + type: boolean + description: Specifies a flag to indicate whether or not not overwrite the report / config if it already exists + x-nullable: false + ExternalDataFileId: + type: string + description: Specifies an external file id if the XML is not provided 'in line' + IsSystem: + type: boolean + description: Specifies a flag to indicate whether or not the template is part of the standard system set or a customized version + x-nullable: false + IsUiUpload: + type: boolean + description: Specifies a flag to indicate whether or not the template is has been uploaded from the UI + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a device policy template to the system. The specified template should be supplied as Xml. + DeletePolicyTemplate: + title: DeletePolicyTemplate + type: object + properties: + Name: + type: string + description: Specifies the policy template name to delete + TemplateVersion: + type: string + description: 'Specifies the policy template version to delete. Optional, if not supplied all versions of the template are removed.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + UploadPolicyTemplate: + title: UploadPolicyTemplate + type: object + properties: + Name: + type: string + description: Specifies the name. + PassMark: + type: number + description: Specifies the pass mark. Only relevant for 'TemplateType' of 'PolicyTemplateType.ComplianceReport'. + format: double + x-nullable: false + OverwriteIfExists: + type: boolean + description: Specifies a flag to indicate whether or not to overwrite the report / config if it already exists + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Upload a policy template file + GetPolicyTemplateAsFile: + title: GetPolicyTemplateAsFile + type: object + properties: + Name: + type: string + description: Specifies the templatem name to retrieve. + AgentDeviceId: + type: string + description: Specifies the agent device id to get the current combined template for. Note either this or the 'Name' should be specified. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Returns a policy template as an xml file in the Http Response stream. + GetAgentProcesses: + title: GetAgentProcesses + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + StartAgentTracker: + title: StartAgentTracker + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentDeviceId: + type: string + description: Specifies the agent id the tracker will be started on. Alternative to AgentDevice. + TrackerName: + type: string + description: Specifies the tracker to be started + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Ask an agent to start a specified tracker. + GetAgentServices: + title: GetAgentServices + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + SetActivePolicyTemplate: + title: SetActivePolicyTemplate + type: object + properties: + TemplateName: + type: string + description: Specifies the template name. + ActiveVersion: + type: string + description: Specifies the version of the template to make active. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Sets a specific version of a named policy template as the active one. + UpdatePolicyTemplates: + title: UpdatePolicyTemplates + type: object + properties: + Name: + type: string + description: Specifies the name (id) to search for. + NameContains: + type: string + description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. + ReturnXml: + type: boolean + description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. + x-nullable: false + ReturnSignatures: + type: boolean + description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. + x-nullable: false + IsActive: + type: boolean + description: Get the Active version of a template + IsLatest: + type: boolean + description: Get the Latest version of a template + HasRules: + type: boolean + description: Get templates with Rules + HasTrackers: + type: boolean + description: Get templates with Trackers + TemplateTrackerTypes: + type: array + items: + type: string + description: Specifies the template's tracker types. + TemplateVersion: + type: string + description: Specifies the template version to get. + UsageTags: + type: array + items: + type: string + description: Specifies the policy usage types to get. + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update matching config templates. + GetDeviceConfigTemplate: + title: GetDeviceConfigTemplate + type: object + properties: + Name: + type: string + description: Specifies the template name. + IncludeSystemFilters: + type: boolean + description: Specifies a value indicating whether to include system defined filters and path match definitions. + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a named device config template. + GetDeviceConfigTemplateNames: + title: GetDeviceConfigTemplateNames + type: object + properties: + TrackersContained: + type: array + items: + type: string + description: Specifies the trackers contained. Optional. If specified this filters the returned list of template names to include only those containing the named trackers (eg 'processtracker'). + AgentDeviceIds: + type: array + items: + type: string + description: 'Specifies the agent devices. Optional. If specified this filters the returned list of template names to include only those currently applied to ALL the listed devices due to their group memberships, i.e. an intersection of group membership sets.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + AddDeviceConfigProcessRules: + title: AddDeviceConfigProcessRules + type: object + properties: + DeviceTemplateName: + type: string + description: The name of the device tracking configuration template + Rules: + type: array + items: + $ref: '#/components/schemas/Process' + description: A list of all the Rules + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + GetGroupPolicy: + title: GetGroupPolicy + type: object + properties: + GroupName: + type: string + description: Specifies the group name. Optional. + GroupNames: + type: array + items: + type: string + description: Specifies the group names. Optional. + PolicyTemplateName: + type: string + description: Specifies the policy template name. Optional. + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the configured config policy template for the specified group or by individual template name. + GetGroupPolicyConfigNames: + title: GetGroupPolicyConfigNames + type: object + properties: + GroupNames: + type: array + items: + type: string + description: Specifies the list of group names to get the config for + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the configured config policy template names for the specified groups. + AddGroupPolicy: + title: AddGroupPolicy + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + VersionString: + type: string + GroupName: + type: string + description: Specifies the group name. + GroupDisplayName: + type: string + description: Specifies the group display name. + PolicyTemplateName: + type: string + description: Specifies the policy template name. + PolicyTemplateDisplayName: + type: string + description: Specifies the policy template display name. + IsTrusted: + type: boolean + description: Specifies if policy template contains trusted commands. + description: Adds a config template to a group. + DeleteGroupPolicy: + title: DeleteGroupPolicy + type: object + properties: + GroupName: + type: string + description: Specifies the group name to delete the policy from. + PolicyTemplateName: + type: string + description: Specifies the policy template name to remove from the group. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Removes a config template from a group. + ReParentDevices: + title: ReParentDevices + type: object + properties: + Devices: + type: array + items: + type: string + description: A list of agent device IDs to be re-parented. + AgentDeviceId: + type: string + description: The agent device id to re-parent the devices to. + MigrateEvents: + type: boolean + description: A boolean that controls wether to migrate any 'old' events to the new agent device id combination. + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Re-parents the given devices to the specified Agent. + ExportAgents: + title: ExportAgents + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + ExportFormat: + type: string + description: Specifies the export format + ReportTitle: + type: string + description: Specifies the title for the report + TimeZoneId: + type: string + description: Specifies the timezone id to do the export in + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Export a list of agent details. + GetAgentsRanked: + title: GetAgentsRanked + type: object + properties: + EventCountsDateUtc: + type: string + format: date-time + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + GetAgentGroupDetails: + type: boolean + description: Specifies a value indicating whether to get agent group details. + x-nullable: false + GetRelatedCredentials: + type: boolean + description: Specifies a value indicating whether to get related credentials. + x-nullable: false + GetRelatedPlannedChanges: + type: boolean + description: Specifies a value indicating whether to get related planned changes. + x-nullable: false + GetRelatedTemplates: + type: boolean + description: Specifies a value indicating whether to get templates applied to the returned agents. + x-nullable: false + IncludeMasterInFilter: + type: boolean + description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return agents matching the device filter. + GroupMembers: + title: GroupMembers + type: object + properties: + GroupName: + type: string + description: The name of the group to query. + MemberType: + type: string + description: Specifies the member type to return (AgentDevice or Group). + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return group members matching the criteria. + GetGroups: + title: GetGroups + type: object + properties: + Name: + type: string + description: The internal name of the group to find. + DisplayName: + type: string + description: The display name of the group to find. + DisplayNameContains: + type: string + description: A fragment of the display name in the groups to find. + UserName: + type: string + description: The alternative user name to retrieve groups for. Note that the returned list will also be filtered by the visibility of groups the authenticated user has. + MemberOf: + type: array + items: + type: string + description: 'The groups of which the returned groups must be a member. If null, members of any group can be returned, if an empty list only groups which are members of no groups (i.e. have no parent) are returned.' + OnlyGroupsWithUpdate: + type: boolean + description: Gets or sets the a flag indicating whether to only return groups with an agent update scheduled. + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return groups matching the criteria. + GetGroupsTree: + title: GetGroupsTree + type: object + description: Gets a tree structure representing the groups hierarchy. + DeleteGroup: + title: DeleteGroup + type: object + properties: + Name: + type: string + description: Gets or sets the Group Matching Name. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to delete a group matching the criteria. + AddGroup: + title: AddGroup + required: + - GroupType + type: object + properties: + ParentGroupName: + type: string + description: Optionally specifies a parent group for the new group. If this is not supplied the group is automatically added as a child of the root 'All Devices' group unless NoParent is set + DisplayName: + type: string + description: Specifies the display name of the new group + GroupType: + enum: + - None + - UserContainer + - DeviceContainer + - GroupContainer + type: int + description: Specifies the type of members allowed in the new group. Can be a combination of the allowed values + format: int32 + IsSystem: + type: boolean + description: Specifies a flag indicating if this is a 'system' group or not + x-nullable: false + Members: + type: array + items: + type: string + description: Specifies the list of ids of 'child group' members of the new group + RiskScore: + type: string + description: Specifies the risk score of the group. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a new Group definition. + UpdateGroup: + title: UpdateGroup + required: + - Name + type: object + properties: + Name: + type: string + description: Specifies the name of the group to update + DisplayName: + type: string + description: Specifies the new display name of the group + Members: + type: array + items: + type: string + description: Specifies the list of 'child group' members + RiskScore: + type: string + description: Specifies the risk score of the group + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Updates a Group definition. + DeleteDevices: + title: DeleteDevices + type: object + properties: + AgentDeviceIds: + type: array + items: + type: string + description: 'The agent device ids to delete from their current groups, moving them to the Deleted group.' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + GetOverdueDevices: + title: GetOverdueDevices + required: + - OfflineSeconds + type: object + properties: + OfflineSeconds: + type: integer + description: Specifies the number of seconds the offline device must have been offline for. + format: int32 + x-nullable: false + MemberOfGroups: + type: array + items: + type: string + description: Specifies optional list of groups the devices must be a member of. + NotMemberOfGroups: + type: array + items: + type: string + description: Specifies optional list of groups the devices must not be a member of. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets devices that have not polled in for the specified amount of time. + DeleteDevicePermanently: + title: DeleteDevicePermanently + type: object + properties: + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupName: + type: string + description: Specifies the group name. + Response: + type: string + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + ReRegisterDevice: + title: ReRegisterDevice + type: object + properties: + AgentDeviceIds: + type: array + items: + type: string + description: Specifies the list of combined agent and device ids. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to re-register a list of previously deleted devices matching the criteria. + DeleteGroupMembersPermanently: + title: DeleteGroupMembersPermanently + type: object + properties: + GroupName: + type: string + description: Specifies the group name. + Response: + type: string + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + AddDeviceFilter: + title: AddDeviceFilter + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to add a DeviceFilter. + UpdateDeviceFilter: + title: UpdateDeviceFilter + type: object + properties: + Name: + type: string + description: Specifies the name of the device filter to update. + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to update a DeviceFilter matching the given id. + PromoteDeviceFilter: + title: PromoteDeviceFilter + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + DeleteDeviceFilter: + title: DeleteDeviceFilter + type: object + properties: + Name: + type: string + description: Specifies the name of the device filter to delete. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to delete a DeviceFilter matching the criteria. + GetDeviceFilters: + title: GetDeviceFilters + type: object + properties: + NameContains: + type: string + description: Specifies text to search for in the filter Name + Name: + type: string + description: Specifies an exact filter Name to search for + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + AddGroupMembers: + title: AddGroupMembers + type: object + properties: + GroupName: + type: string + description: The internal name/id of the group to add to. + Groups: + type: array + items: + type: string + description: The names of groups to add to the parent. + Agents: + type: array + items: + $ref: '#/components/schemas/Agent' + description: The Agents to add to the parent. + AgentDeviceIds: + type: array + items: + type: string + description: The AgentDeviceIds of agents to add to the parent. Used as an alternative to Agents property. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to add the specified Groups and Agents group members to the named group. + DeleteGroupMembers: + title: DeleteGroupMembers + type: object + properties: + GroupName: + type: string + description: The name of the parent group to remove from. + Groups: + type: array + items: + type: string + description: The names of groups to remove from the parent. + AgentDeviceIds: + type: array + items: + type: string + description: The agent device ids to remove from the parent. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to remove group or device members from the named group. + GetDeviceOnlineStatus: + title: GetDeviceOnlineStatus + type: object + properties: + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets an indication of the device's online/offline status + UpdateDeviceSettings: + title: UpdateDeviceSettings + type: object + properties: + AgentId: + type: string + description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. + DeviceId: + type: string + description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. + FileLiveTrackingRequiresBaselineCompletion: + type: boolean + description: Specifies whether a full baseline must be completed before live file tracking can be started. Optional + GroupName: + type: string + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + AddCredentialsToAgentDevice: + title: AddCredentialsToAgentDevice + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + CredentialsKey: + type: string + description: Specifies the credentials key. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to associate named credentials with an agent. + RemoveCredentialsFromAgentDevice: + title: RemoveCredentialsFromAgentDevice + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + CredentialKey: + type: string + description: Specifies the credential key. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to remove named credentials from an agent. + SetAgentDeviceName: + title: SetAgentDeviceName + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + DeviceName: + type: string + description: Specifies the device name. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to update the display name of an agent. + SetAgentHostType: + title: SetAgentHostType + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + HostType: + type: string + description: Specifies the device type. + description: A request to update the host type of an agent. + TestAgentCredentials: + title: TestAgentCredentials + type: object + properties: + AgentDeviceId: + type: string + description: Specifies the agent device id whose credentials are to be tested. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Ask an agent to test the credentials for a device it is proxying. + GetIpBlocking: + title: GetIpBlocking + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets details of ip addresses that have been blocked. + AddIpBlocking: + title: AddIpBlocking + type: object + properties: + IpAddress: + type: string + description: Gets or sets the ip address. + ExpiresUtc: + type: string + description: Gets or sets the expiry date time in UTC. + format: date-time + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds manual blocking of a specified ip address until a specified time. + DeleteIpBlocking: + title: DeleteIpBlocking + type: object + properties: + IpAddress: + type: string + description: Gets or sets the ip address to remove blocking from. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Removes blocking of a specified ip address. + DiscoverDevices: + title: DiscoverDevices + type: object + properties: + DiscoveredDeviceType: + type: string + DiscoveryAgentId: + type: string + MasterAgentId: + type: string + CredentialsKey: + type: string + MergeBehaviour: + type: integer + format: int32 + GroupNameToAssignTo: + type: string + AllowedIpRange: + type: string + MatchAccuracy: + type: integer + format: int32 + x-nullable: false + AssignToGroups: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Discovers devices to be added as proxied devices to a master device. + SubmitDiscoveredDevices: + title: SubmitDiscoveredDevices + type: object + properties: + TaskId: + type: integer + format: int32 + x-nullable: false + MasterAgentDevice: + $ref: '#/components/schemas/AgentDevice' + DiscoveredDevices: + type: array + items: + $ref: '#/components/schemas/DiscoveredDevice' + MergeBehaviour: + type: integer + format: int32 + GroupNameToAssignTo: + type: string + CredentialsKey: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Submits discovered devices as a response to a DiscoverDevices request. + DiscoveredDevice: + title: DiscoveredDevice + type: object + properties: + DiscoveredDeviceType: + type: string + Name: + type: string + IPv4: + type: string + Id: + type: string + MetaData: + $ref: '#/components/schemas/Dictionary_String_String_' + OsUserSpecified: + type: string + KnownOsName: + type: string + HostType: + type: string + GroupNames: + type: array + items: + type: string + description: DiscoveredDevice + AcknowledgeEvents: + title: AcknowledgeEvents + type: object + properties: + EventIds: + type: array + items: + type: string + description: Specifies the event ids to update. + PlannedChangeId: + type: string + description: Specifies the planned change instance id to acknowledge these events under. + NewStatus: + type: string + description: Specifies the new status for the alert events. + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + EventFilter: + $ref: '#/components/schemas/EventFilter' + StartUtc: + type: string + description: 'Gets or sets the start of the period to return events for, null implies all.' + format: date-time + EndUtc: + type: string + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + format: date-time + TextSearch: + type: string + description: Gets or sets the text search value. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Acknowledge a list of events as 'planned'. + ResubmitEvents: + title: ResubmitEvents + type: object + properties: + GetEvents: + $ref: '#/components/schemas/GetEvents' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + GetEventHistory: + title: GetEventHistory + type: object + properties: + EventId: + type: string + description: Specifies the specific event id to retrieve history for. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the event history for one specific event. + GetEventDeviceGroups: + title: GetEventDeviceGroups + type: object + properties: + EventIds: + type: array + items: + type: string + description: ' Gets or sets the event ids.' + Intersection: + type: boolean + description: ' Gets or sets a value indicating whether the returned set of groups is the intersection of the event''s device memberships, if true, or the union. If intersection, only the groups of which all devices are a member are returned.' + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + EventFilter: + $ref: '#/components/schemas/EventFilter' + StartUtc: + type: string + description: 'Gets or sets the start of the period to return events for, null implies all.' + format: date-time + EndUtc: + type: string + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + format: date-time + TextSearch: + type: string + description: Gets or sets the text search value. + GroupFindMode: + type: string + description: Gets or sets how the returned group list is built. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + SetCommentForEvents: + title: SetCommentForEvents + type: object + properties: + GetEvents: + $ref: '#/components/schemas/GetEvents' + Comment: + type: string + description: The comment + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Set comments for events + GetInventory: + title: GetInventory + type: object + properties: + Ids: + type: array + items: + type: string + CpeMatchStatuses: + type: array + items: + type: string + x-nullable: false + CpeName: + type: string + CpeNames: + type: array + items: + type: string + OnlyReturnItemsWithGoodMatchCves: + type: boolean + x-nullable: false + OnlyReturnItemsWithRelatedCves: + type: boolean + x-nullable: false + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of inventory items from the hub service. + VulnerabilityFilter: + title: VulnerabilityFilter + type: object + properties: + CveIds: + type: array + items: + type: string + VulnerabilitySeveritiesV3: + type: array + items: + type: string + description: Specifies the V3 severity levels to search for. + VulnerabilitySeveritiesV2: + type: array + items: + type: string + description: Specifies the V2 severity levels to search for. + V2AccessVector: + type: array + items: + type: string + V3AttackVector: + type: array + items: + type: string + V2AccessComplexity: + type: array + items: + type: string + V3AttackComplexity: + type: array + items: + type: string + V2Authentication: + type: array + items: + type: string + V3PrivilegesRequired: + type: array + items: + type: string + V2AvailabilityImpact: + type: array + items: + type: string + V3AvailabilityImpact: + type: array + items: + type: string + ShowIgnored: + type: boolean + description: Specifies whether to include excluded/suppressed Cves in the response. + x-nullable: false + ShowOnlyIgnored: + type: boolean + description: Specifies whether to *only* include excluded/suppressed Cves in the response. + x-nullable: false + ShowAtHighestRiskLevel: + type: boolean + x-nullable: false + description: VulnerabilityFilter + GetAgentInventoryItemsGrouped: + title: GetAgentInventoryItemsGrouped + type: object + properties: + Ids: + type: array + items: + type: string + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + GetAgentInventoryAgentsDetail: + title: GetAgentInventoryAgentsDetail + type: object + properties: + InventoryItemId: + type: string + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of agents with a specific inventory item id from the hub service. + GetVulnerabilityOverview: + title: GetVulnerabilityOverview + type: object + properties: + CheckPipelineCounts: + type: boolean + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + StartDateUtc: + type: string + description: Specifies the Utc start date from which the vulnerability changes are retrieved. + format: date-time + x-nullable: false + ShowIgnored: + type: boolean + description: Specifies whether to include excluded/suppressed Cves in the overview statistics. + x-nullable: false + GetStatus: + type: boolean + description: Get the vulnerability scanner status as well + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the vulnerability overview matching the device filter. + GetVulnerability: + title: GetVulnerability + type: object + properties: + CheckPipelineCounts: + type: boolean + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + GetSoftwareVulnerability: + title: GetSoftwareVulnerability + type: object + properties: + CheckPipelineCounts: + type: boolean + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + StartDateUtc: + type: string + description: Specifies the Utc start date from which the vulnerability changes are retrieved. + format: date-time + x-nullable: false + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + IncludeAllSoftware: + type: boolean + x-nullable: false + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the software vulnerability matching the device filter. + MarkInventoryItemsRequiringUpdate: + title: MarkInventoryItemsRequiringUpdate + type: object + properties: + CpeNames: + type: array + items: + type: string + InventoryItems: + type: array + items: + $ref: '#/components/schemas/InventoryItem' + InventoryItemIds: + type: array + items: + type: string + ClearExistingCpeCveData: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Marks an inventory item a requiring an update / refresh. + InventoryItem: + title: InventoryItem + type: object + properties: + Id: + type: string + Version: + type: integer + format: int32 + x-nullable: false + ItemVendor: + type: string + ItemName: + type: string + ItemVersion: + type: string + Comment: + type: string + ChangeHistory: + type: array + items: + $ref: '#/components/schemas/InventoryHistory' + IsDeleted: + type: boolean + x-nullable: false + CpeMatchStatus: + type: string + GoodMatchCpeDetail: + $ref: '#/components/schemas/CpeDetail' + RelatedCpeList: + type: array + items: + $ref: '#/components/schemas/CpeDetail' + Cpe23DisplayName: + type: string + LastModifiedDateUtc: + type: string + format: date-time + x-nullable: false + CveNotificationStatus: + type: string + IsOperatingSystemItem: + type: boolean + x-nullable: false + ExtraInfo: + type: string + description: InventoryItem + InventoryHistory: + title: InventoryHistory + type: object + properties: + Code: + type: string + TimeUtc: + type: string + format: date-time + x-nullable: false + User: + type: string + Comment: + type: string + description: InventoryHistory + CpeDetail: + title: CpeDetail + type: object + properties: + MatchStrength: + type: number + format: float + x-nullable: false + CpeName: + type: string + Vendor: + type: string + Product: + type: string + Title: + type: string + CveSummaries: + type: array + items: + $ref: '#/components/schemas/CveSummary' + description: CpeDetail + CveSummary: + title: CveSummary + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + ChangeHistory: + type: array + items: + $ref: '#/components/schemas/CveHistory' + IgnoredUntilDateUtc: + type: string + format: date-time + x-nullable: false + IsIgnored: + type: boolean + x-nullable: false + CveId: + type: string + CpeName: + type: string + V3Severity: + type: string + V2Severity: + type: string + CveChangeDateUtc: + type: string + format: date-time + x-nullable: false + CveDescription: + type: string + NvdDetailsLink: + type: string + V2BaseScore: + type: number + format: float + x-nullable: false + V3BaseScore: + type: number + format: float + x-nullable: false + description: CveSummary + CveHistory: + title: CveHistory + type: object + properties: + Code: + type: string + TimeUtc: + type: string + format: date-time + x-nullable: false + User: + type: string + Comment: + type: string + description: CveHistory + GetSoftwareVulnerabilityDetail: + title: GetSoftwareVulnerabilityDetail + type: object + properties: + ReturnFullCveData: + type: boolean + x-nullable: false + SoftwareId: + type: string + description: Specifies the software item to search for. + CpeName: + type: string + description: Specifies the CPE Name to search for. + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the software vulnerability matching the device filter. + GetDeviceVulnerability: + title: GetDeviceVulnerability + type: object + properties: + CheckPipelineCounts: + type: boolean + x-nullable: false + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + StartDateUtc: + type: string + description: Specifies the Utc start date from which the vulnerability changes are retrieved. + format: date-time + x-nullable: false + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the device vulnerability matching the device filter. + GetDeviceVulnerabilityDetail: + title: GetDeviceVulnerabilityDetail + type: object + properties: + AgentDeviceId: + type: string + description: Specifies the agents to search for by id or group membership. + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the device vulnerability matching the device filter. + GetCvesForRelatedCpes: + title: GetCvesForRelatedCpes + type: object + properties: + CpeName: + type: string + InventoryItemId: + type: string + MaxItemsToReturn: + type: integer + format: int32 + x-nullable: false + ReturnFullCveData: + type: boolean + x-nullable: false + VulnerabilityFilter: + $ref: '#/components/schemas/VulnerabilityFilter' + description: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + GetVulnerableDeviceDetail: + title: GetVulnerableDeviceDetail + type: object + properties: + CveId: + type: string + description: Specifies the cve to search for vulnerable devices. + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the vulnerable devices matching the CVE. + IgnoreCveItem: + title: IgnoreCveItem + type: object + properties: + CveIds: + type: array + items: + type: string + IgnoreUntilUtc: + type: string + format: date-time + CancelIgnore: + type: boolean + x-nullable: false + Comment: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to ignore one or more Cves until a given data. + GetVulnerabilityScanStatus: + title: GetVulnerabilityScanStatus + type: object + properties: + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: A request to return the software vulnerability scan status. + GetAllLog4NetConfigItems: + title: GetAllLog4NetConfigItems + type: object + description: Retrieves a list of log4net logger configurations + AddLog4NetConfigItem: + title: AddLog4NetConfigItem + type: object + properties: + LoggerName: + type: string + LogLevel: + type: string + description: AddLog4NetConfigItem + UpdateLog4NetConfigItem: + title: UpdateLog4NetConfigItem + type: object + properties: + Id: + type: string + LoggerName: + type: string + LogLevel: + type: string + description: UpdateLog4NetConfigItem + DeleteLog4NetConfigItem: + title: DeleteLog4NetConfigItem + type: object + properties: + Id: + type: string + description: DeleteLog4NetConfigItem + GetLog4NetConfigItems: + title: GetLog4NetConfigItems + type: object + properties: + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Retrieves a list of log4net logger configurations with pagination support. + GetReportDescription: + title: GetReportDescription + type: object + properties: + ReportName: + type: string + ConvertToHtml: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Returns a description for the specified report. + GetReportChangeDetails: + title: GetReportChangeDetails + type: object + properties: + ReportIdFrom: + type: string + ReportIdTo: + type: string + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + RuleSetResultEventIdFrom: + type: string + RuleSetResultEventIdTo: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get a list of differences between two reports runs. + GetReportData: + title: GetReportData + type: object + properties: + ReportId: + type: string + CountOnly: + type: boolean + description: A value indicating whether to return a count of results only. + x-nullable: false + Sort: + $ref: '#/components/schemas/Dictionary_String_String_' + Skip: + type: integer + description: The offset into the result set to start at. + format: int32 + Take: + type: integer + description: The limit number of rows to return. + format: int32 + GenericFilters: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + GenericFilterLogic: + type: string + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets report results for the specified agent, device or task id.' + GetAvailableReports: + title: GetAvailableReports + type: object + properties: + DeviceFilter: + $ref: '#/components/schemas/DeviceFilter' + StartDateUtc: + type: string + description: Specifies a start date to search from. + format: date-time + EndDateUtc: + type: string + description: Specifies a start date to search up to. + format: date-time + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: ' Gets a list of available reports for a specified group or agent.' + GetUserDashboard: + title: GetUserDashboard + type: object + properties: + Id: + type: string + description: The identifier of the dashboard to get. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the user dashboard widget layout. + GetUserDashboardByName: + title: GetUserDashboardByName + type: object + properties: + Name: + type: string + description: The name of the dashboard to get. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the user dashboard widget layout by name. + SaveUserDashboard: + title: SaveUserDashboard + type: object + properties: + Id: + type: string + description: 'The identifier of the dashboard to get. If not supplied a new record is created, else existing is updated.' + Name: + type: string + description: The name of the dashboard. + Widgets: + type: array + items: + $ref: '#/components/schemas/DashboardWidgetSpec' + description: The widgets. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Stores the user dashboard widget layout. + DashboardWidgetSpec: + title: DashboardWidgetSpec + type: object + properties: + Title: + type: string + description: The widget title. + Description: + type: string + description: The widget description. + id: + type: string + description: The widget identifier. + dashdata: + $ref: '#/components/schemas/DashData' + x: + type: integer + description: The x-coordinate of the widget. + format: int32 + x-nullable: false + y: + type: integer + description: The y-coordinate of the widget. + format: int32 + x-nullable: false + width: + type: integer + description: The width of the widget. + format: int32 + x-nullable: false + height: + type: integer + description: The height of the widget. + format: int32 + x-nullable: false + description: Details of a dashboard widget in the UI. + DashData: + title: DashData + type: object + properties: + type: + type: string + description: The type of dashboard widget. + groupId: + type: string + description: The group identifier of the widget data. + groupName: + type: string + description: The group display name of the widget data. + tmpl: + type: string + description: The templated title of the widget instance. + timePeriods: + type: integer + description: The number of time periods of the widget data. + format: int32 + x-nullable: false + timePeriodSizeSeconds: + type: integer + description: 'The time period size of the widget data, in seconds.' + format: int32 + x-nullable: false + eventTypes: + type: array + items: + type: string + description: The event types of the widget data. + trackerTypes: + type: array + items: + type: string + description: The tracker types of the widget data. + vulnerabilityChartType: + type: string + vulnerabilityChartText: + type: string + description: Data associated with the specific type of dashboard widget in the UI. + DeleteUserDashboard: + title: DeleteUserDashboard + type: object + properties: + Id: + type: string + description: The identifier of the dashboard to delete. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Deletes the user dashboard widget layout. + GetUserSettings: + title: GetUserSettings + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the user settings and selections. + SaveUserSettings: + title: SaveUserSettings + type: object + properties: + DashboardId: + type: string + description: The user's default dashboard identifier. + ThemeId: + type: string + description: The user's default theme identifier. + HideWelcomePopup: + type: boolean + description: Indicates whether the user has opted to skip the welcome wizard. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Stores the user settings and selections. + GetDashboardWidgets: + title: GetDashboardWidgets + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets the dashboard widgets. + InvalidateEventCounts: + title: InvalidateEventCounts + type: object + properties: + GroupId: + type: string + PeriodIds: + type: array + items: + type: integer + format: int64 + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + TestSmtpConnection: + title: TestSmtpConnection + type: object + properties: + Host: + type: string + Port: + type: integer + format: int32 + x-nullable: false + User: + type: string + Password: + type: string + NoPasswordSupplied: + type: boolean + x-nullable: false + UseSsl: + type: boolean + x-nullable: false + FromEmail: + type: string + RecipientEmail: + type: string + ToUser: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Tests the specified SMTP details. + TestFastConnection: + title: TestFastConnection + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Tests the configured Fast service can be contacted. + TestFastCustomerConnection: + title: TestFastCustomerConnection + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Tests the configured Fast service can be contacted using customer credentials. + TestSyslogConnection: + title: TestSyslogConnection + type: object + properties: + Host: + type: string + Port: + type: integer + format: int32 + x-nullable: false + Protocol: + type: string + SyslogVersion: + type: string + LogglyToken: + type: string + MessagePrefix: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Tests the specified SysLog details. + TestServiceNowConnection: + title: TestServiceNowConnection + type: object + properties: + Host: + type: string + User: + type: string + Password: + type: string + NoPasswordSupplied: + type: boolean + x-nullable: false + IncidentCaller: + type: string + IncidentChannel: + type: string + IncidentLocation: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Tests the specified ServiceNow details. + TestAuditorConnection: + title: TestAuditorConnection + type: object + properties: + Host: + type: string + Port: + type: integer + format: int32 + x-nullable: false + Protocol: + type: string + Route: + type: string + User: + type: string + Password: + type: string + NoPasswordSupplied: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Tests the specified Auditor details. + GetPipelineNodeList: + title: GetPipelineNodeList + type: object + properties: + FromUtc: + type: string + format: date-time + ToUtc: + type: string + format: date-time + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a list of pipeline node names. + AddUser: + title: AddUser + type: object + properties: + UserDetails: + $ref: '#/components/schemas/UserDetails' + Password: + type: string + SkipCheck: + type: boolean + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a user. + UserDetails: + title: UserDetails + type: object + properties: + LastLogonAttemptUtc: + type: string + format: date-time + ChangePasswordByUtc: + type: string + format: date-time + Version: + type: integer + format: int32 + x-nullable: false + Id: + type: integer + format: int32 + x-nullable: false + UserName: + type: string + DateFormats: + $ref: '#/components/schemas/UserDateFormats' + Locked: + type: boolean + x-nullable: false + FirstName: + type: string + SecondName: + type: string + Email: + type: string + Roles: + type: array + items: + type: string + Permissions: + type: array + items: + type: string + Groups: + type: array + items: + type: string + NotificationGroups: + type: array + items: + $ref: '#/components/schemas/GroupAlert' + TimeZoneId: + type: string + TwoFactorRequired: + type: boolean + x-nullable: false + IsInternal: + type: boolean + x-nullable: false + IsADUser: + type: boolean + x-nullable: false + IsOAuthUser: + type: boolean + x-nullable: false + IsSSOUser: + type: boolean + x-nullable: false + GeneratedPassword: + type: string + description: UserDetails + UserDateFormats: + title: UserDateFormats + required: + - Name + - LongDateTimeFormatNet + - ShortDateTimeFormatNet + - LongDateTimeFormatJs + - ShortDateTimeFormatJs + type: object + properties: + Name: + type: string + description: Gets or sets the name for the group of date settings. + LongDateTimeFormatNet: + type: string + description: Gets or sets the long date time format for .net. + ShortDateTimeFormatNet: + type: string + description: Gets or sets the short date time format for .net. + LongDateTimeFormatJs: + type: string + description: Gets or sets the long date time format for js. + ShortDateTimeFormatJs: + type: string + description: Gets or sets the short date time format for js. + description: Specifies the user date format strings both for use in backend .NET code and front end Javascript kendo equivalents. + GroupAlert: + title: GroupAlert + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + Id: + type: string + GroupName: + type: string + GroupDisplayName: + type: string + NotificationTypes: + type: array + items: + type: string + x-nullable: false + NotificationMethod: + type: string + UserName: + type: string + description: The details of how an alert is raised for a group. + GetUserTwoFactorStatus: + title: GetUserTwoFactorStatus + type: object + properties: + UserName: + type: string + Password: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a pre-authentication request to query the user's Two-factor authentication status. Counts as a sign-in attempt. + ElevateUserTwoFactorStatus: + title: ElevateUserTwoFactorStatus + type: object + properties: + OneTimePassword: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a post-authentication request to elevate the user's Two-factor authentication status. Counts as a sign-in attempt. + ValidateUserPassword: + title: ValidateUserPassword + type: object + properties: + UserName: + type: string + CurrentPassword: + type: string + Password: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Validates a user password. + DeleteUser: + title: DeleteUser + type: object + properties: + UserName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Delete a user. + GetUser: + title: GetUser + type: object + properties: + UserName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get a user's details. + UpdateUser: + title: UpdateUser + type: object + properties: + UserDetails: + $ref: '#/components/schemas/UserDetails' + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Updates stored user details. Note that UserManage permissions are required to manage any user other than the caller. + UpdateUserPassword: + title: UpdateUserPassword + type: object + properties: + UserName: + type: string + CurrentPassword: + type: string + Password: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Updates stored user password. CurrentPassword property should contain the password of the user attempting to make the change. Note that UserManage permissions are required to manage any user password other than caller's. + ResetUser: + title: ResetUser + type: object + properties: + UserName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Resets a user. Note that UserManage permissions are required to manage any user other than the caller. + ResetUserPassword: + title: ResetUserPassword + type: object + properties: + UserName: + type: string + NewPassword: + type: string + PreviewToken: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Resets a user password. Note that this operation is intended to manage any user other than the caller. + PreviewResetUserPassword: + title: PreviewResetUserPassword + type: object + properties: + UserName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Generates a reset password for preview without applying it. Pass the returned PreviewToken to resetPassword to apply it. + ResetUser2fa: + title: ResetUser2fa + type: object + properties: + UserName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Resets a user's 2FA . Note that UserManage permissions are required to manage any user other than the caller. + ExportUserNotifications: + title: ExportUserNotifications + type: object + properties: + UserNames: + type: array + items: + type: string + ExportFormat: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Export users and the notifications they are configured to receive + GetTimeZoneIds: + title: GetTimeZoneIds + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a list of possible time zone names. + UserHasChangedPassword: + title: UserHasChangedPassword + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Has the current user changed their password from any system assigned one? + AddGroupAlertToUser: + title: AddGroupAlertToUser + type: object + properties: + UserName: + type: string + GroupName: + type: string + NotificationTypes: + type: array + items: + type: string + x-nullable: false + NotificationMethod: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Add a group alert to a user. + DeleteGroupAlertFromUser: + title: DeleteGroupAlertFromUser + type: object + properties: + UserName: + type: string + description: Specifies the user name to delete group alerts / notifications for. + Id: + type: string + description: Specifies the specific alert / notification to remove. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Remove a group notification from a user + UpdateGroupAlertForUser: + title: UpdateGroupAlertForUser + type: object + properties: + UserName: + type: string + Id: + type: string + GroupName: + type: string + NotificationTypes: + type: array + items: + type: string + x-nullable: false + NotificationMethod: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update a group notification from a user + GetGroupAlertsForGroup: + title: GetGroupAlertsForGroup + type: object + properties: + GroupName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get the configured notifications for the specified group. + GetUserList: + title: GetUserList + type: object + properties: + ExportFormat: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get a list of user names. + ResetAdminPassword: + title: ResetAdminPassword + type: object + properties: + AdminName: + type: string + OrganizationId: + type: integer + format: int32 + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + GetUserRoles: + title: GetUserRoles + type: object + properties: + RoleName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Get a list of user roles defined in the system. + GetPermissions: + title: GetPermissions + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Gets a list of permissions names defined in the system. + AddUserRole: + title: AddUserRole + required: + - DisplayName + - ReadOnly + type: object + properties: + Name: + type: string + description: Specifies the unique internal name for the role. If this is not supplied the DisplayName is used. + DisplayName: + type: string + description: Specifies the display name for the role. + ExternalName: + type: string + description: Specifies the role name in an external identity provider that corresponds to this role. + Permissions: + type: array + items: + type: string + description: Specifies the list of names of permissions associated with the role. + ReadOnly: + type: boolean + description: 'Specifies whether the role is read only, or can be edited.' + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Adds a custom user role + UpdateUserRole: + title: UpdateUserRole + required: + - Name + - DisplayName + - Permissions + type: object + properties: + Name: + type: string + description: Specifies the unique internal name for the role. + DisplayName: + type: string + description: Specifies the display name for the role. + ExternalName: + type: string + description: Specifies the role name in an external identity provider that corresponds to this role. + Permissions: + type: array + items: + type: string + description: Specifies the list of names of permissions associated with the role. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Update a user role + CloneUserRole: + title: CloneUserRole + type: object + properties: + NewRoleName: + type: string + ExistingRoleName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Clone an existing user role. + DeleteUserRole: + title: DeleteUserRole + required: + - Name + type: object + properties: + Name: + type: string + description: Specifies the internal name of the role to delete. + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Delete a user role. + GetLicenseInfo: + title: GetLicenseInfo + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: Represents a request to get an Organization's license info. + UpdateOrganization: + title: UpdateOrganization + type: object + properties: + License: + type: string + description: Specifies the license. + AllowInvalidLicense: + type: boolean + description: Specifies a value indicating whether to allow an invalid license in the License. + x-nullable: false + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Represents a request to update an Organization, used to set the license.' + HasRoleOrPermission: + title: HasRoleOrPermission + type: object + properties: + UserName: + type: string + Roles: + type: array + items: + type: string + Permissions: + type: array + items: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + GetRolesAndPermissions: + title: GetRolesAndPermissions + type: object + properties: + UserName: + type: string + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + Authenticate: + title: Authenticate + type: object + properties: + provider: + type: string + description: 'AuthProvider, e.g. credentials' + UserName: + type: string + Password: + type: string + RememberMe: + type: boolean + AccessToken: + type: string + AccessTokenSecret: + type: string + ReturnUrl: + type: string + ErrorView: + type: string + Meta: + $ref: '#/components/schemas/Dictionary_String_String_' + description: Sign In + GetAccessToken: + title: GetAccessToken + type: object + properties: + RefreshToken: + type: string + Meta: + $ref: '#/components/schemas/Dictionary_String_String_' + description: GetAccessToken + GetAgentPollResponse: + title: GetAgentPollResponse + required: + - Version + type: object + properties: + AgentId: + type: string + description: 'Specifies the agent id. Note: this the agent id excluding the device id.' + DeviceListChangedAtUtc: + type: string + description: Indicates whether the proxied device list has changed since the last poll. + format: date-time + DeviceConfigDateUtc: + $ref: '#/components/schemas/Dictionary_String_Nullable_DateTime__' + Tasks: + type: array + items: + $ref: '#/components/schemas/AgentTask' + description: Returns a list of AgentTasks for all the devices the agent manages. + DiagnosticModeEnabled: + type: boolean + description: Indicates whether additional diagnostics are enabled for this agent. + x-nullable: false + HubCurrentTimeUtc: + type: string + description: 'Indicates the current server time to return to the agent so it can compare with its own and raise a time difference alert. Optional, only returned on initial connect.' + format: date-time + DeviceSettings: + $ref: '#/components/schemas/DeviceSettings' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetAgentPoll + Dictionary_String_Nullable_DateTime__: + title: 'Dictionary>' + type: object + additionalProperties: + type: string + format: date-time + description: 'Dictionary>' + DeviceSettings: + title: DeviceSettings + type: object + properties: + SymlinkFollowCount: + type: integer + description: Specifies a value indicating how many nested symlinks a file tracker should follow. + format: int32 + x-nullable: false + SymlinkFollowCountIsInherited: + type: boolean + description: Indicates whether the property is inherited from a setting on a parent group. + x-nullable: false + RequestCompressionType: + type: string + AgentDeviceId: + type: string + description: 'Specifies the combined agent and device id, for example 1,1. Either AgentId and DeviceId or GroupName must be supplied.' + DiffContextLines: + type: integer + description: Number of context lines in a text difference comparison + format: int32 + x-nullable: false + SysDigArgumentAdditions: + type: string + description: Additional SysDig command arguments applied on SysDig start + GroupName: + type: string + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + FileLiveTrackingRequiresBaselineCompletion: + type: boolean + description: Specifies whether a full baseline must be completed before live file tracking can be started. + x-nullable: false + FileLiveTrackingRequiresBaselineCompletionIsInherited: + type: boolean + description: Indicates whether the property is inherited from a setting on a parent group. + x-nullable: false + PerformancePercentage: + type: integer + description: 'The performance percentage is the percentage of its maximum performance that the agent will use, for example at 100 (100%) the agent will complete polls in the shortest possible time, at the expense of utilisation of local cpu and disk resources. At 0% the agent will have the least impact on the tracked system.' + format: int32 + x-nullable: false + PerformancePercentageIsInherited: + type: boolean + description: Indicates whether the property is inherited from a setting on a parent group. + x-nullable: false + PlannedChangeWindowPaddingSeconds: + type: integer + description: The planned change window padding in seconds. This is the amount of time prior to the start and end of a planned change that tracker polls are started. + format: int32 + x-nullable: false + PlannedChangeWindowPaddingSecondsIsInherited: + type: boolean + description: Indicates whether the property is inherited from a setting on a parent group. + x-nullable: false + PollPeriodSeconds: + type: integer + description: 'The poll period / frequency for this device / group, in seconds.' + format: int32 + x-nullable: false + PollGracePeriodSeconds: + type: integer + description: The maximum number of seconds by which an agent can be overdue its poll without being marked as offline. + format: int32 + x-nullable: false + EventSenderBatchSize: + type: integer + description: The maximum number of events sent to the hub by the agent in one submission. + format: int32 + x-nullable: false + EventSenderSleepTimeMs: + type: integer + description: The number of milliseconds to wait after each batch of events are sent to the hub. + format: int32 + x-nullable: false + Lineage: + type: array + items: + type: string + description: The list of groups the DeviceSettings have been inherited from + CommandTimeoutSeconds: + type: integer + description: The number of seconds to wait for a process-output command executed by the agent tracking process to complete. + format: int32 + x-nullable: false + CommandTimeoutSecondsIsInherited: + type: boolean + x-nullable: false + FileTrackerFilePollLimit: + type: integer + description: The number of files a device file system tracker poll will be limited to before terminating the poll + format: int32 + x-nullable: false + description: 'The device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' + GetAgentTasksResponse: + title: GetAgentTasksResponse + required: + - Version + type: object + properties: + Tasks: + type: array + items: + $ref: '#/components/schemas/AgentTask' + description: Specifies the current list of tasks for the agent. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetAgentTasks + SubmitAgentTaskResultStreamResponse: + title: SubmitAgentTaskResultStreamResponse + required: + - StoredId + - Version + type: object + properties: + StoredId: + type: string + description: The id of the stored stream + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for SubmitAgentTaskResultsStream. + GetPolicyTemplatesResponse: + title: GetPolicyTemplatesResponse + required: + - Version + type: object + properties: + Templates: + type: array + items: + $ref: '#/components/schemas/PolicyTemplateSummary' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Response to a request for matching config templates. + PolicyTemplateSummary: + title: PolicyTemplateSummary + type: object + properties: + Version: + type: integer + description: Gets the service model version. + format: int32 + x-nullable: false + VersionString: + type: string + description: Gets the version as a string. + AvailableVersion: + type: string + description: Gets the newest available version. + FileId: + type: string + description: Gets or sets the file identifier. + UpgradeInfo: + type: string + description: Gets or sets the upgrade information. + IsSystem: + type: boolean + description: Gets or sets a value indicating whether this instance is system. + x-nullable: false + IsActive: + type: boolean + description: Gets or sets a value indicating whether this instance is active. + x-nullable: false + IsLatest: + type: boolean + description: Gets or sets a value indicating whether this instance is latest. + x-nullable: false + HasRules: + type: boolean + description: Gets or sets a value indicating whether this instance has rules. + x-nullable: false + Name: + type: string + description: Specifies the name. + DisplayName: + type: string + description: Specifies the display name. + FileName: + type: string + description: Specifies the template file name. + Xml: + type: string + description: Specifies the template config xml. + UpdatedDateUtc: + type: string + description: Specifies the last UTC date any part of the template was updated. + format: date-time + x-nullable: false + UpdatedConfigDateUtc: + type: string + description: Specifies the last UTC date the tracking configuration part of the template was updated. + format: date-time + x-nullable: false + PassMark: + type: number + description: Specifies the default pass mark associated with compliance report TemplateType. + format: double + x-nullable: false + Trackers: + type: array + items: + type: string + description: 'Specifies the names of the trackers configured in this template, if it is a ''PolicyTemplateType.DeviceConfig''.' + NotificationRefId: + type: string + description: Specifies the tracker's notification ref id. + UsageTags: + type: array + items: + type: string + description: Specifies the names of the usage tag categories specified in this template'. + TemplateSignature: + type: string + description: Specifies the signature of the template. + IsTrusted: + type: boolean + description: Does the template contain trusted commands. + ValidationStatus: + type: string + description: 'A named policy template summary. Policy templates can be of any of the types specified by PolicyTemplateType, for example DeviceConfig, ComplianceReport or RegistrationReport. PolicyTemplates are a DTO used to add any policy template to the system based on its xml. To add an agent tracker configuration based on specific tracker DTO objects use DeviceTemplate.' + GetPolicyTemplateVariablesResponse: + title: GetPolicyTemplateVariablesResponse + required: + - Version + type: object + properties: + PolicyTemplateName: + type: string + DataRequirements: + type: array + items: + $ref: '#/components/schemas/VariableDataRequirement' + TemplateSignature: + type: string + DeviceTemplate: + $ref: '#/components/schemas/DeviceTemplate' + TemplateConfigXml: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The list of variable definitions from a named report to be collected by the agent. + DeviceTemplate: + title: DeviceTemplate + type: object + properties: + Version: + type: integer + description: Gets the version. + format: int32 + x-nullable: false + Config: + $ref: '#/components/schemas/DeviceConfiguration' + Name: + type: string + description: Specifies the name. + DisplayName: + type: string + description: Specifies the display name. + UpdatedDateUtc: + type: string + description: Specifies the UTC date the template was updated. + format: date-time + x-nullable: false + description: Represents a named device tracking configuration template only (no rule-set). + List_String_: + title: List + type: array + items: + type: string + GetAgentsResponse: + title: GetAgentsResponse + required: + - Version + type: object + properties: + AgentCredentials: + type: array + items: + $ref: '#/components/schemas/AgentCredential' + description: Specifies a list of agent device -> credentials. + AgentGroups: + type: array + items: + $ref: '#/components/schemas/AgentGroups' + description: Specifies a list of agent device -> group memberships. + AgentPlannedChangeStatuses: + type: array + items: + $ref: '#/components/schemas/AgentPlannedChangeInstanceStatus' + description: Specifies a list of agent device -> planned change statuses (returned here to make subsequent calls unnecessary in UI - the data is all stored in the same object in the repository so no signficant cost in getting it out) + Agents: + type: array + items: + $ref: '#/components/schemas/Agent' + description: Specifies the agents matching the 'GetAgents' request. + AgentTemplates: + type: array + items: + $ref: '#/components/schemas/AgentTemplates' + description: Specifies agent device -> templates + RelatedProxyAgents: + type: array + items: + $ref: '#/components/schemas/Agent' + description: 'Specifies the related proxy agents. These are the agents that proxy the devices listed in ''Agents'', if any.' + ResultsGeneratedAtUtc: + type: string + description: Specifies time the results were generated at in utc. + format: date-time + x-nullable: false + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetAgents + AgentCredential: + title: AgentCredential + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + Credentials: + type: array + items: + type: string + description: The list of credentials 'keys' (names) associated with the agent device id. + CredentialsTestStatus: + type: string + description: 'Specifies the status of the last credentials test, if any.' + CredentialsTestMessage: + type: string + description: Specifies the a success or failure message associated with the last credentials test. + description: Represents and agent device (by it's ID) and a list of credentials associated with it. + AgentGroups: + title: AgentGroups + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + MemberOf: + type: array + items: + type: string + description: The list of groups the agent device is a member of. + description: Represents an agent device (by it's ID) and a list of groups it is a member of. + AgentPlannedChangeInstanceStatus: + title: AgentPlannedChangeInstanceStatus + type: object + properties: + Name: + type: string + description: Specifies the planned change name. + NameCombined: + type: string + description: Gets the planned change name plus the description if the description is different from the name. + Description: + type: string + description: Specifies the planned change description. + InstanceId: + type: string + description: Specifies the planned change instance id. + Active: + type: boolean + x-nullable: false + TempTestProp: + type: string + description: AgentPlannedChangeInstanceStatus + AgentTemplates: + title: AgentTemplates + type: object + properties: + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + ConfigTemplates: + type: array + items: + type: string + description: A list of template names associated with the agent device. + description: Represents a list of config templates for an Agent Device + SearchAgentsResponse: + title: SearchAgentsResponse + required: + - Version + type: object + properties: + Agents: + type: array + items: + $ref: '#/components/schemas/Agent' + description: Specifies the agents matching the 'SearchAgents' request. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for SearchAgents + PreRegisterAgentsResponse: + title: PreRegisterAgentsResponse + type: object + properties: + Agents: + type: array + items: + $ref: '#/components/schemas/Agent' + description: A list of agents that have been pre-registered. + description: The response object for PreRegisterAgents + GetDeviceConfigResponse: + title: GetDeviceConfigResponse + required: + - Version + type: object + properties: + DeviceTemplate: + $ref: '#/components/schemas/DeviceTemplate' + PolicyRuleSet: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + Xml: + type: string + description: 'Specifies the xml. Only one of DeviceTemplate, PolicyRuleSet or Xml string can be returned.' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Represents the tracking configuration template from the merged result of the group configurations for the groups the device is in. + GetDeviceSettingsResponse: + title: GetDeviceSettingsResponse + required: + - Version + type: object + properties: + DeviceSettings: + type: array + items: + $ref: '#/components/schemas/DeviceSettings' + description: 'The device settings for the specified group or device, or if an AgentId alone was specified, a list of the DeviceSetting for each device proxied by the agent.' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'Represents the device specific options such as customised local ui password details, and tracker performance settings.' + GetEventsResponse: + title: GetEventsResponse + required: + - Version + type: object + properties: + Events: + type: array + items: + $ref: '#/components/schemas/Event' + description: Gets or sets the events. + DeviceEvents: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + description: Gets or sets the device events. + AuditEvents: + type: array + items: + $ref: '#/components/schemas/AuditEvent' + description: Gets or sets the audit events. + BaselineEvents: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + description: Gets or sets the baseline events. + AlertEvents: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + description: Gets or sets the alert events. + DataResultsEvents: + type: array + items: + $ref: '#/components/schemas/DataResultsEvent' + description: Gets or sets the data results events. + AllEvents: + type: array + items: + $ref: '#/components/schemas/Event' + description: Gets or sets all events. + PlannedChanges: + $ref: '#/components/schemas/Dictionary_String_String_' + Rules: + $ref: '#/components/schemas/Dictionary_String_String_' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The Events response. + Event: + title: Event + type: object + properties: + Comment: + type: string + description: Gets or sets the event comment. + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + DeviceName: + type: string + description: Gets or sets the device name. + Id: + type: string + description: Gets or sets the unique event ID + EventType: + type: string + description: Gets or sets the event type. + DateUtc: + type: string + description: Gets or sets the UTC date and time of the event. + format: date-time + x-nullable: false + DateDevice: + type: string + description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + format: date-time + x-nullable: false + DateLocal: + type: string + description: 'Gets or sets the local user''s date and time of the event, based on the GetEvents.UserTimeZoneId specified.' + format: date-time + x-nullable: false + Status: + type: string + description: Gets or sets the current status of the event + PlannedChangeStatus: + type: string + description: Gets or sets the planned change status. + PlannedChangeId: + type: string + description: Gets or sets the planned change id + PlannedChangeManual: + type: boolean + description: Gets or sets whether event was added to the planned change manually or via a rule. + x-nullable: false + Origin: + type: string + description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + TimeZoneId: + type: string + description: Gets or sets the time zone id. + UtcOffsetHours: + type: number + description: Gets or sets the offset of local time as represented by TimeZoneId and Utc time in hours. + format: double + x-nullable: false + Version: + type: integer + description: Gets or sets the object version. + format: int32 + x-nullable: false + Score: + type: number + description: Gets or sets the score - only used when returning 'ranked' events. + format: double + x-nullable: false + Description: + type: string + description: Gets or sets the event description. + ProcessingTimeMs: + type: number + description: Gets or sets the processing time in ms. + format: double + Url: + type: string + description: Gets a URL of the event to get more details. + ExtraInfo: + type: string + description: 'Gets or sets the extra info. Where the event is an alert notification, this contains information about tracker reconfigurations, this property can be used to hold the data in a more easily parsed form.' + UsedInBaselines: + type: array + items: + $ref: '#/components/schemas/UsedInBaseline' + description: 'Gets or sets the links indicating whether the event has been used to create or amend a rule in a baseline report, and the action taken.' + description: A base class for any Event raised throughout the once it enters the NNT system and is being processed + AuditEvent: + title: AuditEvent + type: object + properties: + NotificationStatus: + type: string + description: Gets or sets the current notification status of the event + AuditMessageType: + type: string + description: Gets or sets the audit message type. + Grantor: + type: string + description: Gets or sets the grantor. + Grantee: + type: string + description: Gets or sets the grantee. + Action: + type: string + description: Gets or sets the audit action. + LicensedDayUtc: + type: string + description: Gets or sets the date that a licensed device day audit message relates to. + format: date-time + Comment: + type: string + description: Gets or sets the event comment. + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + DeviceName: + type: string + description: Gets or sets the device name. + Id: + type: string + description: Gets or sets the unique event ID + EventType: + type: string + description: Gets or sets the event type. + DateUtc: + type: string + description: Gets or sets the UTC date and time of the event. + format: date-time + x-nullable: false + DateDevice: + type: string + description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + format: date-time + x-nullable: false + DateLocal: + type: string + description: 'Gets or sets the local user''s date and time of the event, based on the GetEvents.UserTimeZoneId specified.' + format: date-time + x-nullable: false + Status: + type: string + description: Gets or sets the current status of the event + PlannedChangeStatus: + type: string + description: Gets or sets the planned change status. + PlannedChangeId: + type: string + description: Gets or sets the planned change id + PlannedChangeManual: + type: boolean + description: Gets or sets whether event was added to the planned change manually or via a rule. + x-nullable: false + Origin: + type: string + description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + TimeZoneId: + type: string + description: Gets or sets the time zone id. + UtcOffsetHours: + type: number + description: Gets or sets the offset of local time as represented by TimeZoneId and Utc time in hours. + format: double + x-nullable: false + Version: + type: integer + description: Gets or sets the object version. + format: int32 + x-nullable: false + Score: + type: number + description: Gets or sets the score - only used when returning 'ranked' events. + format: double + x-nullable: false + Description: + type: string + description: Gets or sets the event description. + ProcessingTimeMs: + type: number + description: Gets or sets the processing time in ms. + format: double + Url: + type: string + description: Gets a URL of the event to get more details. + ExtraInfo: + type: string + description: 'Gets or sets the extra info. Where the event is an alert notification, this contains information about tracker reconfigurations, this property can be used to hold the data in a more easily parsed form.' + UsedInBaselines: + type: array + items: + $ref: '#/components/schemas/UsedInBaseline' + description: 'Gets or sets the links indicating whether the event has been used to create or amend a rule in a baseline report, and the action taken.' + description: The audit event. + DataResultsEvent: + title: DataResultsEvent + type: object + properties: + DataItems: + type: array + items: + $ref: '#/components/schemas/AgentDataItem' + description: Gets or sets the agent data items + Comment: + type: string + description: Gets or sets the event comment. + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentId: + type: string + description: Specifies the id of the agent. + DeviceId: + type: string + description: Specifies the id of the device. + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + DeviceName: + type: string + description: Gets or sets the device name. + Id: + type: string + description: Gets or sets the unique event ID + EventType: + type: string + description: Gets or sets the event type. + DateUtc: + type: string + description: Gets or sets the UTC date and time of the event. + format: date-time + x-nullable: false + DateDevice: + type: string + description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + format: date-time + x-nullable: false + DateLocal: + type: string + description: 'Gets or sets the local user''s date and time of the event, based on the GetEvents.UserTimeZoneId specified.' + format: date-time + x-nullable: false + Status: + type: string + description: Gets or sets the current status of the event + PlannedChangeStatus: + type: string + description: Gets or sets the planned change status. + PlannedChangeId: + type: string + description: Gets or sets the planned change id + PlannedChangeManual: + type: boolean + description: Gets or sets whether event was added to the planned change manually or via a rule. + x-nullable: false + Origin: + type: string + description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + TimeZoneId: + type: string + description: Gets or sets the time zone id. + UtcOffsetHours: + type: number + description: Gets or sets the offset of local time as represented by TimeZoneId and Utc time in hours. + format: double + x-nullable: false + Version: + type: integer + description: Gets or sets the object version. + format: int32 + x-nullable: false + Score: + type: number + description: Gets or sets the score - only used when returning 'ranked' events. + format: double + x-nullable: false + Description: + type: string + description: Gets or sets the event description. + ProcessingTimeMs: + type: number + description: Gets or sets the processing time in ms. + format: double + Url: + type: string + description: Gets a URL of the event to get more details. + ExtraInfo: + type: string + description: 'Gets or sets the extra info. Where the event is an alert notification, this contains information about tracker reconfigurations, this property can be used to hold the data in a more easily parsed form.' + UsedInBaselines: + type: array + items: + $ref: '#/components/schemas/UsedInBaseline' + description: 'Gets or sets the links indicating whether the event has been used to create or amend a rule in a baseline report, and the action taken.' + description: Represents an event containing agent response data (e.g to a 'get processes' request) + SubmitAlertEventsLimitedResponse: + title: SubmitAlertEventsLimitedResponse + required: + - Version + type: object + properties: + BackOffSeconds: + type: integer + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: SubmitAlertEventsLimitedResponse + SubmitBaselineEventsLimitedResponse: + title: SubmitBaselineEventsLimitedResponse + required: + - Version + type: object + properties: + BackOffSeconds: + type: integer + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: SubmitBaselineEventsLimitedResponse + SubmitDeviceEventsLimitedResponse: + title: SubmitDeviceEventsLimitedResponse + required: + - Version + type: object + properties: + BackOffSeconds: + type: integer + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: SubmitDeviceEventsLimitedResponse + SystemReadyResponse: + title: SystemReadyResponse + required: + - Version + type: object + properties: + IsReady: + type: boolean + description: Specifies whether system is booted and ready for login. + x-nullable: false + MicrosoftGraphAuthEnabled: + type: boolean + description: Specifies whether Microsoft Graph (Azure AD) authentication is available for login. + x-nullable: false + OktaAuthEnabled: + type: boolean + description: Specifies whether Okta authentication is available for login. + x-nullable: false + Auth0AuthEnabled: + type: boolean + description: Specifies whether Auth0 authentication is available for login. + x-nullable: false + SiteMinderAuthEnabled: + type: boolean + description: Specifies whether Broadcom SiteMinder authentication is available for login. + x-nullable: false + StatusMessage: + type: string + description: Specifies a status message if IsReady is false. + RetryLogin: + type: boolean + description: Specifies whether the caller should retry their login due to a system restart + x-nullable: false + PrimaryAuthProvider: + type: string + description: Specifies the preferred authentication provider. + HideCredentialsUi: + type: boolean + description: Specifies whether interactive credentials Ui should be shown for user authentication. + x-nullable: false + SSOHeaderName: + type: string + description: Specifies the name of the optional header containing SSO authentication information. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Indicates if system is booted and ready for login. + SystemDetailsResponse: + title: SystemDetailsResponse + type: object + properties: + SessionTimeout: + type: integer + description: 'Specifies the length of time after which a session should timeout, expressed in minutes.' + format: int32 + x-nullable: false + SessionTimeoutWarning: + type: integer + description: 'Specifies the length of time a session timeout warning should be available, expressed in seconds.' + format: int32 + x-nullable: false + LicenseDaysRemaining: + type: integer + description: Specifies the length of time in days until the current license expires. + format: int32 + x-nullable: false + Version: + type: string + description: Specifies the system version. + Notifications: + type: array + items: + $ref: '#/components/schemas/SystemDetailNotification' + description: Specifies zero or more informational messages about the system. + WorkerStatuses: + type: array + items: + $ref: '#/components/schemas/WorkerStatus' + description: Specifies the list of statuses about constituent parts of the system. + description: System version and config settings. + SystemDetailNotification: + title: SystemDetailNotification + type: object + properties: + NotificationType: + type: string + Title: + type: string + Message: + type: string + description: SystemDetailNotification + WorkerStatus: + title: WorkerStatus + type: object + properties: + Name: + type: string + Version: + type: string + ConfigSource: + type: string + ClrVersion: + type: string + HostName: + type: string + BackgroundTaskThreads: + type: integer + format: int32 + x-nullable: false + EventProcessorThreads: + type: integer + format: int32 + x-nullable: false + NotificationProcessorThreads: + type: integer + format: int32 + x-nullable: false + BulkNotificationProcessingThreads: + type: integer + format: int32 + x-nullable: false + EventQueueThreads: + type: integer + format: int32 + x-nullable: false + DeviceOfflineThreads: + type: integer + format: int32 + x-nullable: false + OutdatedConfigWatcherThreads: + type: integer + format: int32 + x-nullable: false + BackgroundTaskTypes: + type: array + items: + type: string + Role: + type: string + Environment: + type: string + HostType: + type: string + description: WorkerStatus + BackgroundTaskDetails: + title: BackgroundTaskDetails + type: object + properties: + Id: + type: string + Status: + type: string + TaskType: + type: string + TaskTypeName: + type: string + PercentComplete: + type: number + format: float + x-nullable: false + Message: + type: string + TaskCreatedDateTimeUtc: + type: string + format: date-time + x-nullable: false + SubmittedDateTimeUtc: + type: string + format: date-time + x-nullable: false + StartedDateTimeUtc: + type: string + format: date-time + x-nullable: false + EndDateTimeUtc: + type: string + format: date-time + x-nullable: false + ExpirationDateTimeUtc: + type: string + format: date-time + x-nullable: false + TimeOnQueueMs: + type: integer + format: int32 + x-nullable: false + ProcessingTimeMs: + type: integer + format: int32 + x-nullable: false + UserName: + type: string + DependentTasks: + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' + ExternalFileId: + type: string + WaitingCheckIntervalSec: + type: integer + format: int32 + x-nullable: false + RecheckDependenciesIntervalSec: + type: integer + format: int32 + x-nullable: false + description: BackgroundTaskDetails + List_BackgroundTaskDetails_: + title: List + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' + Dictionary_String_ComponentStatus_: + title: 'Dictionary' + type: object + additionalProperties: + enum: + - Unknown + - Starting + - Up + - Stopping + - Down + - Busy + - Fault + - RequiresUpgrade + type: string + description: 'Dictionary' + PerformanceSnapshot: + title: PerformanceSnapshot + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + Id: + type: string + PipelineNode: + type: string + SnapshotTimeUtc: + type: string + format: date-time + x-nullable: false + PerformanceData: + type: array + items: + $ref: '#/components/schemas/PerformanceItem' + WorkloadStats: + $ref: '#/components/schemas/Dictionary_String_Double_' + ComponentStatuses: + $ref: '#/components/schemas/Dictionary_String_ComponentStatus_' + description: A system performance metric consisting of a list of values for a PipelineItem. + PerformanceItem: + title: PerformanceItem + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + PipelineItem: + type: string + PipelineItemName: + type: string + MetricName: + type: string + Value: + type: number + format: double + x-nullable: false + UnitDescription: + type: string + description: PerformanceItem + Dictionary_String_Double_: + title: 'Dictionary' + type: object + additionalProperties: + type: number + format: double + x-nullable: false + description: 'Dictionary' + List_PerformanceSnapshot_: + title: List + type: array + items: + $ref: '#/components/schemas/PerformanceSnapshot' + GetCacheStatsResponse: + title: GetCacheStatsResponse + required: + - Version + type: object + properties: + GroupCounts: + type: array + items: + $ref: '#/components/schemas/GroupStats' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The cache statistics. + GroupStats: + title: GroupStats + type: object + properties: + Name: + type: string + QueriedMembers: + type: integer + format: int32 + x-nullable: false + CachedMembers: + type: integer + format: int32 + x-nullable: false + Message: + type: string + description: GroupStats + GetAvailableReportTypesResponse: + title: GetAvailableReportTypesResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/AvailableReportType' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetAvailableReportTypesResponse + AvailableReportType: + title: AvailableReportType + type: object + properties: + Name: + type: string + Id: + type: string + description: AvailableReportType + GetReportTemplatesResponse: + title: GetReportTemplatesResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/ReportTemplateInfo' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetReportTemplatesResponse + ReportTemplateInfo: + title: ReportTemplateInfo + type: object + properties: + ReportTemplateType: + type: string + ReportTemplateSubType: + type: string + ReportTemplateName: + type: string + ReportTemplateFileName: + type: string + Version: + type: string + UpgradeInfo: + type: string + IsArchived: + type: boolean + x-nullable: false + IsSystem: + type: boolean + x-nullable: false + IsActive: + type: boolean + x-nullable: false + IsLatest: + type: boolean + x-nullable: false + ReportChangedDateUtc: + type: string + format: date-time + x-nullable: false + description: ReportTemplateInfo + GetScheduledReportsResponse: + title: GetScheduledReportsResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/ScheduledReportItem' + description: The returned list of the reports affected + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + ScheduledReportItem: + title: ScheduledReportItem + type: object + properties: + Id: + type: string + description: The unique id of the ScheduledReportItem + Schedule: + $ref: '#/components/schemas/ReportSchedule' + TypeId: + type: string + UserName: + type: string + IsPublic: + type: boolean + x-nullable: false + IsEditable: + type: boolean + x-nullable: false + IsHidden: + type: boolean + description: Indicates whether the report/query is visible in the reports list. Used to create temporary items for interactive 'export to csv' functions. + x-nullable: false + UserCreated: + type: boolean + x-nullable: false + CreatedUtc: + type: string + format: date-time + x-nullable: false + LastModifiedUtc: + type: string + format: date-time + LastRunUtc: + type: string + format: date-time + NextRunUtc: + type: string + format: date-time + StateChangeToken: + type: string + ScheduleRunDueByUtc: + type: string + format: date-time + Reports: + type: array + items: + $ref: '#/components/schemas/ReportSpecification' + ShowTableOfContents: + type: string + description: Specifies the settings controlling when the ContainerReport with table of contents is shown. + ContainerReport: + $ref: '#/components/schemas/ReportSpecification' + EmailDelivery: + $ref: '#/components/schemas/ReportEmailDelivery' + KeepUnscheduledResultsForMinutes: + type: integer + description: 'Specifies how long to keep ''adhoc'' (ie non-scheduled) report results for, in minutes.' + format: int32 + x-nullable: false + KeepScheduledResultsForMinutes: + type: integer + description: 'Specifies how long to keep scheduled report results for, in minutes.' + format: int32 + x-nullable: false + ScheduledState: + type: string + Summary: + type: string + description: Specifies a text summary of schedule and email settings. + WaitForAdhocResultsMinutes: + type: integer + description: 'Specifies long to wait for a run''s queries to complete, in minutes.' + format: int32 + x-nullable: false + OverrideWaitForResults: + type: boolean + description: Specifies whether to override the default behaviour for scheduled queries of waiting until the next scheduled run and use the value specified by WaitForAdhocResultsMinutes instead. + x-nullable: false + description: Represents the settings necessary to produce query data for a specific type of report. It is effectively a 'saved query' with options to produce and deliver a report or data export on a schedule. + UpdateReportTemplateResponse: + title: UpdateReportTemplateResponse + required: + - Version + type: object + properties: + FileId: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: UpdateReportTemplateResponse + DataSpecDeviceMonitoringReportResponse: + title: DataSpecDeviceMonitoringReportResponse + required: + - Version + type: object + properties: + ReportMetadata: + type: array + items: + $ref: '#/components/schemas/ReportMetadata' + description: Specifies the list of available reports. + Device: + $ref: '#/components/schemas/DeviceReportDetail' + Id: + type: string + description: The id of the report results + ReportTitle: + type: string + description: The report title + Summary: + type: array + items: + $ref: '#/components/schemas/SummaryItem' + description: 'A list of key value pairs indicating the settings that produced the report, including query parameters and report metadata' + HasNoResults: + type: boolean + description: 'Indicates whether the report has no results. This is report specific, eg for a events and planned changes reports it means no events in the time period, for a compliance report run it means there were no devices to report on in the specified group etc.' + x-nullable: false + ItemName: + type: string + description: 'Specifies the descriptive name of the result item, for example ''report'', ''planned change'', ''event'' etc.' + ErrorMessage: + type: string + description: Specifies the descriptive error message for a failed report. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The returned data for populating a device monitoring report + ReportMetadata: + title: ReportMetadata + required: + - ReportItemId + - ReportInstanceId + type: object + properties: + AgentDeviceId: + type: string + description: 'Specifies the combined agent and device id, for example 1,1.' + DeviceName: + type: string + description: Specifies the device name. + ReportName: + type: string + description: Specifies the report name. + ReportId: + type: string + description: Specifies the report task id. + ReportItemId: + type: string + description: Specifies the scheduled report item id. + ReportInstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + ReportSpecId: + type: string + description: Specifies the scheduled settings id within the ScheduledReportItem.Reports list. + DateUtc: + type: string + description: Specifies the creation date of the report. + format: date-time + x-nullable: false + DateTz: + type: string + description: Specifies the creation date of the report as a timezone formatted string. + ReportScore: + type: number + description: Specifies the report result score. + format: double + x-nullable: false + LastReportScore: + type: number + description: Specifies the report result score from the previous run if any. + format: double + x-nullable: false + GroupAverageScore: + type: number + description: Specifies the group average score from all the devices in the run. + format: double + x-nullable: false + Pass: + type: boolean + description: Specifies whether the report score was considered a pass. + x-nullable: false + Status: + type: string + description: Specifies the report status. + LastStatus: + type: string + description: Specifies the last report status. + AdHoc: + type: boolean + description: Indicating wether or not this report was an 'ad-hoc' run (vs being scheduled). + x-nullable: false + ErrorMessage: + type: string + description: Specifies the report error message if any. + DeviceStatusMessage: + type: string + description: 'Specifies the report status message for the device, if any.' + Id: + type: string + InstanceType: + type: string + RangeType: + type: string + TimeZone: + type: string + UserName: + type: string + RunTimeUtc: + type: string + format: date-time + x-nullable: false + ExpiresAtUtc: + type: string + format: date-time + x-nullable: false + ScheduledReportItem: + $ref: '#/components/schemas/ScheduledReportItem' + QueryDtos: + type: array + items: + $ref: '#/components/schemas/QueryReadyDto' + QueryTaskId: + type: string + QueryTaskStatus: + type: string + StatusMessage: + type: string + ResultsSummaries: + type: array + items: + $ref: '#/components/schemas/ResultsSummary' + description: ReportMetadata + QueryReadyDto: + title: QueryReadyDto + type: object + properties: + DataSpecDto: + $ref: '#/components/schemas/DataSpecBase' + IteratorValue: + type: string + DataSpecId: + type: string + description: QueryReadyDto + ResultsSummary: + title: ResultsSummary + type: object + properties: + ReportSpecId: + type: string + ItemName: + type: string + Message: + type: string + Percentage: + type: string + Total: + type: integer + format: int32 + x-nullable: false + Complete: + type: integer + format: int32 + x-nullable: false + Errored: + type: integer + format: int32 + x-nullable: false + CalculatedStartUtc: + type: string + format: date-time + CalculatedEndUtc: + type: string + format: date-time + description: ResultsSummary + DeviceReportDetail: + title: DeviceReportDetail + type: object + properties: + TotalEvents: + type: integer + description: Gets the total events in the period. + format: int32 + x-nullable: false + ModelVersion: + type: integer + description: Gets the model version. + format: int32 + x-nullable: false + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentDeviceId: + type: string + description: Specifies the string unique id for the agent device. + Version: + type: string + description: Specifies the agent version. + Name: + type: string + description: Specifies the device display name. + DeviceName: + type: string + description: Specifies the device name. + FullyQualifiedDomainName: + type: string + description: Specifies the fully qualified domain name. + HostType: + type: string + description: 'Specifies the host type. This broadly indicates whether the device is windows or unix, or a DB or network device.' + AgentType: + type: string + description: 'Specifies the agent type. This indicates the agents runtime technology, based on AgentType enumeration, where available for the agent (old agents don''t supply it)' + Os: + type: string + description: Specifies the operating system as discovered by the agent. + OsUserSpecified: + type: string + description: 'Specifies the operating system as entered by the user. This will override the discovered Os in the UI, if specified.' + KnownOsName: + type: string + description: 'Specifies the known os name. This is the new OS name from the system defined list, it is either auto-mapped from the Agent''s discovered Os setting or selected by the user at the point of adding a proxied device.' + OsVariant: + type: string + description: Specifies the os variant. This is one of the the system defined settings for the selected 'KnownOsName'. For example it might be '64 bit version' etc.. + Registered: + type: boolean + description: Specifies a value indicating whether the agent has connected yet to pick up its registration. + x-nullable: false + Deleted: + type: boolean + description: Specifies a value indicating whether the device has been deleted. + x-nullable: false + PollPeriodSeconds: + type: integer + description: Specifies the poll period in seconds. + format: int32 + x-nullable: false + HostName: + type: string + description: Specifies the host name. This is the name or IP address used for agentless access to this device. + IPv4: + type: string + description: Specifies the IP v4 address. + IPv6: + type: string + description: Specifies the IP v6 address. + LastPollUtc: + type: string + description: Specifies the last time a poll was received from the agent. + format: date-time + x-nullable: false + NextPollUtc: + type: string + description: Specifies the expected next poll time. + format: date-time + x-nullable: false + MembershipChangeTimeUtc: + type: string + description: Specifies the last time group membership etc was changed. + format: date-time + OnlineStatus: + type: string + description: Specifies the online status. + DiagnosticModeEnabled: + type: boolean + description: Specifies a value indicating whether or not diagnostic mode is enabled for this agent / device (i.e. extra logging). + x-nullable: false + OnlineDetection: + type: string + description: Specifies the method to use when detecting if a proxied device is online + PingTimeoutSeconds: + type: integer + description: 'Specifies the ''OnlineDetection'' ping timeout seconds, used with ''CredentialsService.Types.OnlineDetection.Ping''.' + format: int32 + x-nullable: false + TcpConnectPort: + type: integer + description: Specifies the port used for 'OnlineDetection' using 'CredentialsService.Types.OnlineDetection.TcpConnect'. + format: int32 + x-nullable: false + CanProxy: + type: boolean + description: Specifies a value indicating whether the agent can proxy connections to other devices. + x-nullable: false + UniqueId: + type: string + description: 'Specifies a value uniquely identifying the agent independent of name or agent id. Used to detect a need to re-register when underlying hub store has been emptied, otherwise the auto incrementing agent id counter can result in clashes as already used ids are reissued to different agents.' + IsProxied: + type: boolean + description: Specifies a value indicating whether connection to the device is proxied by another device. + x-nullable: false + ReportedConfigDateUtc: + type: string + format: date-time + ExpectedConfigDateUtc: + type: string + format: date-time + x-nullable: false + Online: + type: boolean + description: Specifies whether the agent is currently online + x-nullable: false + LastPollTime: + type: string + description: Specifies a formatted text version of LastPollUtc. + Templates: + type: array + items: + $ref: '#/components/schemas/PolicyTemplateDetails' + description: Specifies the list of tracking templates the agent is configured with. TODO how does this differ from DeviceConfigNames? + TrackerDetails: + type: array + items: + $ref: '#/components/schemas/TrackerDetails' + description: Specifies the list of trackers and schedules the agent is configured to run + NotificationDetails: + type: array + items: + $ref: '#/components/schemas/NotificationDetails' + description: Specifies the list of notification types and groups configured for the agent + TrackerConfigDetails: + type: array + items: + $ref: '#/components/schemas/TrackerConfigDetails' + description: Specifies the list of configured tracker settings for each tracker + OperatingSystem: + type: string + description: Specifies the operating system as discovered by the agent. + TotalEventsPercent: + type: number + description: Specifies the total events associated with this device as a percentage of the overall. + format: double + x-nullable: false + RelatedProxyDeviceName: + type: string + description: Specifies the proxied device name. + ProxyAgentDevice: + $ref: '#/components/schemas/AgentDevice' + AgentCredentials: + type: array + items: + $ref: '#/components/schemas/NameValuePair' + description: 'Specifies the list of agent credentials, used by this agent to connect to other proxied devices.' + DbConnection: + $ref: '#/components/schemas/DbConnection' + CredentialsTestStatus: + type: string + description: 'Specifies the status of the last credentials test, if any.' + CredentialsTestMessage: + type: string + description: Specifies the a success or failure message associated with the last credentials test. + AgentPlannedChangeStatuses: + type: array + items: + $ref: '#/components/schemas/AgentPlannedChangeInstanceStatus' + description: Specifies the details of the planned changes the agent is a member of + DeviceConfigNames: + $ref: '#/components/schemas/Dictionary_String_List_PolicyTemplateDetails__' + DeviceGroupDetails: + type: array + items: + $ref: '#/components/schemas/NameValuePair' + description: Specifies the list of groups the agent is a member of + Events: + type: array + items: + $ref: '#/components/schemas/DeviceEventCountsSummary' + description: Specifies the list of counts of event types for the agent + DeviceGroupTemplates: + type: array + items: + $ref: '#/components/schemas/PolicyTemplateDetails' + description: Specifies the list of compliance reports the agent is a member of due to group membership + EventBlockEnabled: + type: boolean + description: Specifies a value indicating whether the device is blocked from sending events. + x-nullable: false + BaselineSendEnabled: + type: boolean + description: Specifies a value indicating whether the device is enabled for sending baseline events. + x-nullable: false + IsBlockingRegistrationBy: + type: string + description: Specifies a value indicating the UniqueId of the agent that is trying to 'take-over' this registration. + description: Represents agent properties in form suitable for reporting + PolicyTemplateDetails: + title: PolicyTemplateDetails + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + VersionString: + type: string + GroupName: + type: string + description: Specifies the group name. + GroupDisplayName: + type: string + description: Specifies the group display name. + PolicyTemplateName: + type: string + description: Specifies the policy template name. + PolicyTemplateDisplayName: + type: string + description: Specifies the policy template display name. + IsTrusted: + type: boolean + description: Specifies if policy template contains trusted commands. + description: The group policy template associated with a group + TrackerDetails: + title: TrackerDetails + type: object + properties: + TrackerName: + type: string + DisplayName: + type: string + Description: + type: string + description: TrackerDetails + NotificationDetails: + title: NotificationDetails + type: object + properties: + GroupName: + type: string + GroupDisplayName: + type: string + NotificationTypes: + type: string + NotificationMethod: + type: string + description: NotificationDetails + TrackerConfigDetails: + title: TrackerConfigDetails + type: object + properties: + TrackerName: + type: string + ConfigurationItem: + type: string + Description: + type: string + description: TrackerConfigDetails + NameValuePair: + title: NameValuePair + type: object + properties: + Id: + type: string + DisplayName: + type: string + description: NameValuePair + List_PolicyTemplateDetails_: + title: List + type: array + items: + $ref: '#/components/schemas/PolicyTemplateDetails' + Dictionary_String_List_PolicyTemplateDetails__: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/PolicyTemplateDetails' + description: 'Dictionary>' + DeviceEventCountsSummary: + title: DeviceEventCountsSummary + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + PeriodStartUtc: + type: string + format: date-time + x-nullable: false + PeriodEndUtc: + type: string + format: date-time + x-nullable: false + PeriodMidPointUtc: + type: string + format: date-time + x-nullable: false + PlannedChanges: + type: integer + format: int32 + x-nullable: false + UnPlannedChanges: + type: integer + format: int32 + x-nullable: false + AlertPlannedChanges: + type: integer + format: int32 + x-nullable: false + AlertUnPlannedChanges: + type: integer + format: int32 + x-nullable: false + Errors: + type: integer + format: int32 + x-nullable: false + DeviceEventCount: + type: integer + format: int32 + x-nullable: false + AlertEventCount: + type: integer + format: int32 + x-nullable: false + ErrorEventCount: + type: integer + format: int32 + x-nullable: false + AuditEventCount: + type: integer + format: int32 + x-nullable: false + RuleSetResultEventCount: + type: integer + format: int32 + x-nullable: false + RuleResultEventCount: + type: integer + format: int32 + x-nullable: false + DataResultsEventCount: + type: integer + format: int32 + x-nullable: false + DataItemEventCount: + type: integer + format: int32 + x-nullable: false + ScheduledPolicyResultEventCount: + type: integer + format: int32 + x-nullable: false + RuleSetScoreEventCount: + type: integer + format: int32 + x-nullable: false + CommsEventCount: + type: integer + format: int32 + x-nullable: false + BaselineEventCount: + type: integer + format: int32 + x-nullable: false + GroupReportResultEventCount: + type: integer + format: int32 + x-nullable: false + PeriodStartTz: + type: string + format: date-time + x-nullable: false + PeriodEndTz: + type: string + format: date-time + x-nullable: false + PeriodMidPointTz: + type: string + format: date-time + x-nullable: false + PeriodStart: + type: integer + format: int64 + x-nullable: false + PeriodEnd: + type: integer + format: int64 + x-nullable: false + StartDateTimeTextTz: + type: string + EndDateTimeTextTz: + type: string + MidPointDateTimeTz: + type: string + DateTimeFormat: + type: string + description: DeviceEventCountsSummary + SummaryItem: + title: SummaryItem + type: object + properties: + ItemName: + type: string + ItemValue: + type: string + description: SummaryItem + GetRuleResultsResponse: + title: GetRuleResultsResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/RuleResultState' + description: The returned list of the reports affected + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetRuleResultsResponse + RuleResultState: + title: RuleResultState + type: object + properties: + Id: + type: string + GroupResultEventId: + type: string + RuleId: + type: string + Score: + type: number + format: double + x-nullable: false + ScoreWeight: + type: integer + format: int32 + x-nullable: false + Title: + type: string + Detail: + type: string + Attributes: + $ref: '#/components/schemas/Dictionary_String_List_String__' + UsedInBaseline: + $ref: '#/components/schemas/UsedInBaseline' + AgentDeviceIds: + type: array + items: + type: string + DeviceCount: + type: integer + format: int32 + x-nullable: false + ItemName: + type: string + DataHash: + type: string + TrackerTypeName: + type: string + ItemTypeName: + type: string + TextDifferences: + type: array + items: + $ref: '#/components/schemas/TextDifference' + description: RuleResultState + Dictionary_String_List_String__: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + ComplianceReportSummaryResponse: + title: ComplianceReportSummaryResponse + required: + - Version + type: object + properties: + GroupName: + type: string + GroupDisplayName: + type: string + ReportTemplateName: + type: string + ReportVersion: + type: string + GroupPerformance: + type: array + items: + $ref: '#/components/schemas/DataPoint' + ReportRunTimesOutAtUtc: + type: string + format: date-time + x-nullable: false + AverageScore: + type: number + format: double + x-nullable: false + LastAverageScore: + type: number + format: double + x-nullable: false + LastRunTimeUtc: + type: string + format: date-time + x-nullable: false + LastRunTimeTextUtc: + type: string + ReportRunTimeTextUtc: + type: string + DeviceCount: + type: integer + format: int32 + x-nullable: false + LastDeviceCount: + type: integer + format: int32 + x-nullable: false + AgentTaskDetails: + type: array + items: + $ref: '#/components/schemas/AgentTaskDetails' + ReportItemId: + type: string + description: Specifies the scheduled report item id. + ReportInstanceId: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: ComplianceReportSummaryResponse + DataPoint: + title: DataPoint + type: object + properties: + Category: + type: string + Value: + type: string + description: DataPoint + AgentTaskDetails: + title: AgentTaskDetails + type: object + properties: + AgentTaskId: + type: integer + format: int32 + x-nullable: false + AgentDeviceId: + type: string + DeviceName: + type: string + AgentTaskStatus: + type: string + LastAgentTaskStatus: + type: string + AgentTaskStatusMessage: + type: string + TaskScore: + type: number + format: double + x-nullable: false + LastTaskScore: + type: number + format: double + x-nullable: false + TaskScoreDelta: + type: number + format: double + x-nullable: false + IsNew: + type: boolean + x-nullable: false + description: AgentTaskDetails + GetCurrentPlannedChangesResponse: + title: GetCurrentPlannedChangesResponse + required: + - Version + type: object + properties: + PlannedChanges: + type: array + items: + $ref: '#/components/schemas/PlannedChangeSummary' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetCurrentPlannedChangesResponse + PlannedChangeSummary: + title: PlannedChangeSummary + type: object + properties: + Version: + type: integer + description: This indicates the service model version the embedded Dto complies with. + format: int32 + x-nullable: false + Name: + type: string + PlannedChangeId: + type: string + Closure: + type: string + DevicesInPlannedChange: + type: integer + format: int32 + x-nullable: false + StartTimeUtc: + type: string + format: date-time + EndTimeUtc: + type: string + format: date-time + GroupsInPlannedChange: + type: integer + format: int32 + x-nullable: false + description: PlannedChangeSummary + GetComplianceDataResponse: + title: GetComplianceDataResponse + required: + - Version + type: object + properties: + ReportSummaries: + type: array + items: + $ref: '#/components/schemas/ReportSummary' + ComplianceHeaders: + type: array + items: + $ref: '#/components/schemas/ComplianceHeader' + OlderDataAvailable: + type: boolean + x-nullable: false + NewerDataAvailable: + type: boolean + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'Compliance data by report, for either individual devices, or as group average.' + ReportSummary: + title: ReportSummary + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + GroupOrDeviceName: + type: string + GroupName: + type: string + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + ReportName: + type: string + ReportId: + type: string + DevicesInReport: + type: integer + format: int32 + x-nullable: false + ReportScores: + type: array + items: + $ref: '#/components/schemas/ReportScore' + LatestPercentageScore: + type: number + format: double + x-nullable: false + PreviousPercentageScore: + type: number + format: double + LatestDateUtc: + type: string + format: date-time + x-nullable: false + LatestIsImprovement: + type: integer + format: int32 + x-nullable: false + description: ReportSummary + ReportScore: + title: ReportScore + required: + - ReportItemId + - ReportInstanceId + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + DateUtc: + type: string + format: date-time + x-nullable: false + PercentageScore: + type: number + format: double + x-nullable: false + DevicesMissingFromScore: + type: integer + format: int32 + x-nullable: false + DevicesAchievingPassMark: + type: integer + format: int32 + x-nullable: false + PassMark: + type: number + format: double + x-nullable: false + ErrorMessage: + type: string + ReportItemId: + type: string + description: Specifies the scheduled report item id. + ReportInstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + TaskId: + type: integer + format: int32 + x-nullable: false + description: ReportScore + ComplianceHeader: + title: ComplianceHeader + type: object + properties: + Name: + type: string + RunDate: + type: string + format: date-time + x-nullable: false + RunDateUtc: + type: string + format: date-time + x-nullable: false + ReportInstanceId: + type: string + description: ComplianceHeader + GetAvailableComplianceDataResponse: + title: GetAvailableComplianceDataResponse + required: + - Version + type: object + properties: + AvailableComplianceReports: + $ref: '#/components/schemas/Dictionary_String_List_ComplianceReportRun__' + AvailableComplianceDetails: + type: array + items: + $ref: '#/components/schemas/ComplianceReportRunDetails' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetAvailableComplianceDataResponse + ComplianceReportRun: + title: ComplianceReportRun + required: + - ReportItemId + type: object + properties: + GroupDisplayName: + type: string + GroupName: + type: string + ReportName: + type: string + ReportItemId: + type: string + description: Specifies the scheduled report item id. + description: ComplianceReportRun + List_ComplianceReportRun_: + title: List + type: array + items: + $ref: '#/components/schemas/ComplianceReportRun' + Dictionary_String_List_ComplianceReportRun__: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComplianceReportRun' + description: 'Dictionary>' + ComplianceReportRunDetails: + title: ComplianceReportRunDetails + type: object + properties: + GroupOrDeviceName: + type: string + GroupName: + type: string + ReportName: + type: string + ReportItemId: + type: string + DevicesInReport: + type: integer + format: int32 + x-nullable: false + Devices: + type: array + items: + type: string + AveragePercentageScore: + type: number + format: double + x-nullable: false + LatestPercentageScore: + type: number + format: double + x-nullable: false + PreviousPercentageScore: + type: number + format: double + LatestDateUtc: + type: string + format: date-time + x-nullable: false + LatestIsImprovement: + type: integer + format: int32 + x-nullable: false + ReportType: + type: string + description: ComplianceReportRunDetails + GetDeviceActivityResponse: + title: GetDeviceActivityResponse + required: + - Version + type: object + properties: + TotalDevices: + type: integer + format: int32 + x-nullable: false + TotalDevicesActiveInPeriod: + type: integer + format: int32 + x-nullable: false + TotalDevicesInActiveInPeriod: + type: integer + format: int32 + x-nullable: false + TotalDevicesAwaitingConnectionInPeriod: + type: integer + format: int32 + x-nullable: false + TotalDevicesReceivedNewConfig: + type: integer + format: int32 + x-nullable: false + TotalDevicesProcessingNewConfig: + type: integer + format: int32 + x-nullable: false + TotalDevicesAwaitingNewConfig: + type: integer + format: int32 + x-nullable: false + InactiveDeviceActivitySummaries: + type: array + items: + $ref: '#/components/schemas/DeviceActivitySummary' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Represents the list of devices matching the request criteria that have been inactive in the specified period. + DeviceActivitySummary: + title: DeviceActivitySummary + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + Name: + type: string + AgentDeviceId: + type: string + Deleted: + type: boolean + x-nullable: false + OnlineStatus: + type: string + description: Specifies the online status. + LastContactTimeUtc: + type: string + format: date-time + NextPollTimeUtc: + type: string + format: date-time + LastContactTimeMinutesAgo: + type: integer + format: int32 + x-nullable: false + Description: + type: string + description: DeviceActivitySummary + GetEventCountsResponse: + title: GetEventCountsResponse + required: + - Version + type: object + properties: + DeviceOrGroupName: + type: string + DeviceOrGroupId: + type: string + Events: + type: array + items: + $ref: '#/components/schemas/EventCountsSummary' + StartUtc: + type: string + format: date-time + x-nullable: false + EndUtc: + type: string + format: date-time + x-nullable: false + PlannedTotal: + type: integer + format: int32 + x-nullable: false + UnplannedTotal: + type: integer + format: int32 + x-nullable: false + AlertPlannedTotal: + type: integer + format: int32 + x-nullable: false + AlertUnplannedTotal: + type: integer + format: int32 + x-nullable: false + ErrorTotal: + type: integer + format: int32 + x-nullable: false + TotalEvents: + type: integer + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'Represents a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period.' + EventCountsSummary: + title: EventCountsSummary + type: object + properties: + Version: + type: integer + format: int32 + x-nullable: false + PeriodStartUtc: + type: string + format: date-time + x-nullable: false + PeriodEndUtc: + type: string + format: date-time + x-nullable: false + PeriodMidPointUtc: + type: string + format: date-time + x-nullable: false + PlannedChanges: + type: integer + format: int32 + x-nullable: false + UnPlannedChanges: + type: integer + format: int32 + x-nullable: false + AlertPlannedChanges: + type: integer + format: int32 + x-nullable: false + AlertUnPlannedChanges: + type: integer + format: int32 + x-nullable: false + Errors: + type: integer + format: int32 + x-nullable: false + EventCounts: + $ref: '#/components/schemas/Dictionary_EventType_Int32_' + PeriodStartTz: + type: string + format: date-time + x-nullable: false + PeriodEndTz: + type: string + format: date-time + x-nullable: false + PeriodMidPointTz: + type: string + format: date-time + x-nullable: false + PeriodStart: + type: integer + format: int64 + x-nullable: false + PeriodEnd: + type: integer + format: int64 + x-nullable: false + description: EventCountsSummary + Dictionary_EventType_Int32_: + title: 'Dictionary' + type: object + additionalProperties: + type: integer + format: int32 + x-nullable: false + description: 'Dictionary' + List_GetEventCountsResponse_: + title: List + type: array + items: + $ref: '#/components/schemas/GetEventCountsResponse' + ExecuteReportResponse: + title: ExecuteReportResponse + required: + - Version + type: object + properties: + Instance: + $ref: '#/components/schemas/ScheduledInstance' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: ExecuteReportResponse + ScheduledInstance: + title: ScheduledInstance + type: object + properties: + Id: + type: string + InstanceType: + type: string + RangeType: + type: string + TimeZone: + type: string + UserName: + type: string + RunTimeUtc: + type: string + format: date-time + x-nullable: false + ExpiresAtUtc: + type: string + format: date-time + x-nullable: false + ScheduledReportItem: + $ref: '#/components/schemas/ScheduledReportItem' + QueryDtos: + type: array + items: + $ref: '#/components/schemas/QueryReadyDto' + QueryTaskId: + type: string + QueryTaskStatus: + type: string + StatusMessage: + type: string + ResultsSummaries: + type: array + items: + $ref: '#/components/schemas/ResultsSummary' + description: ScheduledInstance + GetScheduledInstancesResponse: + title: GetScheduledInstancesResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/ScheduledInstance' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetScheduledInstancesResponse + GetScheduledInstanceRenderedResponse: + title: GetScheduledInstanceRenderedResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/ScheduledInstanceRendered' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetScheduledInstanceRenderedResponse + ScheduledInstanceRendered: + title: ScheduledInstanceRendered + type: object + properties: + Id: + type: string + Name: + type: string + CreatedUtc: + type: string + format: date-time + x-nullable: false + ExpiryUtc: + type: string + format: date-time + x-nullable: false + SizeBytes: + type: integer + format: int64 + x-nullable: false + ReportSpecId: + type: string + ReportInstanceId: + type: string + description: 'Represents the previously rendered output, for example a pdf file, for a specific report run.' + AgentSoftwareUpdate: + title: AgentSoftwareUpdate + type: object + properties: + Id: + type: string + description: Specifies the update ID + UpdateType: + type: string + description: 'Specifies the agent software update type (deb, rpm etc)' + ZipFileName: + type: string + description: Specifies the zip file name + Version: + type: string + description: Specifies the version contained in this update + UploadDate: + type: string + description: Specifies the date it was uploaded into the hub + format: date-time + x-nullable: false + UploadedBy: + type: string + description: Specifies who uploaded the file + ZipFileHash: + type: string + description: Specifies the hash of the zip file + InstallFilename: + type: string + description: Specifies the install filename that represents the gen 7 update file contained within the main update zip file for the agent to execute when processing an update using the command it is given. + description: Represents an individual software update + List_AgentSoftwareUpdate_: + title: List + type: array + items: + $ref: '#/components/schemas/AgentSoftwareUpdate' + List_GroupAgentUpdateSchedule_: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + GetSyncServiceConfigItemsResponse: + title: GetSyncServiceConfigItemsResponse + required: + - Version + type: object + properties: + ConfigurationValues: + type: array + items: + $ref: '#/components/schemas/AzureAppConfigValue' + description: The list of SyncService configuration items + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Response for retrieving SyncService configuration items + AzureAppConfigValue: + title: AzureAppConfigValue + type: object + properties: + Key: + type: string + description: The configuration key (without prefix) + Value: + type: string + description: The configuration value + Hidden: + type: boolean + description: Indicates whether this configuration value is stored as a secret + x-nullable: false + description: Represents a configuration value from SyncService + AddSyncServiceConfigItemResponse: + title: AddSyncServiceConfigItemResponse + required: + - Version + type: object + properties: + ConfigurationValue: + $ref: '#/components/schemas/AzureAppConfigValue' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Response for adding a SyncService configuration item + GetConfigItemsResponse: + title: GetConfigItemsResponse + required: + - Version + type: object + properties: + ConfigItems: + type: array + items: + $ref: '#/components/schemas/ConfigItem' + description: Specifies the configuration + DecryptionErrorOccured: + type: boolean + description: Specifies a boolean indicating whether a decryption error occured during the retrieval of a config item(s) + x-nullable: false + DecryptionErrorMessage: + type: string + description: Specifies the decryption error message should a decryption error have occured + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Describes the hub configuration parameters. + ConfigItem: + title: ConfigItem + type: object + properties: + Version: + type: integer + description: The HUB version that sent this object. + format: int32 + x-nullable: false + Id: + type: string + description: The unique id of this configuration item. + Key: + type: string + description: The configuration key. + Value: + type: string + description: The configuration value. + LastUpdatedUtc: + type: string + description: The configuration last updated date time UTC. + format: date-time + x-nullable: false + description: Represents an individual configuration item. + NewId: + title: NewId + type: object + properties: + Id: + type: string + description: The id of the new item created. + description: The id of the new item created. + Dictionary_String_NewId_: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/NewId' + description: 'Dictionary' + AddConfigItemResponse: + title: AddConfigItemResponse + required: + - Version + type: object + properties: + ConfigItems: + type: array + items: + $ref: '#/components/schemas/ConfigItem' + description: A list of configuration items that where added. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response delivered after adding a new config key / value. + Dictionary_CredentialType_List_String__: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + List_Credentials_: + title: List + type: array + items: + $ref: '#/components/schemas/Credentials' + GetAgentTaskStatusesResponse: + title: GetAgentTaskStatusesResponse + required: + - Version + type: object + properties: + Statuses: + type: array + items: + $ref: '#/components/schemas/AgentTaskStatus' + description: Specifies the statuses. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetAgentTaskStatuses + AgentTaskStatus: + title: AgentTaskStatus + type: object + properties: + Id: + type: integer + description: The unique task id. + format: int32 + x-nullable: false + AgentId: + type: string + description: Specifies the agent id. + DeviceId: + type: string + description: Specifies the device id. + DeviceName: + type: string + description: Specifies the device name. + HostName: + type: string + description: Specifies the host name. This is the name or IP address used for agentless access to this device. + Description: + type: string + description: Specifies the task description. + PolicyTemplateName: + type: string + description: Specifies the policy template name. Only relevant for certain types of report execution tasks for which it preserves a trace of the source policy name the report is based on. + Status: + type: string + description: Specifies the status. + StatusMessage: + type: string + description: Specifies the status message. + Processed: + type: boolean + description: Specifies whether the task has been processed. + x-nullable: false + TaskExpirationUtc: + type: string + description: Specifies the task expiry time after which its results will be discarded. + format: date-time + x-nullable: false + ErrorText: + type: string + description: Specifies error message if the task has failed. + UpdatedUtc: + type: string + description: Specifies the UTC date and time the task was last updated. + format: date-time + x-nullable: false + description: ' Represents the status of a task.' + SubmitAgentTasksResponse: + title: SubmitAgentTasksResponse + required: + - Version + type: object + properties: + Tasks: + type: array + items: + $ref: '#/components/schemas/AgentTask' + description: Specifies the list of tasks that were submitted. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for SubmitAgentTasks. + FileHashBinary: + title: FileHashBinary + type: object + properties: + Id: + type: string + description: Specifies the unique id for this file hash binary. + FileName: + type: string + description: Specifies the file name for this fie hash binary. + HostType: + type: string + description: 'Specifies the host type (Windows, Unix etc) associated with this file hash binary.' + OperatingSystem: + type: string + description: Specifies the operating system associated with this file hash binary. + Variant: + type: string + description: 'Specifies the variant (X64, i386 etc) associated with this file hash binary.' + description: Describes a file hash binary. + List_FileHashBinary_: + title: List + type: array + items: + $ref: '#/components/schemas/FileHashBinary' + GetPlannedChangeInstanceMembersResponse: + title: GetPlannedChangeInstanceMembersResponse + required: + - InstanceId + - Version + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + MemberGroups: + type: array + items: + type: string + description: Specifies the member groups. + MemberDevices: + type: array + items: + $ref: '#/components/schemas/PlannedChangeInstanceDeviceMember' + description: Specifies the member devices. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetPlannedChangeInstanceMembersResponse + PlannedChangeInstanceDeviceMember: + title: PlannedChangeInstanceDeviceMember + type: object + properties: + AgentDeviceId: + type: string + description: Gets or sets the agent device identifier. + Name: + type: string + description: Gets or sets the name. + description: Device that is a Member of a Planned Change Instance. + GetPlannedChangesInstancesResponse: + title: GetPlannedChangesInstancesResponse + required: + - Version + type: object + properties: + PlannedChangeInstances: + type: array + items: + $ref: '#/components/schemas/PlannedChangeInstance' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + PlannedChangeInstance: + title: PlannedChangeInstance + required: + - InstanceId + type: object + properties: + Version: + type: integer + description: Gets the version + format: int32 + x-nullable: false + Disabled: + type: boolean + description: Specifies a value indicating whether the instance is currently disabled. This will prevent it being used by the EventCorrelationProcessor and also prevent it being shown in the UI as an option for adding events + x-nullable: false + DisallowRules: + type: boolean + description: 'Specifies a value indicating whether the underlying planned change is allowed to have rules, or is a just container for manually added events.' + x-nullable: false + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + DisplayName: + type: string + description: Specifies the Display Name. + PlannedChangeName: + type: string + description: Specifies the planned change definition name. + PlannedChangeDisplayName: + type: string + description: Specifies the planned change definition's display name. + PlannedChange: + $ref: '#/components/schemas/PlannedChangeDefinition' + Description: + type: string + description: Specifies the description. + Origin: + type: string + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + StartTimeUtc: + type: string + description: Specifies the UTC start time of the instance. + format: date-time + x-nullable: false + EndTimeUtc: + type: string + description: Specifies the UTC end time of the instance. + format: date-time + x-nullable: false + Started: + type: boolean + description: Specifies a value indicating whether the planned change has been started. This indicates that actions taken when the planned change is entered for the first time have been performed. + x-nullable: false + Ended: + type: boolean + description: Specifies a value indicating whether the planned change has been ended. This indicates that actions taken when the planned change is exited for the first time have been performed. + x-nullable: false + UseAttributeRules: + type: boolean + description: Used to trigger the new file hash based attribute rule generation. Eventually this will be the norm and this property can be removed. + x-nullable: false + MemberGroups: + type: array + items: + type: string + description: Specifies the names of member groups. + GroupLookup: + type: array + items: + $ref: '#/components/schemas/MemberDetail' + description: Gets or sets the group lookup. + AgentDeviceLookup: + type: array + items: + $ref: '#/components/schemas/MemberDetail' + description: Gets or sets the agent device lookup. + MemberAgentDeviceIds: + type: array + items: + type: string + description: Specifies the ids of member devices. + MemberGroupsWithInherit: + type: array + items: + type: string + description: Specifies the member groups including child groups of explicitly specified groups. + AssignedTo: + type: string + description: Specifies the Assigned To Name. + PeriodicityCount: + type: integer + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + format: int32 + x-nullable: false + PeriodicityUnit: + type: string + description: Specifies a value indicating the periodicity unit. + PeriodDurationCount: + type: integer + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + format: int32 + x-nullable: false + PeriodDurationUnit: + type: string + description: Specifies a value indicating the period duration unit. + CreationDateUtc: + type: string + description: Specifies a the creation date in UTC. + format: date-time + x-nullable: false + LastModifiedDateUtc: + type: string + description: Specifies a the last modified date in UTC. + format: date-time + x-nullable: false + description: A planned change instance represents a planned change active in a specific time period for a set of devices. + PlannedChangeDefinition: + title: PlannedChangeDefinition + type: object + properties: + Version: + type: integer + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + format: int32 + x-nullable: false + Name: + type: string + description: Specifies the internally identifying name. + DisplayName: + type: string + description: Specifies the display name. + Description: + type: string + description: Specifies the description text. + Origin: + type: string + description: 'Specifies the origin of the planned change ruleset. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + CreationDateUtc: + type: string + description: Specifies the UTC creation date of the planned change. + format: date-time + x-nullable: false + LastModifiedDateUtc: + type: string + description: Specifies the UTC last modified date of the planned change. + format: date-time + x-nullable: false + DisallowRules: + type: boolean + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + x-nullable: false + Rules: + $ref: '#/components/schemas/Dictionary_String_PlannedChangeRule_' + RuleCombinationOperator: + type: string + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the'Rules'. + description: A named Planned Change definition. + MemberDetail: + title: MemberDetail + type: object + properties: + Id: + type: string + description: Gets and Sets the Member Detail Id + Name: + type: string + description: Gets or sets the name. + description: summary + GetPlannedChangeInstancesNameValueResponse: + title: GetPlannedChangeInstancesNameValueResponse + required: + - Version + type: object + properties: + PlannedChangeInstances: + type: array + items: + $ref: '#/components/schemas/PlannedChangeInstanceNameValue' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'Describes planned change instances, filtered by name, id or groups that are members.' + PlannedChangeInstanceNameValue: + title: PlannedChangeInstanceNameValue + required: + - InstanceId + type: object + properties: + InstanceId: + type: string + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + DisplayName: + type: string + description: Specifies the Display Name. + description: Represents the Display Name and Id of a planned change only. + AddOrUpdatePlannedChangeInstanceFromEventsResponse: + title: AddOrUpdatePlannedChangeInstanceFromEventsResponse + type: object + properties: + IsPreview: + type: boolean + description: 'Specifies a value indicating whether the values returned on this object are a preview, or have really been created, ''AddPlannedChangeInstanceFromEvents.PreviewOnly''.' + x-nullable: false + PlannedChange: + $ref: '#/components/schemas/PlannedChangeDefinition' + PlannedChangeInstance: + $ref: '#/components/schemas/PlannedChangeInstance' + description: AddOrUpdatePlannedChangeInstanceFromEventsResponse + GetPlannedChangesResponse: + title: GetPlannedChangesResponse + required: + - Version + type: object + properties: + PlannedChanges: + type: array + items: + $ref: '#/components/schemas/PlannedChangeDefinition' + description: Specifies the planned changes. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Specifies returned a planned change definitions. + AnalyzePlannedChangeResponse: + title: AnalyzePlannedChangeResponse + required: + - Version + type: object + properties: + RuleIdsReplaced: + type: array + items: + type: string + RuleReductionPlans: + type: array + items: + $ref: '#/components/schemas/RuleReductionPlan2' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: AnalyzePlannedChangeResponse + ParseCommandResponse: + title: ParseCommandResponse + type: object + properties: + Success: + type: boolean + x-nullable: false + ErrorMessage: + type: string + Summaries: + type: array + items: + $ref: '#/components/schemas/ParserResultSummary' + SpecificLanguageDetail: + type: string + OriginalCommandLineText: + type: string + description: ParseCommandResponse + ParserResultSummary: + title: ParserResultSummary + type: object + properties: + Name: + type: string + Results: + type: array + items: + $ref: '#/components/schemas/ParserResults' + Successful: + type: boolean + x-nullable: false + FailureMessage: + type: string + SortedCommandElements: + type: array + items: + $ref: '#/components/schemas/CommandElement' + description: ParserResultSummary + ParserResults: + title: ParserResults + type: object + properties: + ParserName: + type: string + FailureElementType: + type: string + FailureElement: + $ref: '#/components/schemas/CommandElement' + Message: + type: string + Keyword: + $ref: '#/components/schemas/CommandElement' + VariableAssignments: + type: array + items: + $ref: '#/components/schemas/CommandElement' + FileOutputRedirects: + type: array + items: + $ref: '#/components/schemas/CommandElement' + description: ParserResults + CommandElement: + title: CommandElement + type: object + properties: + ElementText: + type: string + LineNumber: + type: integer + format: int32 + x-nullable: false + ColumnStartIndex: + type: integer + format: int32 + x-nullable: false + ColumnEndIndex: + type: integer + format: int32 + x-nullable: false + CommandElementType: + type: string + FailureElementType: + type: string + ExistsInWhitelist: + type: boolean + x-nullable: false + FailureMessage: + type: string + description: CommandElement + WhitelistCommandComponentResponse: + title: WhitelistCommandComponentResponse + required: + - Version + type: object + properties: + Success: + type: boolean + x-nullable: false + ErrorMessage: + type: string + CommandComponents: + $ref: '#/components/schemas/IReadOnlyCollection_WhitelistedCommandComponent_' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The paging response base. + IReadOnlyCollection_WhitelistedCommandComponent_: + title: IReadOnlyCollection`1 + type: object + description: IReadOnlyCollection + CommandComponentTemplateResponse: + title: CommandComponentTemplateResponse + required: + - Version + type: object + properties: + Success: + type: boolean + x-nullable: false + ErrorMessage: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: CommandComponentTemplateResponse + GetAllCommandComponentTemplatesResponse: + title: GetAllCommandComponentTemplatesResponse + required: + - Version + type: object + properties: + Success: + type: boolean + x-nullable: false + ErrorMessage: + type: string + TemplateNames: + $ref: '#/components/schemas/IReadOnlyCollection_String_' + CommandComponentId: + type: string + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The paging response base. + GetAllCommandComponentsTemplatesResponse: + title: GetAllCommandComponentsTemplatesResponse + required: + - Version + type: object + properties: + Success: + type: boolean + x-nullable: false + ErrorMessage: + type: string + TemplateNames: + $ref: '#/components/schemas/IReadOnlyCollection_String_' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetAllCommandComponentsTemplatesResponse + GetCloudTemplateCreationStatusResponse: + title: GetCloudTemplateCreationStatusResponse + required: + - Version + type: object + properties: + CloudSystemName: + type: string + DefaultMasterAgentDeviceId: + type: string + DefaultMasterAgentName: + type: string + ActualMasterAgentDeviceId: + type: string + ActualMasterAgentName: + type: string + ActualMasterAgentOnline: + type: boolean + x-nullable: false + RootGroupName: + type: string + RootGroupDisplayName: + type: string + CloudSystemGroupName: + type: string + CloudSystemGroupDisplayName: + type: string + CloudSystemGroupExists: + type: boolean + x-nullable: false + CloudSystemGroupMembersCount: + type: integer + format: int32 + x-nullable: false + CloudSystemAgentDeviceId: + type: string + CloudSystemAgentExists: + type: boolean + x-nullable: false + CloudSystemAgentOnline: + type: boolean + x-nullable: false + CloudSystemCredentialKey: + type: string + CloudSystemCredentialExists: + type: boolean + x-nullable: false + CloudSystemCredentialTestStatus: + type: string + CloudSystemCredentialTestResult: + type: string + PolicyTemplateName: + type: string + ReportSpecId: + type: string + PolicyDeleted: + type: boolean + x-nullable: false + PolicyIsTrusted: + type: boolean + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetCloudTemplateCreationStatusResponse + SetupPolicyTemplateResponse: + title: SetupPolicyTemplateResponse + required: + - Version + type: object + properties: + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: SetupPolicyTemplateResponse + GetPolicyTemplateCreationStatusResponse: + title: GetPolicyTemplateCreationStatusResponse + required: + - Version + type: object + properties: + PolicyTemplateName: + type: string + RootGroupName: + type: string + RootGroupDisplayName: + type: string + SourceGroupName: + type: string + SourceGroupDisplayName: + type: string + SourceGroupExists: + type: boolean + x-nullable: false + SourceGroupHasPolicyTemplate: + type: boolean + x-nullable: false + SourceGroupMembersCount: + type: integer + format: int32 + x-nullable: false + SourceGroupConfigDateUtc: + type: string + format: date-time + x-nullable: false + MembersGroupName: + type: string + MembersGroupDisplayName: + type: string + MembersGroupExists: + type: boolean + x-nullable: false + MembersGroupMembersCount: + type: integer + format: int32 + x-nullable: false + RulesConfigured: + type: integer + format: int32 + x-nullable: false + TrackersConfigured: + type: integer + format: int32 + x-nullable: false + TrackerNames: + type: array + items: + type: string + SourceAgentDeviceId: + type: string + SourceAgentName: + type: string + SourceAgentHasConfig: + type: boolean + x-nullable: false + SourceAgentIsBaselineSource: + type: boolean + x-nullable: false + SourceAgentHasBaselined: + type: boolean + x-nullable: false + MemberAgentDeviceId: + type: string + MemberAgentName: + type: string + ReportSpecId: + type: string + NotificationRefId: + type: string + HasBaselineEverRun: + type: boolean + x-nullable: false + PolicyDeleted: + type: boolean + x-nullable: false + PolicyIsTrusted: + type: boolean + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetPolicyTemplateCreationStatusResponse + GetMostRecentPolicyResultsResponse: + title: GetMostRecentPolicyResultsResponse + required: + - Version + type: object + properties: + Results: + type: array + items: + $ref: '#/components/schemas/PolicyRunDetail' + ComplianceDistribution: + type: array + items: + $ref: '#/components/schemas/ChartDataPoint' + GroupRiskDistribution: + type: array + items: + $ref: '#/components/schemas/ChartDataPoint' + GroupName: + type: string + GroupDisplayName: + type: string + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Response to a request for matching config templates. + PolicyRunDetail: + title: PolicyRunDetail + type: object + properties: + GroupDisplayName: + type: string + description: Specifies the group display name associated with the result + PolicyTemplateName: + type: string + PolicyVersion: + type: string + RunDateUtc: + type: string + format: date-time + x-nullable: false + GroupName: + type: string + description: Specifies the group id associated with the result + FirstAgentDeviceId: + type: string + description: Specifies the first agent in the group + TimeLineDefaultStartUtc: + type: string + description: The suggested default start date for viewing results of this policy run + format: date-time + x-nullable: false + TimeLineDefaultEndUtc: + type: string + description: The suggested default end date for viewing results of this policy run + format: date-time + x-nullable: false + NotificationRefIds: + type: array + items: + type: string + description: Gets or sets the notification reference ids for the policy. + NotificationStatus: + type: string + AverageScore: + type: number + format: double + x-nullable: false + LastAverageScore: + type: number + format: double + x-nullable: false + PassMark: + type: number + format: double + x-nullable: false + DevicesCurrentlyInGroup: + type: integer + format: int32 + x-nullable: false + DeviceTotal: + type: integer + format: int32 + x-nullable: false + DevicesPassed: + type: integer + format: int32 + x-nullable: false + DevicesFailed: + type: integer + format: int32 + x-nullable: false + DevicesNotRun: + type: integer + format: int32 + x-nullable: false + ScoreDistribution: + type: array + items: + $ref: '#/components/schemas/ScoreBand' + DevicesImproved: + type: integer + format: int32 + x-nullable: false + DevicesSame: + type: integer + format: int32 + x-nullable: false + DevicesDeteriorated: + type: integer + format: int32 + x-nullable: false + ReportInstanceId: + type: string + LastPassMark: + type: number + format: double + x-nullable: false + LastDeviceTotal: + type: integer + format: int32 + x-nullable: false + LastDevicesPassed: + type: integer + format: int32 + x-nullable: false + LastDevicesFailed: + type: integer + format: int32 + x-nullable: false + LastDevicesNotRun: + type: integer + format: int32 + x-nullable: false + LastPolicyTemplateName: + type: string + LastPolicyVersion: + type: string + LastDateUtc: + type: string + format: date-time + LastRunDateUtc: + type: string + format: date-time + LastReportInstanceId: + type: string + Risk: + type: string + RiskScore: + type: string + NumericRiskScore: + type: integer + format: int32 + x-nullable: false + Compliant: + type: boolean + x-nullable: false + SetupComplete: + type: boolean + x-nullable: false + SetupMessage: + type: string + ReportSpecId: + type: string + HasRunData: + type: boolean + x-nullable: false + description: Represents the results of applying a policy report to a group of devices + ScoreBand: + title: ScoreBand + type: object + properties: + Lower: + type: number + format: double + x-nullable: false + Upper: + type: number + format: double + x-nullable: false + DeviceCount: + type: integer + format: int32 + x-nullable: false + description: ScoreBand + ChartDataPoint: + title: ChartDataPoint + type: object + properties: + Category: + type: string + Value: + type: string + description: ChartDataPoint + AddPolicyTemplateRulesResponse: + title: AddPolicyTemplateRulesResponse + required: + - Version + type: object + properties: + ActionsTaken: + type: array + items: + type: string + FailureHint: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: AddPolicyTemplateRulesResponse + AddPolicyTemplateResponse: + title: AddPolicyTemplateResponse + type: object + properties: + PreviousVersion: + type: string + Version: + type: string + WasUploaded: + type: boolean + x-nullable: false + IsActive: + type: boolean + x-nullable: false + IsSystem: + type: boolean + x-nullable: false + IsTrusted: + type: boolean + x-nullable: false + Message: + type: string + description: Response to adding a device policy template to the system. + UploadPolicyTemplateResponse: + title: UploadPolicyTemplateResponse + required: + - Version + type: object + properties: + AddPolicyTemplateResponses: + type: array + items: + $ref: '#/components/schemas/AddPolicyTemplateResponse' + description: Specifies a the list of policy template summaries that were created from the uploaded files. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: UploadPolicyTemplateResponse + GetAgentProcessesResponse: + title: GetAgentProcessesResponse + required: + - Version + type: object + properties: + TaskId: + type: integer + format: int32 + x-nullable: false + Message: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Describes the list of running processes on a device. + StartAgentTrackerResponse: + title: StartAgentTrackerResponse + required: + - Version + type: object + properties: + TaskId: + type: integer + format: int32 + x-nullable: false + Message: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: StartAgentTrackerResponse + GetAgentServicesResponse: + title: GetAgentServicesResponse + required: + - Version + type: object + properties: + TaskId: + type: integer + format: int32 + x-nullable: false + Message: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Describes the list of running services on a device. + GetGroupPolicyResponse: + title: GetGroupPolicyResponse + required: + - Version + type: object + properties: + Templates: + type: array + items: + $ref: '#/components/schemas/PolicyTemplateDetails' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response to the request for configured policy templates on the group. + AddGroupPolicyResponse: + title: AddGroupPolicyResponse + required: + - Version + type: object + properties: + Templates: + type: array + items: + $ref: '#/components/schemas/PolicyTemplateDetails' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response to the request to add a configured policy template to the group. + GetAgentsRankedResponse: + title: GetAgentsRankedResponse + required: + - Version + type: object + properties: + AgentCredentials: + type: array + items: + $ref: '#/components/schemas/AgentCredential' + description: Specifies a list of agent device -> credentials. + AgentGroups: + type: array + items: + $ref: '#/components/schemas/AgentGroups' + description: Specifies a list of agent device -> group memberships. + GroupsLookup: + type: array + items: + $ref: '#/components/schemas/KeyValuePair_String_String_' + description: Specifies a lookup list of group key -> display name. + TemplatesLookup: + type: array + items: + $ref: '#/components/schemas/KeyValuePair_String_String_' + description: Specifies a lookup list of template key -> display name. + AgentPlannedChangeStatuses: + type: array + items: + $ref: '#/components/schemas/AgentPlannedChangeInstanceStatus' + description: Specifies a list of agent device -> planned change statuses (returned here to make subsequent calls unnecessary in UI - the data is all stored in the same object in the repository so no signficant cost in getting it out) + Agents: + type: array + items: + $ref: '#/components/schemas/DeviceReportDetail' + description: Specifies the agents matching the 'GetAgents' request. + AgentTemplates: + type: array + items: + $ref: '#/components/schemas/AgentTemplates' + description: Specifies agent device -> templates + RelatedProxyAgents: + type: array + items: + $ref: '#/components/schemas/Agent' + description: 'Specifies the related proxy agents. These are the agents that proxy the devices listed in ''Agents'', if any.' + ResultsGeneratedAtUtc: + type: string + description: Specifies time the results were generated at in utc. + format: date-time + x-nullable: false + StatsPeriod: + type: integer + description: Specifies the id of the stats period the device event counts were retrieved from. + format: int64 + x-nullable: false + StatsPeriodStartUtc: + type: string + description: Specifies the Utc start date of the stats period the device event counts were retrieved from. + format: date-time + x-nullable: false + StatsPeriodEndUtc: + type: string + description: Specifies the Utc end date of the stats period the device event counts were retrieved from. + format: date-time + x-nullable: false + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response objeect for GetAgentsRanked + KeyValuePair_String_String_: + title: 'KeyValuePair' + type: object + properties: + Key: + type: string + Value: + type: string + description: 'KeyValuePair' + GroupMembersResponse: + title: GroupMembersResponse + required: + - Version + type: object + properties: + GroupMembers: + type: array + items: + $ref: '#/components/schemas/GroupMember' + description: Specifies the group members. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response to group members request. + GroupMember: + title: GroupMember + type: object + properties: + Version: + type: integer + description: Gets the version. + format: int32 + x-nullable: false + GroupName: + type: string + description: Gets or sets the name of the group. + MemberType: + type: string + description: Specifies the member type of the member specified by MemberName (AgentDevice or Group). + MemberName: + type: string + description: Gets or sets the member name. Note that when this is an Agent Device the Member Name is the encoded Agent:Device pair. + GroupRiskScore: + type: string + description: Specifies the risk score of the group. + description: A group member. + GetGroupsResponse: + title: GetGroupsResponse + required: + - Version + type: object + properties: + Groups: + type: array + items: + $ref: '#/components/schemas/Group' + description: The list of returned groups. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response to a get groups request. + Group: + title: Group + type: object + properties: + Version: + type: integer + description: Gets the version. + format: int32 + x-nullable: false + Name: + type: string + description: Gets or sets the Group name. + DisplayName: + type: string + description: Gets or sets the Group's display name. + GroupType: + type: integer + description: Gets or sets the type of the group. + format: int32 + AgentUpdateSchedule: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' + DeviceSettings: + $ref: '#/components/schemas/DeviceSettingsPartial' + IsSystem: + type: boolean + description: summary + x-nullable: false + Members: + type: array + items: + type: string + description: The group names that are members of this group. + Templates: + type: array + items: + $ref: '#/components/schemas/ScheduledPolicyTemplate' + description: ' Gets or sets the Group''s policy templates.' + RiskScore: + type: string + description: Specifies the risk score of the group. + NotifyUsers: + type: array + items: + type: string + description: Gets or sets the list of users to notify. + LastActivityTimeUtc: + type: string + description: 'Gets or sets the last activity utc time, this is the time the groups templates of memberships were last changed.' + format: date-time + x-nullable: false + MemberOf: + type: array + items: + type: string + description: Parent groups of this group. + LastConfigRelatedChangeDateUtc: + type: string + format: date-time + x-nullable: false + description: A group. + DeviceSettingsPartial: + title: DeviceSettingsPartial + type: object + properties: + FileLiveTrackingRequiresBaselineCompletion: + type: boolean + description: Gets or sets the file live tracking requires baseline completion flag. + description: 'The partial device settings represents the device specific options such as customised local ui password details, and tracker performance settings stored on a specific group. The Device Settings for a specific device are derived from a set of these.' + ScheduledPolicyTemplate: + title: ScheduledPolicyTemplate + type: object + properties: + GroupName: + type: string + description: Specifies the group name. + StartTimeUtc: + type: string + description: Specifies the UTC start time of the schedule. + format: date-time + x-nullable: false + EndTimeUtc: + type: string + description: Specifies the UTC end time of the schedule. + format: date-time + x-nullable: false + PeriodicityMinutes: + type: integer + description: Specifies the periodicity of execution of a compliance report in minutes. + format: int32 + x-nullable: false + PolicyTemplateName: + type: string + description: Specifies the policy template name. + NextRunTimeUtc: + type: string + description: Specifies the next run time utc. + format: date-time + LastRunTimeUtc: + type: string + description: Specifies the last run time utc. + format: date-time + CurrentResultEventId: + type: string + description: Specifies the current result event id. + LastResultEventId: + type: string + description: Specifies the last result event id. + WaitForCompletionUntilUtc: + type: string + description: 'Specifies the utc time to wait until, for completion of the current set of tasks.' + format: date-time + Status: + type: string + description: Specifies the status. + TaskIds: + type: array + items: + type: integer + format: int32 + x-nullable: false + description: Specifies the task ids. + AbandonTasksOnTimeout: + type: boolean + description: Specifies a value indicating whether to abandon unfinished tasks on on scheduled policy timeout. + x-nullable: false + PassMark: + type: number + description: Specifies the default pass mark associated with compliance report TemplateType. + format: double + x-nullable: false + PolicyRunId: + type: integer + description: Specifies the policy run id associated with the last run of the report etc. This id is also stored on the relevant tasks. + format: int32 + description: The scheduled policy template associated with a group and run on a schedule. This is a DTO used to return detailed information about a scheduled policy on a group. + GetGroupsTreeResponse: + title: GetGroupsTreeResponse + required: + - Groups + type: object + properties: + Groups: + type: array + items: + $ref: '#/components/schemas/GroupTreeItem' + description: The list of top level groups + description: A returned tree structure representing the groups hierarchy. + GroupTreeItem: + title: GroupTreeItem + type: object + properties: + DisplayName: + type: string + description: Gets or sets the display name of the Group Tree Item. + IsSystem: + type: boolean + description: Gets or sets a value indicating whether this object is system. + x-nullable: false + ParentCount: + type: integer + description: Gets or sets a value indicating the number of parent groups this group is a child of. + format: int32 + x-nullable: false + Name: + type: string + description: Gets or sets the group tree item name. + Groups: + type: array + items: + $ref: '#/components/schemas/GroupTreeItem' + description: Gets or sets the list of GroupTreeItems. + RiskScore: + type: string + description: Specifies the risk score of the group. + description: A group tree item. + AddGroupResponse: + title: AddGroupResponse + required: + - Version + type: object + properties: + Name: + type: string + description: The name of the new group + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Represents a response to adding a new group + GetOverdueDevicesResponse: + title: GetOverdueDevicesResponse + required: + - Version + type: object + properties: + Devices: + type: array + items: + type: string + description: The devices that have not polled in for the specified amount of time. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Lists devices that have not polled in for the specified amount of time. + DeleteDevicePermanentlyResponse: + title: DeleteDevicePermanentlyResponse + required: + - Version + type: object + properties: + Challenge: + type: string + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + GetDeviceFiltersResponse: + title: GetDeviceFiltersResponse + required: + - Version + type: object + properties: + DeviceFilters: + type: List + items: + $ref: '#/components/schemas/DeviceFilter' + description: Contains the list of zero or more DeviceFilter definitions matching the request criteria + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response to a get defvice filters request. + TestAgentCredentialsResponse: + title: TestAgentCredentialsResponse + required: + - Version + type: object + properties: + TaskId: + type: integer + format: int32 + x-nullable: false + Message: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: TestAgentCredentialsResponse + IpAddressBlockingStatus: + title: IpAddressBlockingStatus + type: object + properties: + IpAddress: + type: string + description: Gets or sets the IP address. + BlockedDueTo: + type: string + description: Gets or sets the reason the ip address is blocked. IpAddressActivityType.NotBlocked means not blocked. + ExpiresUtc: + type: string + description: Gets or sets the Date/Time UTC when the status expires. + format: date-time + x-nullable: false + Count: + type: integer + description: Gets or sets the count. + format: int32 + x-nullable: false + UserName: + type: string + description: 'Gets or sets the name of the user. ' + description: 'The ip address blocking status represents the reason why an ipaddress is blocked, based on analysis of the stored blocking details.' + List_IpAddressBlockingStatus_: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + DiscoverDevicesResponse: + title: DiscoverDevicesResponse + required: + - Version + type: object + properties: + TaskId: + type: integer + format: int32 + x-nullable: false + DiscoveredDeviceType: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: DiscoverDevicesResponse + GetEventHistoryResponse: + title: GetEventHistoryResponse + required: + - Version + type: object + properties: + EventId: + type: string + description: Specifies the event id. + HistoryItems: + type: array + items: + $ref: '#/components/schemas/HistoryItem' + description: A list of history items associated with this event. + Total: + type: integer + description: Gets or sets the number of history items + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Describes an event's history. + HistoryItem: + title: HistoryItem + type: object + properties: + DateUtc: + type: string + description: Specifies the date (UTC) the action took place. + format: date-time + x-nullable: false + Message: + type: string + description: Specifies the action that took palce at the specified time. + description: Describes a specific item of event history. + GetEventDeviceGroupsResponse: + title: GetEventDeviceGroupsResponse + required: + - Version + type: object + properties: + GroupNames: + type: array + items: + type: string + description: Gets or sets the group names. + AgentDeviceIds: + type: array + items: + type: string + description: Gets or sets the agent device ids. + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Represents the list of groups that the devices associated with the given events are members of. + GetInventoryResponse: + title: GetInventoryResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/InventoryItem' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The paging response base. + GetAgentInventoryItemsGroupedResponse: + title: GetAgentInventoryItemsGroupedResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/AgentInventoryItemGrouped' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The paging response base. + AgentInventoryItemGrouped: + title: AgentInventoryItemGrouped + type: object + properties: + Id: + type: string + Version: + type: integer + format: int32 + x-nullable: false + InventoryItemName: + type: string + InventoryItemVersion: + type: string + InventoryItemCpeMatchStatus: + type: string + InventoryItemCpeName: + type: string + AgentsTotal: + type: integer + format: int32 + x-nullable: false + IsOperatingSystemItem: + type: boolean + x-nullable: false + description: AgentInventoryItemGrouped + GetAgentInventoryAgentsDetailResponse: + title: GetAgentInventoryAgentsDetailResponse + required: + - Version + type: object + properties: + Items: + type: array + items: + $ref: '#/components/schemas/AgentDetail' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The paging response base. + AgentDetail: + title: AgentDetail + type: object + properties: + AgentDeviceId: + type: string + DeviceName: + type: string + AgentVersion: + type: string + description: AgentDetail + GetVulnerabilityOverviewResponse: + title: GetVulnerabilityOverviewResponse + required: + - Version + type: object + properties: + SoftwareVulnerabilityScoresV3: + $ref: '#/components/schemas/Dictionary_String_Double_' + SoftwareVulnerabilityScoresV2: + $ref: '#/components/schemas/Dictionary_String_Double_' + DeviceVulnerabilityScoresV3: + $ref: '#/components/schemas/Dictionary_String_Double_' + VulnerabilityScoresV2: + $ref: '#/components/schemas/Dictionary_String_Double_' + VulnerabilityScoresV3: + $ref: '#/components/schemas/Dictionary_String_Double_' + DeviceVulnerabilityScoresV2: + $ref: '#/components/schemas/Dictionary_String_Double_' + CveChanges: + type: array + items: + $ref: '#/components/schemas/CveSummary' + description: Specifies a list of recent CVE Changes. + HighRiskSoftwareItems: + type: array + items: + $ref: '#/components/schemas/SoftwareItem' + description: 'Specifies a list of high risk software items. A software item is considered high risk if it has a known cve of critical or high V3 severity, or high V2 severity' + IgnoredCves: + type: array + items: + $ref: '#/components/schemas/CveSummary' + description: Specifies a list of ignored CVE. + Status: + $ref: '#/components/schemas/GetVulnerabilityScanStatusResponse' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetVulnerabilityOverview + SoftwareItem: + title: SoftwareItem + type: object + properties: + SoftwareId: + type: string + SoftwareName: + type: string + SoftwareVersion: + type: string + CpeName: + type: string + MatchStatus: + type: string + GoodMatchCpeSummary: + $ref: '#/components/schemas/CpeSummary' + RelatedCpeSummaries: + type: array + items: + $ref: '#/components/schemas/CpeSummary' + VulnerabilityCount: + type: integer + format: int32 + x-nullable: false + description: SoftwareItem + CpeSummary: + title: CpeSummary + type: object + properties: + MatchStrength: + type: number + format: float + x-nullable: false + CpeName: + type: string + CveSummaries: + type: array + items: + $ref: '#/components/schemas/CveSummary' + description: CpeSummary + GetVulnerabilityScanStatusResponse: + title: GetVulnerabilityScanStatusResponse + required: + - Version + type: object + properties: + InventoryItemsInQueue: + type: integer + format: int32 + x-nullable: false + InventoryItemMatchStatusCounts: + $ref: '#/components/schemas/Dictionary_String_Int32_' + Message: + type: string + AllQuiet: + type: boolean + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetVulnerabilityStatus + Dictionary_String_Int32_: + title: 'Dictionary' + type: object + additionalProperties: + type: integer + format: int32 + x-nullable: false + description: 'Dictionary' + GetVulnerabilityResponse: + title: GetVulnerabilityResponse + required: + - Version + type: object + properties: + CveItems: + type: array + items: + $ref: '#/components/schemas/CveItem' + description: Specifies a list of CVEs. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetVulnerability + CveItem: + title: CveItem + type: object + properties: + CveMatchStatus: + type: string + IsDeleted: + type: boolean + x-nullable: false + BaseMetricV2: + $ref: '#/components/schemas/BaseMetricV2Definition' + BaseMetricV3: + $ref: '#/components/schemas/BaseMetricV3Definition' + ReferenceData: + type: array + items: + $ref: '#/components/schemas/CveReferenceData' + Version: + type: integer + format: int32 + x-nullable: false + ChangeHistory: + type: array + items: + $ref: '#/components/schemas/CveHistory' + IgnoredUntilDateUtc: + type: string + format: date-time + x-nullable: false + IsIgnored: + type: boolean + x-nullable: false + CveId: + type: string + CpeName: + type: string + V3Severity: + type: string + V2Severity: + type: string + CveChangeDateUtc: + type: string + format: date-time + x-nullable: false + CveDescription: + type: string + NvdDetailsLink: + type: string + V2BaseScore: + type: number + format: float + x-nullable: false + V3BaseScore: + type: number + format: float + x-nullable: false + description: CveItem + BaseMetricV2Definition: + title: BaseMetricV2Definition + type: object + properties: + CvssV2: + $ref: '#/components/schemas/CvssVersionV2' + Severity: + type: string + ExploitabilityScore: + type: number + format: double + ImpactScore: + type: number + format: double + AcInsufficientInfo: + type: boolean + x-nullable: false + ObtainAllPrivilege: + type: boolean + x-nullable: false + ObtainUserPrivilege: + type: boolean + x-nullable: false + ObtainOtherPrivilege: + type: boolean + x-nullable: false + UserInteractionRequired: + type: boolean + x-nullable: false + description: BaseMetricV2Definition + CvssVersionV2: + title: CvssVersionV2 + type: object + properties: + Version: + type: string + VectorString: + type: string + AccessVector: + type: string + AccessComplexity: + type: string + Authentication: + type: string + ConfidentialityImpact: + type: string + IntegrityImpact: + type: string + AvailabilityImpact: + type: string + BaseScore: + type: number + format: double + Exploitability: + type: string + RemediationLevel: + type: string + ReportConfidence: + type: string + TemporalScore: + type: number + format: double + CollateralDamagePotential: + type: string + TargetDistribution: + type: string + ConfidentialityRequirement: + type: string + IntegrityRequirement: + type: string + EnvironmentalScore: + type: number + format: double + description: CvssVersionV2 + BaseMetricV3Definition: + title: BaseMetricV3Definition + type: object + properties: + CvssV3: + $ref: '#/components/schemas/CvssVersionV3x' + ExploitabilityScore: + type: number + format: double + ImpactScore: + type: number + format: double + description: BaseMetricV3Definition + CvssVersionV3x: + title: CvssVersionV3x + type: object + properties: + Version: + type: string + VectorString: + type: string + AttackVector: + type: string + AttackComplexity: + type: string + PrivilegesRequired: + type: string + UserInteraction: + type: string + Scope: + type: string + ConfidentialityImpact: + type: string + IntegrityImpact: + type: string + AvailabilityImpact: + type: string + BaseScore: + type: number + format: double + BaseSeverity: + type: string + ExploitCodeMaturity: + type: string + RemediationLevel: + type: string + ReportConfidence: + type: string + TemporalScore: + type: number + format: double + TemporalSeverity: + type: string + ConfidentialityRequirement: + type: string + IntegrityRequirement: + type: string + AvailabilityRequirement: + type: string + ModifiedAttackVector: + type: string + ModifiedAttackComplexity: + type: string + ModifiedPrivilegesRequired: + type: string + ModifiedUserInteraction: + type: string + ModifiedScope: + type: string + ModifiedConfidentialityImpact: + type: string + ModifiedIntegrityImpact: + type: string + ModifiedAvailabilityImpact: + type: string + EnvironmentalScore: + type: number + format: double + EnvironmentalSeverity: + type: string + description: CvssVersionV3x + CveReferenceData: + title: CveReferenceData + type: object + properties: + Url: + type: string + Name: + type: string + RefSource: + type: string + Tags: + type: array + items: + type: string + description: CveReferenceData + GetSoftwareVulnerabilityResponse: + title: GetSoftwareVulnerabilityResponse + required: + - Version + type: object + properties: + SoftwareItems: + type: array + items: + $ref: '#/components/schemas/SoftwareItem' + description: Specifies a list of recent CVE Changes. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetSoftwareVulnerability + GetSoftwareVulnerabilityDetailResponse: + title: GetSoftwareVulnerabilityDetailResponse + required: + - Version + type: object + properties: + CvesList: + type: array + items: + $ref: '#/components/schemas/CveItem' + description: Specifies a list of recent CVE Changes. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetSoftwareVulnerabilityDetail + GetDeviceVulnerabilityResponse: + title: GetDeviceVulnerabilityResponse + required: + - Version + type: object + properties: + VulnerableDevices: + type: array + items: + $ref: '#/components/schemas/VulnerableDevice' + description: Specifies a list of recent CVE Changes. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetDeviceVulnerability + VulnerableDevice: + title: VulnerableDevice + type: object + properties: + DeviceName: + type: string + VulnerableSoftwareCount: + type: integer + format: int32 + x-nullable: false + VulnerabilityCount: + type: integer + format: int32 + x-nullable: false + AgentDeviceId: + type: string + description: VulnerableDevice + GetDeviceVulnerabilityDetailResponse: + title: GetDeviceVulnerabilityDetailResponse + required: + - Version + type: object + properties: + CvesList: + type: array + items: + $ref: '#/components/schemas/CveItem' + description: Specifies a list of recent CVE Changes. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetDeviceVulnerabilityDetail + GetCvesForRelatedCpesResponse: + title: GetCvesForRelatedCpesResponse + required: + - Version + type: object + properties: + CvesList: + type: array + items: + $ref: '#/components/schemas/CveItem' + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetCvesForRelatedCpes + GetVulnerableDeviceDetailResponse: + title: GetVulnerableDeviceDetailResponse + required: + - Version + type: object + properties: + VulnerableDevices: + type: array + items: + $ref: '#/components/schemas/Agent' + description: Specifies a list of vulnerable devices. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response object for GetDeviceVulnerabilityDetail + GetAllLog4NetConfigItemsResponse: + title: GetAllLog4NetConfigItemsResponse + type: object + properties: + LoggerConfigs: + type: array + items: + $ref: '#/components/schemas/Log4NetLoggerConfig' + description: The list of log4net logger configurations + description: Response for getting log4net configuration items + Log4NetLoggerConfig: + title: Log4NetLoggerConfig + type: object + properties: + Id: + type: string + LoggerName: + type: string + LogLevel: + type: string + description: Log4NetLoggerConfig + AddLog4NetConfigItemResponse: + title: AddLog4NetConfigItemResponse + type: object + properties: + Success: + type: boolean + x-nullable: false + LoggerConfig: + $ref: '#/components/schemas/Log4NetLoggerConfig' + description: AddLog4NetConfigItemResponse + UpdateLog4NetConfigItemResponse: + title: UpdateLog4NetConfigItemResponse + type: object + properties: + Success: + type: boolean + x-nullable: false + LoggerConfig: + $ref: '#/components/schemas/Log4NetLoggerConfig' + description: UpdateLog4NetConfigItemResponse + DeleteLog4NetConfigItemResponse: + title: DeleteLog4NetConfigItemResponse + type: object + properties: + Success: + type: boolean + x-nullable: false + description: DeleteLog4NetConfigItemResponse + GetLog4NetConfigItemsResponse: + title: GetLog4NetConfigItemsResponse + required: + - Version + type: object + properties: + LoggerConfigs: + type: array + items: + $ref: '#/components/schemas/Log4NetLoggerConfig' + description: The list of log4net logger configurations + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Response for getting log4net configuration items with pagination support + ResponseStatus: + title: ResponseStatus + type: object + properties: + ErrorCode: + type: string + Message: + type: string + StackTrace: + type: string + Errors: + type: array + items: + $ref: '#/components/schemas/ResponseError' + Meta: + $ref: '#/components/schemas/Dictionary_String_String_' + description: ResponseStatus + ResponseError: + title: ResponseError + type: object + properties: + ErrorCode: + type: string + FieldName: + type: string + Message: + type: string + Meta: + $ref: '#/components/schemas/Dictionary_String_String_' + description: ResponseError + ReportChangeDetail: + title: ReportChangeDetail + type: object + properties: + RuleTitle: + type: string + DidPass: + type: boolean + x-nullable: false + DoesPass: + type: boolean + x-nullable: false + ChangeReason: + type: string + description: Specifies the changes between two report runs on an individual rule basis. + List_ReportChangeDetail_: + title: List + type: array + items: + $ref: '#/components/schemas/ReportChangeDetail' + GetReportDataResponse: + title: GetReportDataResponse + required: + - Version + type: object + properties: + ReportId: + type: string + ReportData: + type: array + items: + $ref: '#/components/schemas/ReportRuleResult' + ReportName: + type: string + ReportSummary: + type: string + ReportScore: + type: number + format: double + x-nullable: false + RunDateUtc: + type: string + format: date-time + x-nullable: false + AgentDevice: + $ref: '#/components/schemas/AgentDevice' + DeviceName: + type: string + DisaggregationEnabled: + type: boolean + x-nullable: false + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: A returned list of report results for displaying in a grid. + ReportRuleResult: + title: ReportRuleResult + type: object + properties: + SectionTitle: + type: string + CategoryTitle: + type: string + SubCategoryTitle: + type: string + RuleNumber: + type: string + RuleTitle: + type: string + IsExcluded: + type: boolean + x-nullable: false + Score: + type: number + format: double + x-nullable: false + RulePasses: + type: boolean + x-nullable: false + ResultDetail: + type: string + RuleDescription: + type: string + TextDifferences: + type: array + items: + $ref: '#/components/schemas/TextDifference' + DiffPlainTextExpected: + type: string + DiffPlainTextActual: + type: string + SectionTextTitle: + type: string + SectionText: + type: string + SectionTextIcon: + type: string + CategoryTextTitle: + type: string + CategoryText: + type: string + CategoryTextIcon: + type: string + SubCategoryTextTitle: + type: string + SubCategoryText: + type: string + SubCategoryTextIcon: + type: string + ScoreType: + type: integer + format: int32 + x-nullable: false + Severity: + type: string + description: ReportRuleResult + GetAvailableReportsResponse: + title: GetAvailableReportsResponse + required: + - Version + type: object + properties: + ReportMetadata: + type: array + items: + $ref: '#/components/schemas/ReportMetadata' + description: Specifies the list of available reports. + Total: + type: integer + description: The total number of rows in the result set. + format: int64 + x-nullable: false + Returned: + type: integer + description: The number of rows returned. + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Describes the available reports for the specified devices. + DashboardLayout: + title: DashboardLayout + type: object + properties: + Id: + type: string + description: The identifier of the dashboard. + Name: + type: string + description: The name of the dashboard. + IsSystem: + type: boolean + description: Indicates whether the dashboard is system-defined. + x-nullable: false + Widgets: + type: array + items: + $ref: '#/components/schemas/DashboardWidgetSpec' + description: The widgets. + description: Details of a specific dashboard layout. + SaveUserDashboardResponse: + title: SaveUserDashboardResponse + type: object + properties: + Id: + type: string + description: The identifier of the dashboard. + description: Response to the SaveUserDashboard request. + GetUserSettingsResponse: + title: GetUserSettingsResponse + type: object + properties: + HasChangedPassword: + type: boolean + description: Has the current user changed their password from any system assigned one? + x-nullable: false + DashboardId: + type: string + description: The user's default dashboard identifier. + DashboardsAvailable: + type: array + items: + $ref: '#/components/schemas/DashboardSummary' + description: The custom and system dashboards available to the user. + ThemesAvailable: + type: array + items: + $ref: '#/components/schemas/ThemeSummary' + description: The system themes available to the user. + ThemeId: + type: string + description: The user's theme identifier. + TimeZoneId: + type: string + description: The user's time zone identifier. + DateFormats: + $ref: '#/components/schemas/UserDateFormats' + HideWelcomePopup: + type: boolean + description: Indicates whether the user has opted to skip the welcome wizard. + x-nullable: false + description: Response to the GetUserSettings request. + DashboardSummary: + title: DashboardSummary + type: object + properties: + Id: + type: string + description: The identifier of the dashboard. + Name: + type: string + description: The name of the dashboard. + IsSystem: + type: boolean + description: Indicates whether the dashboard is system-defined. + x-nullable: false + IsPublic: + type: boolean + description: Indicates whether the dashboard is visible to all users. + x-nullable: false + Order: + type: integer + description: The order in which the dashboard should be presented in a list. + format: int32 + x-nullable: false + description: Represents a dashboard for presentation in a list. + ThemeSummary: + title: ThemeSummary + type: object + properties: + Id: + type: string + description: The identifier of the theme. + Name: + type: string + description: The name of the theme. + Css: + type: array + items: + type: string + description: The theme-specific stylesheets required. + description: Details of a specific system theme. + GetDashboardWidgetsResponse: + title: GetDashboardWidgetsResponse + type: object + properties: + Widgets: + type: array + items: + $ref: '#/components/schemas/DashboardWidgetSpec' + description: The widgets. + description: Response to the GetDashboardWidgets request. + GetUserTwoFactorStatusResponse: + title: GetUserTwoFactorStatusResponse + required: + - Version + type: object + properties: + ChangePasswordByUtc: + type: string + format: date-time + SetupCode: + type: string + SetupImageUrl: + type: string + TwoFactorRequired: + type: boolean + x-nullable: false + TwoFactorRegistration: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: Response to the GetUserTwoFactorStatus request. + AuthenticateResponse: + title: AuthenticateResponse + type: object + properties: + UserId: + type: string + SessionId: + type: string + UserName: + type: string + DisplayName: + type: string + ReferrerUrl: + type: string + BearerToken: + type: string + RefreshToken: + type: string + RefreshTokenExpiry: + type: string + format: date-time + ProfileUrl: + type: string + Roles: + type: array + items: + type: string + Permissions: + type: array + items: + type: string + AuthProvider: + type: string + ResponseStatus: + $ref: '#/components/schemas/ResponseStatus' + Meta: + $ref: '#/components/schemas/Dictionary_String_String_' + description: AuthenticateResponse + ResetUserPasswordResponse: + title: ResetUserPasswordResponse + required: + - Version + type: object + properties: + Password: + type: string + ChangeByDateUtc: + type: string + format: date-time + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: ResetUserPasswordResponse + PreviewResetUserPasswordResponse: + title: PreviewResetUserPasswordResponse + required: + - Version + type: object + properties: + Password: + type: string + PreviewToken: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: PreviewResetUserPasswordResponse + TimeZoneDetail: + title: TimeZoneDetail + type: object + properties: + Id: + type: string + CountryCode: + type: string + description: A time zone name and id. + List_TimeZoneDetail_: + title: List + type: array + items: + $ref: '#/components/schemas/TimeZoneDetail' + List_GroupAlert_: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAlert' + List_UserDetails_: + title: List + type: array + items: + $ref: '#/components/schemas/UserDetails' + GetUserRolesResponse: + title: GetUserRolesResponse + required: + - Version + type: object + properties: + Roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + Total: + type: integer + format: int64 + x-nullable: false + Returned: + type: integer + format: int32 + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: GetUserRolesResponse + UserRole: + title: UserRole + required: + - Name + - DisplayName + - Permissions + - ReadOnly + type: object + properties: + Name: + type: string + description: Specifies the unique internal name for the role. + DisplayName: + type: string + description: Specifies the display name for the role. + ExternalName: + type: string + description: Specifies the role name in an external identity provider that corresponds to this role. + Permissions: + type: array + items: + type: string + description: Specifies the list of names of permissions associated with the role. + ReadOnly: + type: boolean + description: 'Specifies whether the role is read only, or can be edited.' + x-nullable: false + description: UserRole + AddUserRoleResponse: + title: AddUserRoleResponse + required: + - Version + type: object + properties: + Roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: AddUserRoleResponse + UpdateUserRoleResponse: + title: UpdateUserRoleResponse + required: + - Version + type: object + properties: + Roles: + type: array + items: + $ref: '#/components/schemas/UserRole' + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: UpdateUserRoleResponse + GetLicenseInfoResponse: + title: GetLicenseInfoResponse + required: + - Version + type: object + properties: + Description: + type: string + description: Gets or sets the description. + Details: + type: string + description: Gets or sets the license details. + LicensedDevices: + type: integer + description: Gets or sets the licensed devices. + format: int32 + x-nullable: false + LicensingType: + type: string + description: Gets or sets the type of the licensing. + Valid: + type: boolean + description: Gets or sets a value indicating whether the license info is valid. + x-nullable: false + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The response to a request to get an Organization's license info. + GetRolesAndPermissionsResponse: + title: GetRolesAndPermissionsResponse + required: + - Version + type: object + properties: + UserName: + type: string + OrganisationName: + type: string + Roles: + type: array + items: + type: string + Permissions: + type: array + items: + type: string + Flags: + type: array + items: + type: string + Features: + $ref: '#/components/schemas/Dictionary_String_String_' + HasValidLicense: + type: boolean + x-nullable: false + TimeZoneId: + type: string + TwoFactorEnabled: + type: boolean + x-nullable: false + TwoFactorRegistration: + type: string + Version: + type: integer + description: Specifies the response version. This indicates the service model version the response complies with. + format: int32 + x-nullable: false + description: The roles and permissions for the user. + GetAccessTokenResponse: + title: GetAccessTokenResponse + type: object + properties: + AccessToken: + type: string + Meta: + $ref: '#/components/schemas/Dictionary_String_String_' + ResponseStatus: + $ref: '#/components/schemas/ResponseStatus' + description: GetAccessTokenResponse + parameters: + Accept: + name: Accept + in: header + description: Accept Header + required: true + schema: + enum: + - application/json + type: string + securitySchemes: + Bearer: + type: apiKey + name: Authorization + in: header +tags: + - name: acknowledgeEvents + - name: addDeviceConfigProcessRules + - name: agentInventoryAgentsDetail + - name: agentInventoryGrouped + - name: agentProcesses + - name: agents + - name: agentServices + - name: agentSoftwareUpdateSchedules + - name: agentsRanked + - name: agentUpdates + - name: alertEvents + - name: auth + - name: availableReports + - name: baselineEvents + - name: cloudTemplate + - name: command + - name: commandParser + - name: configItem + - name: configItems + - name: credential + - name: credentials + - name: credentialsKeyedByType + - name: dashboard + - name: device + - name: deviceConfig + - name: deviceConfigTemplate + - name: deviceConfigTemplateNames + - name: deviceCredentials + - name: deviceDbCredentials + - name: deviceEvents + - name: deviceFilter + - name: deviceFilters + - name: deviceHostType + - name: deviceName + - name: deviceOnlineStatus + - name: devicePolicyTemplate + - name: devices + - name: deviceSettings + - name: discoverDevices + - name: discoveredDevices + - name: downloadAgentUpdate + - name: downloadFileHash + - name: downloadFileHashById + - name: event + - name: eventDeviceGroups + - name: events + - name: exportAgents + - name: exportUserNotifications + - name: getFileHashBinaries + - name: group + - name: groupAlerts + - name: groupMembers + - name: groupMemberships + - name: groupPolicy + - name: groupPolicyNames + - name: groups + - name: groupsTree + - name: inventory + - name: ipBlocking + - name: licenseInfo + - name: log4netConfigs + - name: misc + - name: openapi3.yaml + - name: organization + - name: permissions + - name: pipelineNodes + - name: plannedChangeInstances + - name: plannedChangeRule + - name: plannedChanges + - name: policyRecent + - name: policyTemplate + - name: policyTemplateAsFile + - name: policyTemplates + - name: policyTemplateVariables + - name: reParentDevices + - name: reportData + - name: reportDescription + - name: reportDifferences + - name: reportExecute + - name: reportRender + - name: reportRenderIsCached + - name: reportRenderStart + - name: reports + - name: resetAdminPassword + - name: resubmitEvents + - name: setCommentsForEvents + - name: startAgentTracker + - name: stats + - name: status + - name: submitAgentTaskResult + - name: submitAgentTaskResultData + - name: submitAgentTaskResultStream + - name: syncServiceConfigItems + - name: testAgentCredentials + - name: testAuditorConnection + - name: testFastConnection + - name: testFastCustomerConnection + - name: testServiceNowConnection + - name: testSmtpConnection + - name: testSyslogConnection + - name: timezones + - name: updatehubdetails + - name: uploadAgentUpdate + - name: uploadPolicyTemplate + - name: userDashboard + - name: userHasChangedPassword + - name: userRoles + - name: userRolesPermisions + - name: userRolesPermissions + - name: users + - name: userSettings + - name: vulnerabilityscanstatus \ No newline at end of file