diff --git a/.github/workflows/openapi-dedup.yml b/.github/workflows/openapi-dedup.yml new file mode 100644 index 0000000000..30a6cfd20d --- /dev/null +++ b/.github/workflows/openapi-dedup.yml @@ -0,0 +1,89 @@ +name: OpenAPI Method Dedup + +on: + pull_request: + types: [opened, synchronize] + branches: + - dev + paths: + - 'static/openapi/**.yaml' + - 'static/openapi/**.yml' + +concurrency: + group: openapi-dedup-${{ github.event.pull_request.number }} + +jobs: + dedup: + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: read + steps: + - name: Check if triggered by this workflow's own commit + id: bot-check + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + COMMIT=$(gh api repos/${{ github.repository }}/commits/${{ github.event.pull_request.head.sha }} \ + --jq '{author: .commit.author.name, message: .commit.message}') + MESSAGE=$(echo "$COMMIT" | jq -r '.message') + if echo "$MESSAGE" | grep -qE '^chore\(openapi\): deduplicate'; then + echo "Skipping: commit is from openapi-dedup workflow" + echo "skip=true" >> "$GITHUB_OUTPUT" + else + echo "skip=false" >> "$GITHUB_OUTPUT" + fi + + - name: Checkout PR branch + if: steps.bot-check.outputs.skip != 'true' + uses: actions/checkout@v4 + with: + ref: ${{ github.event.pull_request.head.ref }} + token: ${{ secrets.VALE_TOKEN }} + + - name: Configure git identity + if: steps.bot-check.outputs.skip != 'true' + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + + - name: Set up Node.js + if: steps.bot-check.outputs.skip != 'true' + uses: actions/setup-node@v4 + with: + node-version: '22' + cache: 'npm' + + - name: Install dependencies + if: steps.bot-check.outputs.skip != 'true' + run: npm ci --ignore-scripts + + - name: Run deduplication + id: dedup + if: steps.bot-check.outputs.skip != 'true' + run: | + OUTPUT=$(node scripts/deduplicate-openapi-methods.mjs) + echo "$OUTPUT" + if echo "$OUTPUT" | grep -q 'already clean'; then + echo "changed=false" >> "$GITHUB_OUTPUT" + else + echo "changed=true" >> "$GITHUB_OUTPUT" + echo "summary=$OUTPUT" >> "$GITHUB_OUTPUT" + fi + + - name: Commit and push deduplicated spec + if: steps.bot-check.outputs.skip != 'true' && steps.dedup.outputs.changed == 'true' + env: + VALE_TOKEN: ${{ secrets.VALE_TOKEN }} + run: | + git add static/openapi/ + git commit -m "chore(openapi): deduplicate HTTP methods in Change Tracker Hub spec + + ${{ steps.dedup.outputs.summary }} + + Generated with AI + + Co-Authored-By: Claude Code " + + git remote set-url origin "https://x-access-token:${VALE_TOKEN}@github.com/${{ github.repository }}.git" + git push diff --git a/.gitignore b/.gitignore index 8843ebfc08..35a0279893 100644 --- a/.gitignore +++ b/.gitignore @@ -22,9 +22,9 @@ docs/*/*/kb/** # Generated by npx docusaurus gen-api-docs (docusaurus-plugin-openapi-docs) # Ignore all generated files but keep _category_.json which is hand-authored -docs/changetracker/8.1/integration/api/reference/* -!docs/changetracker/8.1/integration/api/reference/_category_.json -!docs/changetracker/8.1/integration/api/reference/index.md +docs/changetracker/8.1/api/reference/* +!docs/changetracker/8.1/api/reference/_category_.json +!docs/changetracker/8.1/api/reference/index.md # KB copy script lockfile .kb-copy.lock diff --git a/docs/changetracker/8.1/api/CLAUDE.md b/docs/changetracker/8.1/api/CLAUDE.md new file mode 100644 index 0000000000..4bd14ed57d --- /dev/null +++ b/docs/changetracker/8.1/api/CLAUDE.md @@ -0,0 +1,90 @@ +# CLAUDE.md — Change Tracker 8.1 API Reference + +This file provides guidance for working in `docs/changetracker/8.1/api/`. + +## Directory layout + +``` +api/ +├── CLAUDE.md # This file +├── _category_.json # Sidebar label and position for the API section +├── overview.md # Hand-authored API overview +├── agents.md # Hand-authored: agentsRanked endpoint guide +├── authentication.md # Hand-authored: auth flow and PowerShell example +├── credentials.md # Hand-authored: credentials CRUD endpoints +├── register-agents.md # Hand-authored: agent registration endpoint +└── reference/ # Generated from OpenAPI spec — see below + ├── _category_.json # Tracked; triggers structured sidebar injection + ├── index.md # Tracked; hand-authored intro for the reference + ├── sidebar.ts # Generated; loaded by products.js + └── *.mdx / *.json # Generated; gitignored +``` + +## OpenAPI spec + +**Source:** `static/openapi/changetracker-hub-8.1.yaml` + +This spec is auto-generated by ASP.NET Swashbuckle. A key consequence: Swashbuckle exposes both GET and POST on virtually every endpoint (GET takes query-string params, POST takes a form body — same operation, different parameter-passing conventions). The generated reference would otherwise list every endpoint twice. + +### Deduplication + +`scripts/deduplicate-openapi-methods.mjs` removes the semantically incorrect method from each dual-method endpoint (keeps GET for reads, POST for mutations). It is: + +- **Idempotent** — if the spec is already clean, it exits without touching the file. +- **Automatic in CI** — the `openapi-dedup` GitHub Actions workflow runs it whenever the YAML changes in a PR and commits the result back to the branch. +- **Automatic on every build** — wired into `prestart`, `prebuild`, and `preci` in `package.json`, so it always runs before `gen-api-docs`. + +**17 endpoints intentionally keep both GET and POST** (auth flows, downloads, report rendering, and two `commandParser` endpoints where GET and POST do genuinely different things). These are listed in the `KEEP_BOTH` set at the top of the script. + +When the API team ships a new spec, no manual action is needed — push the YAML and the CI workflow handles the rest. For a full local refresh (dedup + clean stale pages + regenerate): + +```bash +npm run openapi:sync +``` + +## Regenerating the reference locally + +The MDX files under `reference/` are gitignored (except `_category_.json` and `index.md`) and regenerated at build time. To regenerate manually: + +```bash +# Full refresh — use when the OpenAPI spec has changed +npm run openapi:sync + +# Quick regenerate only (no clean, no dedup — safe for minor changes) +npx docusaurus gen-api-docs changetracker-hub +``` + +**`clean-api-docs` deletes `reference/_category_.json`** — `npm run openapi:sync` restores it automatically via `git checkout`. If you run `clean-api-docs` manually, restore it with: + +```bash +git checkout -- docs/changetracker/8.1/api/reference/_category_.json +``` + +## Sidebar integration + +`reference/_category_.json` has `"customProps": { "isGeneratedApiSidebar": true }`. The `sidebarItemsGenerator` in `src/config/products.js` detects this flag and replaces the category's children with the structured sidebar from `reference/sidebar.ts` (loaded via `loadApiSidebarItems`). + +The `transformApiSidebarLabels` function in `products.js`: +- Converts camelCase category labels to Title Case (e.g. `agentsRanked` → `Agents Ranked`) +- Strips trailing periods from operation labels + +The `changetracker-hub` info page (an auto-generated landing page with a misaligned URL and label) is filtered out of the sidebar in `products.js`: + +```js +.filter(item => !(item.type === 'doc' && item.id?.endsWith('/changetracker-hub'))) +``` + +The `parseFrontMatter` hook in `docusaurus.config.js` also strips trailing periods from `title` and `sidebar_label` in generated MDX frontmatter (for the browser tab and breadcrumb). The root cause — trailing periods in OpenAPI `summary` fields — has been fixed directly in the YAML, so these hooks are now a safety net for future spec updates. + +## Auth scheme + +The security scheme is `type: http` / `scheme: bearer`. This renders the interactive explorer panel as **"AUTHORIZATION: HTTP"** with a **Bearer Token** input field, and auto-prepends `Bearer ` to the value. Do not change it back to `type: apiKey` — that shows a confusingly labeled plain-text input. + +## MDX gotchas + +- **Angle-bracket placeholders** like `` are parsed as JSX tags in MDX and cause build errors. Always wrap them in backticks: `` `https:///api` ``. +- **Code fences** in hand-authored files must have a language specifier (`json`, `powershell`, `bash`, etc.) — bare ` ``` ` fences are flagged by linting. + +## Product name + +Always **Change Tracker** (two words). Never `ChangeTracker`. diff --git a/docs/changetracker/8.1/integration/api/_category_.json b/docs/changetracker/8.1/api/_category_.json similarity index 86% rename from docs/changetracker/8.1/integration/api/_category_.json rename to docs/changetracker/8.1/api/_category_.json index f42792eb78..8078417f11 100644 --- a/docs/changetracker/8.1/integration/api/_category_.json +++ b/docs/changetracker/8.1/api/_category_.json @@ -1,6 +1,6 @@ { "label": "API", - "position": 20, + "position": 115, "collapsed": true, "collapsible": true, "link": { diff --git a/docs/changetracker/8.1/integration/api/agents.md b/docs/changetracker/8.1/api/agents.md similarity index 91% rename from docs/changetracker/8.1/integration/api/agents.md rename to docs/changetracker/8.1/api/agents.md index a96a84b3a4..bcfb47728d 100644 --- a/docs/changetracker/8.1/integration/api/agents.md +++ b/docs/changetracker/8.1/api/agents.md @@ -6,7 +6,7 @@ sidebar_position: 10 # Agents -To pull data on agent statues, configurations and group memberships, use the agentsRanked endpoint. +To pull data on agent statuses, configurations, and group memberships, use the agentsRanked endpoint. ## /api/agentsRanked @@ -14,9 +14,9 @@ This call returns a list of agent details, including group and tracking template ### POST Request -https://api/agentsRanked +`https:///api/agentsRanked` -``` +```json {     "DeviceFilter":    { @@ -40,12 +40,12 @@ DeviceFilter GetAgentGroupDetails -- Specifies a value indicating whether to get agent group details. +- Specifies whether to get agent group details. - Type – Boolean GetRelatedTemplates -- Specifies a value indicating whether to get templates applied to the returned agents. +- Specifies whether to get templates applied to the returned agents. - Type – Boolean #### DeviceFilter @@ -65,7 +65,7 @@ AgentDeviceIds AgentDisplayNames - Filters by display names -- Type –: Comma separated list of strings +- Type – Comma separated list of strings - Example – ["NWX-4GMJGX3", "Azure 365 Cloud Reporting Group"] OnlineStatuses @@ -76,10 +76,10 @@ OnlineStatuses ExcludeProxiedDevices -- A value indicating whether to exclude proxied devices from the result set +- Specifies whether to exclude proxied devices from the result set - Type – Boolean -### Json Response Elements +### JSON Response Elements - AgentGroups – A list of agent device group memberships - GroupsLookup – A lookup list of group id/key to display name @@ -90,7 +90,7 @@ ExcludeProxiedDevices ### Example PowerShell -The following PowerShell script will output the response to a CSV file with the following headers: +The following PowerShell script outputs the response to a CSV file with the following headers: - DeviceName - FQDN @@ -103,10 +103,9 @@ The following PowerShell script will output the response to a CSV file with the - IPv4 - OnlineStatus -To be able to trust self-signed certificates, each call to Invoke-RestMethod is made with the --SkipCertificateCheck argument. This requires PowerShell 7. +To trust self-signed certificates, each call to `Invoke-RestMethod` uses the `-SkipCertificateCheck` argument. This requires PowerShell 7. -``` +```powershell # Declare script parameters and their default values. Override these defaults from the command line e.g. -HostUrl http://myliveserver/api param([string]$HostUrl = "https://localhost/api", [string]$AdminUser = "admin", [string]$AdminPwd = "password") # This script is intended to read and display agent details, including group and tracking templates diff --git a/docs/changetracker/8.1/integration/api/authentication.md b/docs/changetracker/8.1/api/authentication.md similarity index 70% rename from docs/changetracker/8.1/integration/api/authentication.md rename to docs/changetracker/8.1/api/authentication.md index f042c89deb..4d6a6d0779 100644 --- a/docs/changetracker/8.1/integration/api/authentication.md +++ b/docs/changetracker/8.1/api/authentication.md @@ -1,16 +1,16 @@ --- title: "Authentication" description: "Authentication" -sidebar_position: 10 +sidebar_position: 20 --- # Authentication -The following PowerShell script is an example of how to authenticate to the ChangeTracker API. -It prompts the user for the URL and credentials. It also asks wether to skip certificate validation or not and then creates a new session. -Trusted certificates are recommended for all environments, but if you are using self-signed certificates in a lab environment, you have the option to skip certificate validation. +The following PowerShell script shows how to authenticate to the Change Tracker API. +It prompts for the URL, asks whether to skip certificate validation, then collects the user's credentials and creates a new session. +Netwrix recommends trusted certificates for all environments, but if you are using self-signed certificates in a lab environment, you can skip certificate validation. -The variable ```$NctSession``` is used to store the session information and can be used to make subsequent API calls. +The `$NctSession` variable stores the session information for use in subsequent API calls. ```powershell diff --git a/docs/changetracker/8.1/integration/api/credentials.md b/docs/changetracker/8.1/api/credentials.md similarity index 85% rename from docs/changetracker/8.1/integration/api/credentials.md rename to docs/changetracker/8.1/api/credentials.md index 0bce066be8..c923effc04 100644 --- a/docs/changetracker/8.1/integration/api/credentials.md +++ b/docs/changetracker/8.1/api/credentials.md @@ -1,16 +1,16 @@ --- title: "Credentials" -description: "Credentials API for managing authentication credentials in ChangeTracker" -sidebar_position: 10 +description: "Credentials API for managing authentication credentials in Change Tracker" +sidebar_position: 30 --- # Credentials ## Overview -The Credentials API allows you to 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. +Use the Credentials API to manage authentication credentials that Change Tracker 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. -Credentials are identified by a unique key and include various parameters specific to the credential type. The API requires authentication and the `CredentialsManage` permission to perform operations. +Each credential has a unique key and includes parameters specific to the credential type. The API requires authentication and the `CredentialsManage` permission to perform operations. ## Endpoints @@ -134,11 +134,11 @@ Requires authentication and the `CredentialsManage` permission. | type | string | Yes | Type of credentials to delete | **Response** -Returns a success status code (200) if the credentials were successfully deleted. +Returns a success status code (200) when the deletion succeeds. ## Credential Types -The following credential types are supported: +Change Tracker supports the following credential types: | Type | Description | |------|-------------| diff --git a/docs/changetracker/8.1/integration/api/overview.md b/docs/changetracker/8.1/api/overview.md similarity index 65% rename from docs/changetracker/8.1/integration/api/overview.md rename to docs/changetracker/8.1/api/overview.md index 6296f3b9b4..8f19676a5c 100644 --- a/docs/changetracker/8.1/integration/api/overview.md +++ b/docs/changetracker/8.1/api/overview.md @@ -6,15 +6,15 @@ sidebar_position: 20 # API -Netwrix Change Tracker provides a comprehensive REST API that customers can use to integrate with the platform programmatically. This is particularly useful for customers who run multiple instances of Netwrix Change Tracker in multiple regions, as they can use the API to pull data from each instance and build global reports containing data from all instances. +Netwrix Change Tracker provides a comprehensive REST API that customers can use to integrate with the platform programmatically. This is particularly useful for customers who run multiple instances of Netwrix Change Tracker in multiple regions, as they can use the API to pull data from each instance and build global reports. ## Authentication -All API endpoints require authentication. See [Authentication](/docs/changetracker/8.1/integration/api/authentication.md) for an example script. +All API endpoints require authentication. See [Authentication](/docs/changetracker/8.1/api/authentication.md) for an example script. ## API Reference -For an 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. +For an interactive reference of all Netwrix Change Tracker Hub API endpoints, see the [Netwrix Change Tracker Hub API Reference](/docs/changetracker/8_1/api/reference/). This reference comes from the Change Tracker Hub (the central management server) OpenAPI 3.0 spec and covers 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). @@ -22,11 +22,11 @@ The raw OpenAPI 3.0 spec (YAML) is also [available for download](/openapi/change 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. Use this API to retrieve detailed information about all agents in your environment, including their group memberships and applied tracking templates. +- [Agents](/docs/changetracker/8.1/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) – 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. +- [Register Agents](/docs/changetracker/8.1/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 that Change Tracker 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. +- [Credentials](/docs/changetracker/8.1/api/credentials.md) – Manage authentication credentials that Change Tracker 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 diff --git a/docs/changetracker/8.1/integration/api/reference/_category_.json b/docs/changetracker/8.1/api/reference/_category_.json similarity index 100% rename from docs/changetracker/8.1/integration/api/reference/_category_.json rename to docs/changetracker/8.1/api/reference/_category_.json diff --git a/docs/changetracker/8.1/integration/api/reference/index.md b/docs/changetracker/8.1/api/reference/index.md similarity index 71% rename from docs/changetracker/8.1/integration/api/reference/index.md rename to docs/changetracker/8.1/api/reference/index.md index 14b5d039d5..39185135a9 100644 --- a/docs/changetracker/8.1/integration/api/reference/index.md +++ b/docs/changetracker/8.1/api/reference/index.md @@ -4,7 +4,7 @@ description: "Introduction to the Change Tracker Hub API Reference" sidebar_position: 1 --- -The Change Tracker Hub API Reference documents every REST API endpoint that the Change Tracker Hub (the central management server) exposes. The Hub generates this reference directly from its OpenAPI 3.0 specification, which reflects the API for version 8.1. +The Change Tracker Hub API Reference documents every REST API endpoint that the Change Tracker Hub (the central management server) exposes. This reference comes from the Change Tracker Hub's OpenAPI 3.0 specification, which reflects the API for version 8.1. Use this reference to: @@ -21,16 +21,16 @@ The reference groups endpoints by tag (functional area). Each endpoint page incl All endpoints require authentication. Before you can send requests — whether from the interactive explorer or your own code — you need a valid session. -See [Authentication](/docs/changetracker/8.1/integration/api/authentication.md) for a PowerShell example that authenticates to the Hub and stores the session for subsequent calls. +See [Authentication](/docs/changetracker/8.1/api/authentication.md) for a PowerShell example that authenticates to the Hub and stores the session for subsequent calls. ## Use the interactive explorer Each endpoint page includes a built-in API explorer. To use it: -1. Obtain a session token by calling `POST /auth/credentials`. See [Authentication](/docs/changetracker/8.1/integration/api/authentication.md). -2. Click **Authorize** at the top of any endpoint page. -3. Enter your token in the **Bearer** field and click **Authorize**. -4. Open an endpoint, fill in the required parameters, and click **Send API Request**. +1. Obtain a session token by calling `POST /auth/credentials`. See [Authentication](/docs/changetracker/8.1/api/authentication.md). +2. On any endpoint page, in the right-hand request panel, scroll to the **Auth** section. +3. Enter your token in the **Bearer Token** field. The explorer applies the token automatically to all requests on the page. +4. Fill in the required parameters and click **Send API Request**. :::tip Before sending a request, you can edit the server URL directly in the explorer to point to your Change Tracker Hub instance. diff --git a/docs/changetracker/8.1/integration/api/register-agents.md b/docs/changetracker/8.1/api/register-agents.md similarity index 81% rename from docs/changetracker/8.1/integration/api/register-agents.md rename to docs/changetracker/8.1/api/register-agents.md index ba4a00ccf8..1667c6be52 100644 --- a/docs/changetracker/8.1/integration/api/register-agents.md +++ b/docs/changetracker/8.1/api/register-agents.md @@ -1,16 +1,16 @@ --- title: "Register Agents" -description: "Agent Registration API for managing device agents in ChangeTracker" -sidebar_position: 11 +description: "Agent Registration API for managing device agents in Change Tracker" +sidebar_position: 40 --- # Register Agents ## Overview -The Agent Registration API allows you to register and manage agents with the ChangeTracker system. This API provides endpoints for registering new agents, which can be either direct agents installed on devices or proxied devices accessed through another agent. The API handles various device types including servers, desktops, network devices, and databases. +Use the Agent Registration API to register and manage agents with the Change Tracker system. This API provides endpoints for registering new agents, which can be either direct agents installed on devices or proxied devices accessed through another agent. The API handles various device types including servers, desktops, network devices, and databases. -Agents are identified by a unique AgentDevice ID and include various parameters such as device name, host type, operating system details, and network information. The API requires authentication and the `DeviceRegister` permission to perform operations. +Each agent has a unique AgentDevice ID and includes parameters such as device name, host type, operating system details, and network information. The API requires authentication and the `DeviceRegister` permission to perform operations. ## Endpoints @@ -60,10 +60,10 @@ Requires authentication and the `DeviceRegister` permission. |-----------|------|----------|-------------| | AgentName | string | No | The name of the agent | | CanProxy | boolean | No | Specifies whether the agent can proxy connections to other devices | -| CredentialKey | string | No | Specifies the credential key (only allowed for proxied devices) | +| CredentialKey | string | No | Specifies the credential key (proxied devices only) | | DeviceName | string | No | Specifies the device name | | DeviceType | enum | No | Type of device (Unknown, Server, Desktop, Network, Database) | -| GroupNames | array | No | Specifies the group names (only allowed for proxied devices) | +| GroupNames | array | No | Specifies the group names (proxied devices only) | | HostName | string | No | Specifies the host name or IP address used for agentless access | | HostType | enum | No | Specifies the host type (Unknown, Unix, Windows, Network, Database, Cloud, ESX, Splunk) | | MacAddresses | string | No | Specifies the MAC addresses | @@ -73,11 +73,11 @@ Requires authentication and the `DeviceRegister` permission. | DiscoveryId | string | No | Specifies the internal discovery-based ID | | DiscoveryTaskId | string | No | Specifies the internal discovery task ID | | OnlineDetection | enum | No | Specifies the method to use when detecting if a proxied device is online (None, Ping, TcpConnect) | -| Os | string | No | Specifies the Operating System full description as reported by the device | -| KnownOsName | string | No | Specifies the Operating System from the list of known OS names | -| OsUserSpecified | string | No | Specifies the operating system as entered by the user (overrides discovered OS in UI) | +| Os | string | No | Specifies the operating system full description that the device reports | +| KnownOsName | string | No | Specifies the operating system from the list of known OS names | +| OsUserSpecified | string | No | Specifies the operating system that the user enters (overrides discovered OS in UI) | | PollPeriodSeconds | integer | No | Specifies the poll period in seconds | -| ProxiedByAgentId | string | No | Specifies the agent ID of the proxy agent this device will be proxied by | +| ProxiedByAgentId | string | No | Specifies the agent ID of the proxy agent that proxies this device | | Registered | boolean | No | Specifies whether the agent is registered | | UniqueId | string | No | Specifies a value uniquely identifying the agent independent of name or agent ID | | Version | integer | No | Specifies the request version | @@ -141,7 +141,7 @@ Returns an Agent object with the following properties: ## Device Types -The following device types are supported: +Change Tracker supports the following device types: | Type | Description | |------|-------------| @@ -152,7 +152,7 @@ The following device types are supported: ## Host Types -The following host types are supported: +Change Tracker supports the following host types: | Type | Description | |------|-------------| @@ -176,7 +176,7 @@ The following online detection methods are available: ## Agent Types -The following agent types are supported: +Change Tracker supports the following agent types: | Type | Description | |------|-------------| diff --git a/docs/changetracker/8.1/integration/overview.md b/docs/changetracker/8.1/integration/overview.md index 5a19745161..d5417dbbc2 100644 --- a/docs/changetracker/8.1/integration/overview.md +++ b/docs/changetracker/8.1/integration/overview.md @@ -9,7 +9,7 @@ sidebar_position: 110 Netwrix Change Tracker supports the following integrations: - [Netwrix Products](/docs/changetracker/8.1/integration/netwrixproducts/overview.md) -- [API](/docs/changetracker/8.1/integration/api/overview.md) +- [API](/docs/changetracker/8.1/api/overview.md) - [IT Service Management](/docs/changetracker/8.1/integration/itsm/overview.md) - [Splunk](/docs/changetracker/8.1/integration/overview_1.md) - [VMWare](/docs/changetracker/8.1/integration/overview_2.md) diff --git a/docusaurus.config.js b/docusaurus.config.js index 49d5f05202..43a202067c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -57,7 +57,7 @@ const config = { // prev/next pagination label, so this cleans up navigation text site-wide. parseFrontMatter: async (params) => { const result = await params.defaultParseFrontMatter(params); - if (params.filePath.includes('/integration/api/reference/')) { + if (params.filePath.includes('/api/reference/')) { if (result.frontMatter.title) { result.frontMatter.title = result.frontMatter.title.replace(/\.$/, ''); } @@ -173,7 +173,7 @@ const config = { config: { 'changetracker-hub': { specPath: 'static/openapi/changetracker-hub-8.1.yaml', - outputDir: 'docs/changetracker/8.1/integration/api/reference', + outputDir: 'docs/changetracker/8.1/api/reference', sidebarOptions: { groupPathsBy: 'tag', categoryLinkSource: 'tag', @@ -182,7 +182,7 @@ const config = { downloadUrl: '/openapi/changetracker-hub-8.1.yaml', version: '8.1', label: 'ChangeTracker Hub 8.1 API', - baseUrl: '/docs/changetracker/8_1/integration/api/reference/', + baseUrl: '/docs/changetracker/8_1/api/reference/', }, }, }, @@ -208,7 +208,7 @@ const config = { docs: { sidebar: { hideable: true, - autoCollapseCategories: false, + autoCollapseCategories: true, }, }, algolia: { diff --git a/package.json b/package.json index 35d95a6d1e..dd7826d5b2 100644 --- a/package.json +++ b/package.json @@ -5,13 +5,14 @@ "main": "docusaurus.config.js", "scripts": { "docusaurus": "npx docusaurus", - "prestart": "node scripts/copy-kb-to-versions.mjs && npx docusaurus gen-api-docs changetracker-hub", + "prestart": "node scripts/copy-kb-to-versions.mjs && node scripts/deduplicate-openapi-methods.mjs && npx docusaurus gen-api-docs changetracker-hub", "start": "cross-env NODE_OPTIONS=--max-old-space-size=16384 CHOKIDAR_USEPOLLING=false npx docusaurus start --port=4500 --no-open", "start-chok": "cross-env NODE_OPTIONS=--max-old-space-size=16384 CHOKIDAR_USEPOLLING=true npx docusaurus start --port=4500 --no-open", - "prebuild": "node scripts/copy-kb-to-versions.mjs && npx docusaurus gen-api-docs changetracker-hub", + "prebuild": "node scripts/copy-kb-to-versions.mjs && node scripts/deduplicate-openapi-methods.mjs && npx docusaurus gen-api-docs changetracker-hub", "build": "cross-env NODE_OPTIONS=--max-old-space-size=16384 npx docusaurus build", - "preci": "node scripts/copy-kb-to-versions.mjs && npx docusaurus gen-api-docs changetracker-hub", + "preci": "node scripts/copy-kb-to-versions.mjs && node scripts/deduplicate-openapi-methods.mjs && npx docusaurus gen-api-docs changetracker-hub", "ci": "npx docusaurus build", + "openapi:sync": "node scripts/deduplicate-openapi-methods.mjs && npx docusaurus clean-api-docs changetracker-hub && npx docusaurus gen-api-docs changetracker-hub && git checkout -- docs/changetracker/8.1/api/reference/_category_.json", "swizzle": "npx docusaurus swizzle", "clear": "npx docusaurus clear", "serve": "npx docusaurus serve --port 8080 --no-open", diff --git a/scripts/deduplicate-openapi-methods.mjs b/scripts/deduplicate-openapi-methods.mjs new file mode 100644 index 0000000000..bd8a0e215c --- /dev/null +++ b/scripts/deduplicate-openapi-methods.mjs @@ -0,0 +1,162 @@ +/** + * deduplicate-openapi-methods.mjs + * + * Change Tracker Hub's OpenAPI spec (auto-generated by ASP.NET Swashbuckle) + * exposes both GET and POST on virtually every endpoint. This script removes + * the method that doesn't match REST semantics for each endpoint, cutting the + * generated API reference roughly in half. + * + * Conservative rules — when in doubt, keep both: + * 1. Operation summary is the primary signal (wins over path heuristics). + * 2. Path-segment keywords are a fallback when the summary is ambiguous/empty. + * 3. A fixed set of genuinely dual-method endpoints always keep both. + * + * Idempotent: if no duplicate methods are found, the YAML file is not rewritten. + * + * Usage: + * node scripts/deduplicate-openapi-methods.mjs + */ + +import { readFileSync, writeFileSync } from 'fs'; +import { load, dump } from 'js-yaml'; +import { fileURLToPath } from 'url'; +import path from 'path'; + +const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..'); +const YAML_PATH = path.join(ROOT, 'static', 'openapi', 'changetracker-hub-8.1.yaml'); + +// ── Endpoints where GET and POST do genuinely different things ────────────── +const KEEP_BOTH = new Set([ + '/commandParser/whitelist', // GET=retrieve list, POST=add to list + '/commandParser/commandComponent/templates', // GET=retrieve, POST=set + '/auth/{provider}', // GET=OAuth redirect, POST=credential auth + '/auth', + '/access-token', // empty summary — intent unclear + '/cloudTemplate/status', // ambiguous "Provides/Gets" summary + '/policyTemplate/setup', // "Ensures" — could be read or write + '/reportExecute', // vague "Report Service" summary + '/reportRender', + '/reportRenderStart', + // Downloads: some clients POST to carry auth/filter in a body + '/downloadAgentUpdate/{VersionRequested}', + '/downloadAgentUpdate/{VersionRequested}/{UpdateType}', + '/downloadFileHash/{HostType}/{OperatingSystem}/{Variant}', + '/downloadFileHashById/{FileId}', + '/plannedChanges/download', + // Empty summary, no clear path signal + '/reports/ruleresults', + '/stats/compliancesummarydata', +]); + +// ── Summary prefixes that unambiguously mean "mutation → keep POST" ───────── +const MUTATION_SUMMARY = [ + 'add ', 'adds ', 'update ', 'updates ', + 'delete ', 'deletes ', 'remove ', 'removes ', + 'register ', 'registers ', 'submit ', 'submits ', + 'upload ', 'uploads ', 'reset ', 'resets ', + 'save ', 'saves ', 'clone ', 'clones ', + 'create ', 'creates ', 'send ', 'sends ', + 'set ', 'sets ', 'store ', 'stores ', + 'mark ', 'marks ', + 'acknowledge ', 'acknowledges ', + 'invalidate ', 'invalidates ', + 'test ', 'tests ', // test*Connection endpoints trigger external calls + 'attempt ', 'attempts ', + 'used to submit', 'used to add', + 'discover ', 'discovers ', + 'export ', 'exports ', + 're-parents', 'resubmit', + 'ask an agent', // sends a command to a remote agent + 'validates ', // validates a password — sends credentials +]; + +// ── Summary prefixes that unambiguously mean "read → keep GET" ─────────────── +const READ_SUMMARY = [ + 'get ', 'gets ', 'retrieve ', 'retrieves ', + 'return ', 'returns ', + 'list ', 'lists ', + 'fetch ', 'fetches ', + 'requests information', + 'a request to return', + 'a request to get', + 'a request to find', + 'has the current user', + 'echos ', 'echo ', + 'checks whether', + 'called by the agent, this returns', + 'report service', // all vague "Report Service" entries are list/get operations + 'stats service', + 'represents a request to get', + 'sign in', +]; + +// ── Path-segment prefixes used as fallback when summary is ambiguous ───────── +// Intentionally narrow: compound words like addOrUpdate, deleteRule, reevaluateEvents +// all start with a keyword, so startsWith() catches them without regex complexity. +// "start" and "sync" are excluded — too many false positives as path-parameter separators. +const MUTATION_SEGMENTS = [ + 'add', 'update', 'delete', 'register', 'submit', + 'upload', 'save', 'clone', 'create', 'reset', + 'promote', 'reparent', 'reregister', + 'apply', 'export', 'discover', 'resubmit', + 'acknowledge', 'setcomment', 'invalidate', 'ignore', + 'reevaluate', 'start', +]; + +function startsWith(str, prefixes) { + return prefixes.some(p => str.startsWith(p)); +} + +function classify(apiPath, methods) { + if (KEEP_BOTH.has(apiPath)) return 'both'; + + const summary = ((methods.get || {}).summary || '').trim().toLowerCase(); + const segments = apiPath.split('/').filter(s => s && !s.startsWith('{')); + + if (startsWith(summary, MUTATION_SUMMARY)) return 'post'; + if (startsWith(summary, READ_SUMMARY)) return 'get'; + + const isMutationPath = segments.some(seg => + MUTATION_SEGMENTS.some(pfx => seg.toLowerCase().startsWith(pfx)) + ); + if (isMutationPath) return 'post'; + + return 'both'; +} + +// ── Main ───────────────────────────────────────────────────────────────────── + +const text = readFileSync(YAML_PATH, 'utf8'); +const spec = load(text); + +let removedGet = 0; +let removedPost = 0; + +for (const [apiPath, methods] of Object.entries(spec.paths || {})) { + if (!('get' in methods) || !('post' in methods)) continue; + + const decision = classify(apiPath, methods); + if (decision === 'post') { + delete spec.paths[apiPath].get; + removedGet++; + } else if (decision === 'get') { + delete spec.paths[apiPath].post; + removedPost++; + } +} + +if (removedGet === 0 && removedPost === 0) { + console.log('deduplicate-openapi-methods: no duplicate methods found, spec is already clean.'); + process.exit(0); +} + +writeFileSync( + YAML_PATH, + dump(spec, { noRefs: true, lineWidth: -1, sortKeys: false }), + 'utf8' +); + +console.log( + `deduplicate-openapi-methods: removed ${removedGet} GET and ${removedPost} POST operations` + + ` from ${YAML_PATH}` +); diff --git a/src/config/products.js b/src/config/products.js index 85836da6d8..b76679fde3 100644 --- a/src/config/products.js +++ b/src/config/products.js @@ -183,7 +183,7 @@ export const PRODUCTS = [ label: '8.1', isLatest: true, sidebarFile: './sidebars/changetracker/8.1.js', - apiSidebarPath: './docs/changetracker/8.1/integration/api/reference/sidebar.ts', + apiSidebarPath: './docs/changetracker/8.1/api/reference/sidebar.ts', }, { version: '8.0', @@ -861,6 +861,7 @@ export function generateDocusaurusPlugins({ apiSidebars = {} } = {}) { // Transform camelCase tag-category labels (e.g. "agentProcesses") → Title Case ("Agent Processes"). const apiSidebarItems = version.apiSidebarPath ? transformApiSidebarLabels(apiSidebars[version.apiSidebarPath] || []) + .filter(item => !(item.type === 'doc' && item.id?.endsWith('/changetracker-hub'))) : []; // Build plugin configuration diff --git a/static/openapi/changetracker-hub-8.1.yaml b/static/openapi/changetracker-hub-8.1.yaml index de189bd7a7..ad39619749 100644 --- a/static/openapi/changetracker-hub-8.1.yaml +++ b/static/openapi/changetracker-hub-8.1.yaml @@ -3,135 +3,114 @@ info: title: ChangeTracker Hub version: '8.1' servers: - - url: '{serverUrl}' - description: Your Change Tracker server URL - variables: - serverUrl: - default: https://localhost:5001/api - description: 'Full base URL including /api (e.g., https://your-server/api)' +- url: '{serverUrl}' + description: Your Change Tracker server URL + variables: + serverUrl: + default: https://localhost:5001/api + description: Full base URL including /api (e.g., https://your-server/api) paths: - '/command/tasks/poll/{AgentId}': + /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.' + - 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: + - 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: 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 + - 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 @@ -140,137 +119,116 @@ paths: schema: $ref: '#/components/schemas/GetAgentPollResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/agent/{AgentId}': + - $ref: '#/components/parameters/Accept' + /command/tasks/agent/{AgentId}: get: tags: - - command - summary: Requests information about tasks for the given agent. + - 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: + - 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 - - 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: + 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 - - 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: + 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 - - 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 + 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 @@ -279,14 +237,14 @@ paths: schema: $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/submitAgentTaskResultStream/{AgentId}/{DeviceId}/{TaskId}': + - $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. + - 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: @@ -303,74 +261,15 @@ paths: schema: $ref: '#/components/schemas/SubmitAgentTaskResultStreamResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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: @@ -382,105 +281,17 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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: @@ -492,240 +303,198 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /credential: get: tags: - - credential - summary: Get specific credentials for requested type and key (name). + - 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 + - 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).' + 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: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /policyTemplates: get: tags: - - policyTemplates - summary: Gets matching config templates. + - 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: + - 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: 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: + - 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: 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: + - 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: + - 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 - - 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 + 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. @@ -734,56 +503,35 @@ paths: schema: $ref: '#/components/schemas/GetPolicyTemplatesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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 + - 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. @@ -792,53 +540,29 @@ paths: schema: $ref: '#/components/schemas/GetPolicyTemplateVariablesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceCredentials: get: tags: - - deviceCredentials - summary: A request to get the names of credentials associated with an agent. + - 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 + - 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 @@ -850,121 +574,76 @@ paths: items: type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceDbCredentials: get: tags: - - deviceDbCredentials - summary: A request to get the database credentials associated with a database proxied agent. + - 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 + - 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).' + 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: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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 + - 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 @@ -976,111 +655,111 @@ paths: items: type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /agents: get: tags: - - agents - summary: A request to return agents matching the device filter. + - 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: + - 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 - - 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 + 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 @@ -1089,443 +768,122 @@ paths: schema: $ref: '#/components/schemas/GetAgentsResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/register: 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 + - 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/GetAgents' + $ref: '#/components/schemas/RegisterAgent' 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.' + 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: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/update: 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 + - 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/RegisterAgent' + $ref: '#/components/schemas/UpdateAgent' 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.' + description: The response object for GetAgents content: application/json: schema: - $ref: '#/components/schemas/Agent' + $ref: '#/components/schemas/GetAgentsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /agents/update: + - $ref: '#/components/parameters/Accept' + /agents/search: 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. + - 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: + - 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 - - 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 + 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 @@ -1534,45 +892,14 @@ paths: schema: $ref: '#/components/schemas/SearchAgentsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -1589,67 +916,46 @@ paths: schema: $ref: '#/components/schemas/PreRegisterAgentsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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 + - 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. @@ -1658,240 +964,399 @@ paths: schema: $ref: '#/components/schemas/GetDeviceConfigResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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 + - 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.' + 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: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /events: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetDeviceSettings' - x-bodyName: body + - 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: 'Represents the device specific options such as customised local ui password details, and tracker performance settings.' + description: The Events response. content: application/json: schema: - $ref: '#/components/schemas/GetDeviceSettingsResponse' + $ref: '#/components/schemas/GetEventsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /events: + - $ref: '#/components/parameters/Accept' + /events/start/{StartUtc}: get: tags: - - events - summary: Retrieves a list of events from the hub service. + - events + summary: Retrieves a list of events from the hub service description: Retrieves a list of events from the hub service. - operationId: GetEvents_Get + 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: + - 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 - - 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 + 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. @@ -1900,19 +1365,178 @@ paths: schema: $ref: '#/components/schemas/GetEventsResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /events/end/{End}: + get: tags: - - events - summary: Retrieves a list of events from the hub service. + - 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 + 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. @@ -1921,178 +1545,178 @@ paths: schema: $ref: '#/components/schemas/GetEventsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/events/start/{StartUtc}': + - $ref: '#/components/parameters/Accept' + /events/start/{StartUtc}/end/{End}: get: tags: - - events - summary: Retrieves a list of events from the hub service. + - events + summary: Retrieves a list of events from the hub service description: Retrieves a list of events from the hub service. - operationId: GetEventsstartStartUtc_Get + 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: + - 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 - - 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 + 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. @@ -2101,19 +1725,178 @@ paths: schema: $ref: '#/components/schemas/GetEventsResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /events/skip/{Skip}/take/{Take}: + get: tags: - - events - summary: Retrieves a list of events from the hub service. + - 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 + 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. @@ -2122,400 +1905,178 @@ paths: schema: $ref: '#/components/schemas/GetEventsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/events/end/{End}': + - $ref: '#/components/parameters/Accept' + /events/{EventId}: get: tags: - - events - summary: Retrieves a list of events from the hub service. + - events + summary: Retrieves a list of events from the hub service description: Retrieves a list of events from the hub service. - operationId: GetEventsendEnd_Get + 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: 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: + - 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 - - 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 + 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. @@ -2524,4566 +2085,43 @@ paths: schema: $ref: '#/components/schemas/GetEventsResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /alertEvents/add: 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 + - 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/GetEvents' + $ref: '#/components/schemas/SubmitAlertEvents' 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' + responses: + '204': + description: No Content + content: + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /alertEvents/limitedAdd: 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 + - 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/GetCredentialsList' + $ref: '#/components/schemas/SubmitAlertEventsLimited' x-bodyName: body responses: '200': @@ -7091,1094 +2129,716 @@ paths: content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/Credentials' + $ref: '#/components/schemas/SubmitAlertEventsLimitedResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/status: - get: + - $ref: '#/components/parameters/Accept' + /baselineEvents/add: + 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_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 + - 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: - '200': - description: The response object for GetAgentTaskStatuses + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /baselineEvents/limitedAdd: 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 + - 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/GetAgentTaskStatuses' + $ref: '#/components/schemas/SubmitBaselineEventsLimited' x-bodyName: body responses: '200': - description: The response object for GetAgentTaskStatuses + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + $ref: '#/components/schemas/SubmitBaselineEventsLimitedResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/status/ids/{Ids}': - get: + - $ref: '#/components/parameters/Accept' + /deviceEvents/add: + 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_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 + - 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: - '200': - description: The response object for GetAgentTaskStatuses + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceEvents/limitedAdd: 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 + - 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/GetAgentTaskStatuses' + $ref: '#/components/schemas/SubmitDeviceEventsLimited' x-bodyName: body responses: '200': - description: The response object for GetAgentTaskStatuses + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + $ref: '#/components/schemas/SubmitDeviceEventsLimitedResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/add/agent/{AgentId}': + - $ref: '#/components/parameters/Accept' + /status/ready: 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 + - 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: 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 + - 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. + description: Indicates if system is booted and ready for login. content: application/json: schema: - $ref: '#/components/schemas/SubmitAgentTasksResponse' - security: - - Bearer: [ ] - post: + $ref: '#/components/schemas/SystemReadyResponse' + parameters: + - $ref: '#/components/parameters/Accept' + /status/system: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/SubmitAgentTasks' - x-bodyName: body + - 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: The response object for SubmitAgentTasks. + description: System version and config settings. content: application/json: schema: - $ref: '#/components/schemas/SubmitAgentTasksResponse' + $ref: '#/components/schemas/SystemDetailsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/agent/legacy/{LegacyId}': + - $ref: '#/components/parameters/Accept' + /status/backgroundtasks: get: tags: - - command - summary: Requests information about tasks for the given agent. - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentlegacyLegacyId_Get + - 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: AgentId - in: query - description: Specifies the agent's AgentId. - schema: - type: string - - name: DeviceId - in: query - description: Specifies the agent's DeviceId. - schema: + - 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 - - 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: + 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: 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: + - 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: 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: 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: The response object for GetAgentTasks + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + title: List + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /status/eventsOnIncomingQueue: + get: 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 + - 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: The response object for GetAgentTasks + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + title: string + type: integer + format: int32 security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/agent/{AgentId}/all/{AllTasks}': + - $ref: '#/components/parameters/Accept' + /status/messageStatus: get: tags: - - command - summary: Requests information about tasks for the given agent. - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentAgentIdallAllTasks_Get + - 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: 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 + - 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: [] + 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: [] + 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: The response object for GetAgentTasks + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + title: List + type: array + items: + $ref: '#/components/schemas/PerformanceSnapshot' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /status/workload: + get: 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 + - 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: The response object for GetAgentTasks + description: Dictionary content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + title: Dictionary + type: object + additionalProperties: + type: number + format: double + x-nullable: false + description: Dictionary security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/agent/{AgentId}/single/{TaskId}': + - $ref: '#/components/parameters/Accept' + /status/cache: get: tags: - - command - summary: Requests information about tasks for the given agent. - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentAgentIdsingleTaskId_Get + - status + summary: Returns the cache statistics + description: Returns the cache statistics. + operationId: GetCacheStatscache_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 + - 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 + description: The cache statistics. content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + $ref: '#/components/schemas/GetCacheStatsResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /openapi3.yaml: + get: 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 + - openapi3.yaml + operationId: GetOpenApi3Yaml_Get responses: '200': - description: The response object for GetAgentTasks + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' - security: - - Bearer: [ ] + $ref: '#/components/schemas/Object' parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/agent/legacy/{LegacyId}/all/{AllTasks}': + - $ref: '#/components/parameters/Accept' + /reports/availableTypes: get: tags: - - command - summary: Requests information about tasks for the given agent. - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentlegacyLegacyIdallAllTasks_Get + - reports + summary: Report Service + description: Report Service + operationId: GetAvailableReportTypesavailableTypes_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 + - 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 + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + $ref: '#/components/schemas/GetAvailableReportTypesResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/template: + get: 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 + - 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: The response object for GetAgentTasks + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + title: String + type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/command/tasks/agent/legacy/{LegacyId}/single/{TaskId}': + - $ref: '#/components/parameters/Accept' + /reports/templates: get: tags: - - command - summary: Requests information about tasks for the given agent. - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentlegacyLegacyIdsingleTaskId_Get + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatestemplates_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 + - 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 + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + $ref: '#/components/schemas/GetReportTemplatesResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled: + get: 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 + - 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 object for GetAgentTasks + 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/GetAgentTasksResponse' + $ref: '#/components/schemas/GetScheduledReportsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/downloadFileHash/{HostType}/{OperatingSystem}/{Variant}': + - $ref: '#/components/parameters/Accept' + /reports/updatetemplate: get: tags: - - downloadFileHash - summary: Download the filehasing utility app for remote monitoring. - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_Get + - reports + summary: Report Service + description: Report Service + operationId: UpdateReportTemplateupdatetemplate_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 + - 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: [] + 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: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/Object' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/deletecustomreporttemplate: post: tags: - - downloadFileHash - summary: Download the filehasing utility app for remote monitoring. - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_Post + - 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/DownloadFileHashBinary' + $ref: '#/components/schemas/DeleteCustomReportTemplate' x-bodyName: body responses: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/Object' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/downloadFileHashById/{FileId}': + - $ref: '#/components/parameters/Accept' + /reports/devicemonitoring: get: tags: - - downloadFileHashById - summary: Download the filehasing utility app for remote monitoring. - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryFileId_Get + - 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: 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: + - 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 - - name: Variant - in: query - description: 'Specifies the operating system / host variant. e.g x64, 10 SPARC etc' - schema: + 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: FileId - in: query - description: Specifies the specific file id - schema: + - 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: 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 + - 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: Success + description: The returned data for populating a device monitoring report content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/DataSpecDeviceMonitoringReportResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /getFileHashBinaries: + - $ref: '#/components/parameters/Accept' + /reports/ruleresults: 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 + - 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 + - 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' + $ref: '#/components/schemas/GetRuleResultsResponse' security: - - Bearer: [ ] + - 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 + - reports + operationId: GetRuleResultsruleresults_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GetFileHashBinaries' + $ref: '#/components/schemas/GetRuleResults' x-bodyName: body responses: '200': @@ -8186,55 +2846,54 @@ paths: content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/FileHashBinary' + $ref: '#/components/schemas/GetRuleResultsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/members: + - $ref: '#/components/parameters/Accept' + /stats/compliancesummarydata: 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 + - stats + operationId: GetComplianceReportSummaryDatacompliancesummarydata_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 + - 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/GetPlannedChangeInstanceMembersResponse' + $ref: '#/components/schemas/ComplianceReportSummaryResponse' security: - - Bearer: [ ] + - 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 + - stats + operationId: GetComplianceReportSummaryDatacompliancesummarydata_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GetPlannedChangeInstanceMembers' + $ref: '#/components/schemas/GetComplianceReportSummaryData' x-bodyName: body responses: '200': @@ -8242,1230 +2901,962 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' + $ref: '#/components/schemas/ComplianceReportSummaryResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/delete: + - $ref: '#/components/parameters/Accept' + /stats/plannedChanges: 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 + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChanges_Get parameters: - - name: InstanceId - in: query - description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. - required: true - schema: + - 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 - - 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 + 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 + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/deleteMember: + - $ref: '#/components/parameters/Accept' + /stats/compliancedata: 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 + - 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: 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: + - 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 - - 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 + 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 + '200': + description: Compliance data by report, for either individual devices, or as group average. content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/getavailablecompliancedata: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/DeletePlannedChangeInstanceMember' - x-bodyName: body + - 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: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetAvailableComplianceDataResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/add: + - $ref: '#/components/parameters/Accept' + /stats/deviceActivity: get: tags: - - plannedChangeInstances - summary: Add a planned change instance. - description: Add a planned change instance. - operationId: AddPlannedChangeInstanceadd_Get + - 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: 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: + - 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: [] + 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 - 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 + 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.' + 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/GetPlannedChangesInstancesResponse' + $ref: '#/components/schemas/GetEventCountsResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/noisydevices: + get: 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 + - 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: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + title: List + type: array + items: + $ref: '#/components/schemas/GetEventCountsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/update: + - $ref: '#/components/parameters/Accept' + /reportExecute: get: tags: - - plannedChangeInstances - summary: Update a planned change instance - description: Update a planned change instance - operationId: UpdatePlannedChangeInstanceupdate_Get + - reportExecute + summary: Report Service + description: Report Service + operationId: ExecuteReport_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 + - 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: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + $ref: '#/components/schemas/ExecuteReportResponse' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - plannedChangeInstances - summary: Update a planned change instance - description: Update a planned change instance - operationId: UpdatePlannedChangeInstanceupdate_Post + - reportExecute + summary: Report Service + description: Report Service + operationId: ExecuteReport_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/UpdatePlannedChangeInstance' + $ref: '#/components/schemas/ExecuteReport' x-bodyName: body responses: '200': - description: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + $ref: '#/components/schemas/ExecuteReportResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/clone: + - $ref: '#/components/parameters/Accept' + /reportRenderIsCached: get: tags: - - plannedChangeInstances - summary: Clone a planned change instance. - description: Clone a planned change instance. - operationId: ClonePlannedChangeInstanceclone_Get + - reportRenderIsCached + summary: Report Service + description: Report Service + operationId: RenderReportIsCached_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 + - 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: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + 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: [ ] + - Bearer: [] post: tags: - - plannedChangeInstances - summary: Clone a planned change instance. - description: Clone a planned change instance. - operationId: ClonePlannedChangeInstanceclone_Post + - reportRender + summary: Report Service + description: Report Service + operationId: RenderReport_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ClonePlannedChangeInstance' + $ref: '#/components/schemas/RenderReport' x-bodyName: body responses: '200': - description: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + title: String + type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/nameValue: + - $ref: '#/components/parameters/Accept' + /reportRenderStart: 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 + - reportRenderStart + summary: Report Service + description: Report Service + operationId: RenderReportStart_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 + - 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: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' + title: String + type: string security: - - Bearer: [ ] + - 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 + - reportRenderStart + summary: Report Service + description: Report Service + operationId: RenderReportStart_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GetPlannedChangeInstancesNameValue' + $ref: '#/components/schemas/RenderReportStart' x-bodyName: body responses: '200': - description: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' + title: String + type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/addMembers: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered/download: 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 + - reports + summary: Gets a previously generated report output file + description: Gets a previously generated report output file + operationId: GetScheduledInstanceOutputscheduledinstancesrendereddownload_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 + - 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 + '200': + description: Success content: - application/json: { } + application/json: + schema: + title: String + type: string security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered/delete: 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 + - 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/AddPlannedChangeInstanceMember' + $ref: '#/components/schemas/DeleteScheduledInstanceOutputs' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/addOrUpdateFromEvents: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/delete: 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 + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledInstancescheduledinstancesdelete_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 + - 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 + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEventsResponse' + application/json: {} security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instance/updateLifetime: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEvents' - x-bodyName: body + - 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/AddOrUpdatePlannedChangeInstanceFromEventsResponse' + $ref: '#/components/schemas/GetScheduledInstancesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/reevaluateEvents: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered: 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 + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstanceRenderedscheduledinstancesrendered_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 + - 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: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetScheduledInstanceRenderedResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/add: 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 + - 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/AddReEvaluationOfPlannedChangeInstanceEvents' + $ref: '#/components/schemas/AddScheduledReport' x-bodyName: body responses: - '204': - description: No Content + '200': + description: The response to requests to add, query or update scheduled reports, listing the new states of the reports affected content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/update: 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 + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledReportscheduledupdate_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 + - 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: 'Describes planned change instances, filtered by name, id or groups that are members.' + 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/GetPlannedChangesInstancesResponse' + $ref: '#/components/schemas/GetScheduledReportsResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/delete: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetPlannedChangeInstances' - x-bodyName: body + - 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: 'Describes planned change instances, filtered by name, id or groups that are members.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + title: string + type: boolean security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/add: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances: get: tags: - - plannedChanges - summary: Add a planned change definition. - description: Add a planned change definition. - operationId: AddPlannedChangeadd_Get + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstancesscheduledinstances_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 + - 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: Specifies returned a planned change definitions. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + $ref: '#/components/schemas/GetScheduledInstancesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /uploadAgentUpdate: post: tags: - - plannedChanges - summary: Add a planned change definition. - description: Add a planned change definition. - operationId: AddPlannedChangeadd_Post + - 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/AddPlannedChange' + $ref: '#/components/schemas/UploadAgentUpdate' x-bodyName: body responses: - '200': - description: Specifies returned a planned change definitions. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/upload: + - $ref: '#/components/parameters/Accept' + /updatehubdetails: post: tags: - - plannedChanges - summary: Upload a planned change ruleset json file - description: Upload a planned change ruleset json file - operationId: UploadPlannedChangeupload_Post + - 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/UploadPlannedChange' + $ref: '#/components/schemas/UpdateHubDetails' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/download: + - $ref: '#/components/parameters/Accept' + /downloadAgentUpdate/{VersionRequested}: get: tags: - - plannedChanges - summary: Download a planned change ruleset json file - description: Download a planned change ruleset json file - operationId: DownloadPlannedChangedownload_Get + - downloadAgentUpdate + summary: Download an update package for the agent + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequested_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 + - 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 @@ -9474,18 +3865,18 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - plannedChanges - summary: Download a planned change ruleset json file - description: Download a planned change ruleset json file - operationId: DownloadPlannedChangedownload_Post + - 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/DownloadPlannedChange' + $ref: '#/components/schemas/DownloadUpdate' x-bodyName: body responses: '200': @@ -9495,2181 +3886,2368 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/update: + - $ref: '#/components/parameters/Accept' + /downloadAgentUpdate/{VersionRequested}/{UpdateType}: get: tags: - - plannedChanges - summary: Update a planned change definition - description: Update a planned change definition - operationId: UpdatePlannedChangeupdate_Get + - downloadAgentUpdate + summary: Download an update package for the agent + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequestedUpdateType_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 + - 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: Specifies returned a planned change definitions. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - plannedChanges - summary: Update a planned change definition - description: Update a planned change definition - operationId: UpdatePlannedChangeupdate_Post + - 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/UpdatePlannedChange' + $ref: '#/components/schemas/DownloadUpdate' x-bodyName: body responses: '200': - description: Specifies returned a planned change definitions. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /agentUpdates/delete: post: tags: - - plannedChanges - summary: Clone a planned change definition. - description: Clone a planned change definition. - operationId: ClonePlannedChangeclone_Post + - 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/ClonePlannedChange' + $ref: '#/components/schemas/DeleteAgentUpdate' x-bodyName: body responses: - '200': - description: Specifies returned a planned change definitions. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/analyze: + - $ref: '#/components/parameters/Accept' + /agentUpdates: 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 + - 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: 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 + - 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: - $ref: '#/components/schemas/AnalyzePlannedChangeResponse' + title: List + type: array + items: + $ref: '#/components/schemas/AgentSoftwareUpdate' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/AnalyzePlannedChange' - x-bodyName: body + - 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: - $ref: '#/components/schemas/AnalyzePlannedChangeResponse' + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/delete: 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 + - 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/ApplyPlannedChangePlan' + $ref: '#/components/schemas/DeleteAgentSoftwareUpdateScheduleFromGroup' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/update: post: tags: - - plannedChanges - summary: Updates a rule in a planned change - description: Updates a rule in a planned change - operationId: UpdatePlannedChangeRuleupdateRule_Post + - 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/UpdatePlannedChangeRule' + $ref: '#/components/schemas/UpdateAgentSoftwareUpdateScheduleForGroup' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/add: 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 + - 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/UpdatePlannedChangeRules' + $ref: '#/components/schemas/SetAgentSoftwareUpdateScheduleForGroup' x-bodyName: body responses: '200': - description: A named Planned Change definition. + description: Success content: application/json: schema: - $ref: '#/components/schemas/PlannedChangeDefinition' - deprecated: true + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/deleteRule: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems: get: tags: - - plannedChanges - summary: Removes a rule from a planned change - description: Removes a rule from a planned change - operationId: DeletePlannedChangeRuledeleteRule_Get + - syncServiceConfigItems + summary: Retrieves a list of SyncService configuration items + description: Retrieves a list of SyncService configuration items. + operationId: GetSyncServiceConfigItems_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: + - 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 - - 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 + 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 + '200': + description: Response for retrieving SyncService configuration items content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetSyncServiceConfigItemsResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/add: post: tags: - - plannedChanges - summary: Removes a rule from a planned change - description: Removes a rule from a planned change - operationId: DeletePlannedChangeRuledeleteRule_Post + - 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/DeletePlannedChangeRule' + $ref: '#/components/schemas/AddSyncServiceConfigItem' x-bodyName: body responses: - '204': - description: No Content + '200': + description: Response for adding a SyncService configuration item content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/AddSyncServiceConfigItemResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/update: 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 + - 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/DeletePlannedChange' + $ref: '#/components/schemas/UpdateSyncServiceConfigItem' 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. + description: Success content: application/json: schema: - $ref: '#/components/schemas/NewId' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/delete: post: tags: - - plannedChangeRule - summary: Add a rule to a planned change - description: Add a rule to a planned change - operationId: AddPlannedChangeRuleadd_Post + - 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/AddPlannedChangeRule' + $ref: '#/components/schemas/DeleteSyncServiceConfigItem' x-bodyName: body responses: '200': - description: The id of the new item created. + description: Success content: application/json: schema: - $ref: '#/components/schemas/NewId' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges: + - $ref: '#/components/parameters/Accept' + /configItems: 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 + - configItems + summary: Retrieves a list of hub configuration parameters + description: Retrieves a list of hub configuration parameters. + operationId: GetConfigItems_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: + - 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: 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: + - 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 - - 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 + 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. + description: Describes the hub configuration parameters. content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + $ref: '#/components/schemas/GetConfigItemsResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /configItems/add: 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 + - 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/GetPlannedChanges' + $ref: '#/components/schemas/AddConfigItems' x-bodyName: body responses: '200': - description: Specifies returned a planned change definitions. + description: Dictionary content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesResponse' + title: Dictionary + type: object + additionalProperties: + $ref: '#/components/schemas/NewId' + description: Dictionary security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/parse: - get: + - $ref: '#/components/parameters/Accept' + /configItems/update: + 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_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 + - 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: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/ParseCommandResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /configItems/delete: 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 + - 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/ParseCommands' + $ref: '#/components/schemas/DeleteConfigItem' x-bodyName: body responses: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/ParseCommandResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/whitelist: - get: + - $ref: '#/components/parameters/Accept' + /configItem/update: + post: 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 + - 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: - '200': - description: The paging response base. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/WhitelistCommandComponentResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /configItem/add: post: tags: - - commandParser - summary: Attempts to whitelist the supplied command component. - description: Attempts to whitelist the supplied command component. - operationId: CreateWhitelistedCommandComponentwhitelist_Post + - 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/CreateWhitelistedCommandComponent' + $ref: '#/components/schemas/AddConfigItem' x-bodyName: body responses: '200': - description: The paging response base. + description: The response delivered after adding a new config key / value. content: application/json: schema: - $ref: '#/components/schemas/WhitelistCommandComponentResponse' + $ref: '#/components/schemas/AddConfigItemResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/whitelist/all: + - $ref: '#/components/parameters/Accept' + /misc/dateTransmissionTest: get: tags: - - commandParser - summary: Attempts to get all the whitelisted command components. - description: Attempts to get all the whitelisted command components. - operationId: GetAllWhitelistedCommandComponentswhitelistall_Get + - 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: 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 + - 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: The paging response base. + description: Success content: application/json: schema: - $ref: '#/components/schemas/WhitelistCommandComponentResponse' + title: string + type: string + format: date-time security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/whitelist/update: + - $ref: '#/components/parameters/Accept' + /credentials/add: 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 + - 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/UpdateWhitelistedCommandComponent' + $ref: '#/components/schemas/AddCredentials' x-bodyName: body responses: '200': - description: The paging response base. + description: Represents some credentials used to connect to a remote service (e.g SSH, database etc). content: application/json: schema: - $ref: '#/components/schemas/WhitelistCommandComponentResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/whitelist/updateMany: + - $ref: '#/components/parameters/Accept' + /credentials/update: 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 + - 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/UpdateWhitelistedCommandComponents' + $ref: '#/components/schemas/UpdateCredentials' x-bodyName: body responses: '200': - description: The paging response base. + description: Represents some credentials used to connect to a remote service (e.g SSH, database etc). content: application/json: schema: - $ref: '#/components/schemas/WhitelistCommandComponentResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/commandComponent/addTemplates: + - $ref: '#/components/parameters/Accept' + /credentials/delete: 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 + - 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/AddTemplatesToCommandComponent' + $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: Success + description: Dictionary> content: application/json: schema: - $ref: '#/components/schemas/CommandComponentTemplateResponse' + title: Dictionary> + type: object + additionalProperties: + type: array + items: + type: string + description: Dictionary> security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/commandComponent/removeTemplates: - post: + - $ref: '#/components/parameters/Accept' + /credentials: + get: 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 + - 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: - $ref: '#/components/schemas/CommandComponentTemplateResponse' + title: List + type: array + items: + $ref: '#/components/schemas/Credentials' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/commandComponent/templates: + - $ref: '#/components/parameters/Accept' + /command/tasks/status: get: tags: - - commandParser - summary: Gets all templates of a command component. - description: Gets all templates of a command component. - operationId: GetAllCommandComponentTemplatescommandComponenttemplates_Get + - 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: 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: + - name: Ids + in: query + description: Specifies the task ids. + style: form + schema: + type: array + items: 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: + 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: [] + 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 + 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 paging response base. + description: The response object for GetAgentTaskStatuses content: application/json: schema: - $ref: '#/components/schemas/GetAllCommandComponentTemplatesResponse' + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /command/tasks/add/agent/{AgentId}: 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 + - 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/SetAllTemplatesOfCommandComponent' + $ref: '#/components/schemas/SubmitAgentTasks' x-bodyName: body responses: '200': - description: Success + description: The response object for SubmitAgentTasks. content: application/json: schema: - $ref: '#/components/schemas/CommandComponentTemplateResponse' + $ref: '#/components/schemas/SubmitAgentTasksResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /commandParser/commandComponentMany/templates: - post: + - $ref: '#/components/parameters/Accept' + /command/tasks/agent/legacy/{LegacyId}: + get: 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 + - 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: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/GetAllCommandComponentsTemplatesResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /cloudTemplate/status: + - $ref: '#/components/parameters/Accept' + /command/tasks/agent/{AgentId}/all/{AllTasks}: 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 + - command + summary: Requests information about tasks for the given agent + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdallAllTasks_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: + - 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 - - 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: + 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 + 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: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /command/tasks/agent/{AgentId}/single/{TaskId}: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetCloudTemplateCreationStatus' - x-bodyName: body + - 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: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/setup: + - $ref: '#/components/parameters/Accept' + /command/tasks/agent/legacy/{LegacyId}/all/{AllTasks}: 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 + - command + summary: Requests information about tasks for the given agent + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdallAllTasks_Get parameters: - - name: PolicyTemplateName - in: query - description: Specifies the policy template name - schema: + - 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 - - name: Version - in: query - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' - schema: + 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 - 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 + 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: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/SetupPolicyTemplateResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/status: + - $ref: '#/components/parameters/Accept' + /command/tasks/agent/legacy/{LegacyId}/single/{TaskId}: 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 + - command + summary: Requests information about tasks for the given agent + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdsingleTaskId_Get parameters: - - name: PolicyTemplateName - in: query - description: Specifies the policy template name to query - schema: + - 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 - - name: Version - in: query - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' - schema: + 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 - 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 + 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: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/add: + - $ref: '#/components/parameters/Accept' + /downloadFileHash/{HostType}/{OperatingSystem}/{Variant}: get: tags: - - policyTemplate - summary: Adds a device config template. - description: Adds a device config template. - operationId: AddPolicyTemplateadd_Get + - downloadFileHash + summary: Download the filehasing utility app for remote monitoring + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_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 + - 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: Response to a request for matching config templates. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPolicyTemplatesResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - policyTemplate - summary: Adds a device config template. - description: Adds a device config template. - operationId: AddPolicyTemplateadd_Post + - 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/AddPolicyTemplate' + $ref: '#/components/schemas/DownloadFileHashBinary' x-bodyName: body responses: '200': - description: Response to a request for matching config templates. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetPolicyTemplatesResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyRecent: + - $ref: '#/components/parameters/Accept' + /downloadFileHashById/{FileId}: 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 + - downloadFileHashById + summary: Download the filehasing utility app for remote monitoring + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryFileId_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 + - 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: Response to a request for matching config templates. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - 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 + - 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/GetMostRecentPolicyResults' + $ref: '#/components/schemas/DownloadFileHashBinary' x-bodyName: body responses: '200': - description: Response to a request for matching config templates. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/add/rules: + - $ref: '#/components/parameters/Accept' + /getFileHashBinaries: 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 + - 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: 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 + - 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' + title: List + type: array + items: + $ref: '#/components/schemas/FileHashBinary' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /devicePolicyTemplate/add: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/members: 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 + - 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: 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 + - 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: Response to adding a device policy template to the system. + description: Success content: application/json: schema: - $ref: '#/components/schemas/AddPolicyTemplateResponse' + $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/delete: 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 + - 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/AddPolicyTemplateXml' + $ref: '#/components/schemas/DeletePlannedChangeInstance' 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: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/deleteMember: 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 + - 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/DeletePolicyTemplate' + $ref: '#/components/schemas/DeletePlannedChangeInstanceMember' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /uploadPolicyTemplate: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/add: post: tags: - - uploadPolicyTemplate - summary: Upload a policy template file - description: Upload a policy template file - operationId: UploadPolicyTemplate_Post + - 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/UploadPolicyTemplate' + $ref: '#/components/schemas/AddPlannedChangeInstance' x-bodyName: body responses: '200': - description: Success + description: Describes planned change instances, filtered by name, id or groups that are members. content: application/json: schema: - $ref: '#/components/schemas/UploadPolicyTemplateResponse' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplateAsFile: - get: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/update: + 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_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 + - 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: Success + description: Describes planned change instances, filtered by name, id or groups that are members. content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/clone: 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 + - 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/GetPolicyTemplateAsFile' + $ref: '#/components/schemas/ClonePlannedChangeInstance' x-bodyName: body responses: '200': - description: Success + description: Describes planned change instances, filtered by name, id or groups that are members. content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /agentProcesses: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/nameValue: 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 + - 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: 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 + - 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 the list of running processes on a device. + description: Describes planned change instances, filtered by name, id or groups that are members. content: application/json: schema: - $ref: '#/components/schemas/GetAgentProcessesResponse' + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/addMembers: 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 + - 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/GetAgentProcesses' + $ref: '#/components/schemas/AddPlannedChangeInstanceMember' x-bodyName: body responses: - '200': - description: Describes the list of running processes on a device. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentProcessesResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /startAgentTracker: - get: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/addOrUpdateFromEvents: + post: 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 + - 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/StartAgentTrackerResponse' + $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEventsResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/reevaluateEvents: post: tags: - - startAgentTracker - summary: Ask an agent to start a specified tracker. - description: Ask an agent to start a specified tracker. - operationId: StartAgentTracker_Post + - 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/StartAgentTracker' + $ref: '#/components/schemas/AddReEvaluationOfPlannedChangeInstanceEvents' x-bodyName: body responses: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/StartAgentTrackerResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /agentServices: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances: 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 + - 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: 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 + - 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 the list of running services on a device. + description: Describes planned change instances, filtered by name, id or groups that are members. content: application/json: schema: - $ref: '#/components/schemas/GetAgentServicesResponse' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/add: 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 + - 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/GetAgentServices' + $ref: '#/components/schemas/AddPlannedChange' x-bodyName: body responses: '200': - description: Describes the list of running services on a device. + description: Specifies returned a planned change definitions. content: application/json: schema: - $ref: '#/components/schemas/GetAgentServicesResponse' + $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /plannedChanges/upload: 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 + - 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/SetActivePolicyTemplate' + $ref: '#/components/schemas/UploadPlannedChange' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplates/update: + - $ref: '#/components/parameters/Accept' + /plannedChanges/download: get: tags: - - policyTemplates - summary: Update matching config templates. - description: Update matching config templates. - operationId: UpdatePolicyTemplatesupdate_Get + - plannedChanges + summary: Download a planned change ruleset json file + description: Download a planned change ruleset json file + operationId: DownloadPlannedChangedownload_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 + - 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: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - policyTemplates - summary: Update matching config templates. - description: Update matching config templates. - operationId: UpdatePolicyTemplatesupdate_Post + - 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/UpdatePolicyTemplates' + $ref: '#/components/schemas/DownloadPlannedChange' 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. + description: Success content: application/json: schema: - $ref: '#/components/schemas/PolicyTemplateRuleSet' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/update: post: tags: - - deviceConfigTemplate - summary: Gets a named device config template. - description: Gets a named device config template. - operationId: GetDeviceConfigTemplate_Post + - 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/GetDeviceConfigTemplate' + $ref: '#/components/schemas/UpdatePlannedChange' x-bodyName: body responses: '200': - description: Represents a named policy tracking configuration and rule-set template. + description: Specifies returned a planned change definitions. content: application/json: schema: - $ref: '#/components/schemas/PolicyTemplateRuleSet' + $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceConfigTemplateNames: - get: + - $ref: '#/components/parameters/Accept' + /plannedChanges/clone: + 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_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 + - 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: Success + description: Specifies returned a planned change definitions. content: application/json: schema: - title: List - type: array - items: - type: string + $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/analyze: 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 + - 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/GetDeviceConfigTemplateNames' + $ref: '#/components/schemas/AnalyzePlannedChange' x-bodyName: body responses: '200': @@ -11677,3971 +6255,3477 @@ paths: content: application/json: schema: - title: List - type: array - items: - type: string + $ref: '#/components/schemas/AnalyzePlannedChangeResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /plannedChanges/applyPlan: 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 + - 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/AddDeviceConfigProcessRules' + $ref: '#/components/schemas/ApplyPlannedChangePlan' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /plannedChanges/updateRule: 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 + - 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/GetGroupPolicy' + $ref: '#/components/schemas/UpdatePlannedChangeRule' x-bodyName: body responses: - '200': - description: The response to the request for configured policy templates on the group. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetGroupPolicyResponse' + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /plannedChanges/updateRules: 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 + - 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/GetGroupPolicyConfigNames' + $ref: '#/components/schemas/UpdatePlannedChangeRules' x-bodyName: body responses: '200': - description: 'Dictionary>' + description: A named Planned Change definition. content: application/json: schema: - title: 'Dictionary>' - type: object - additionalProperties: - type: array - items: - type: string - description: 'Dictionary>' + $ref: '#/components/schemas/PlannedChangeDefinition' + deprecated: true security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /plannedChanges/deleteRule: post: tags: - - groupPolicy - summary: Adds a config template to a group. - description: Adds a config template to a group. - operationId: AddGroupPolicyadd_Post + - 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/AddGroupPolicy' + $ref: '#/components/schemas/DeletePlannedChangeRule' x-bodyName: body responses: - '200': - description: The response to the request to add a configured policy template to the group. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/AddGroupPolicyResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /groupPolicy/delete: - get: + - $ref: '#/components/parameters/Accept' + /plannedChanges/delete: + post: 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 + - 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: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChangeRule/add: post: tags: - - groupPolicy - summary: Removes a config template from a group. - description: Removes a config template from a group. - operationId: DeleteGroupPolicydelete_Post + - 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/DeleteGroupPolicy' + $ref: '#/components/schemas/AddPlannedChangeRule' x-bodyName: body responses: - '204': - description: No Content + '200': + description: The id of the new item created. content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/NewId' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /reParentDevices: + - $ref: '#/components/parameters/Accept' + /plannedChanges: 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 + - 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: 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: + - 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 - - 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 + 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: 'Dictionary' + description: Specifies returned a planned change definitions. content: application/json: schema: - title: 'Dictionary' - type: object - additionalProperties: - type: string - description: 'Dictionary' + $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/parse: 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 + - 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/ReParentDevices' + $ref: '#/components/schemas/ParseCommands' x-bodyName: body responses: '200': - description: 'Dictionary' + description: Success content: application/json: schema: - title: 'Dictionary' - type: object - additionalProperties: - type: string - description: 'Dictionary' + $ref: '#/components/schemas/ParseCommandResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /exportAgents: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist: get: tags: - - exportAgents - summary: Export a list of agent details. - description: Export a list of agent details. - operationId: ExportAgents_Get + - commandParser + summary: Gets the whitelisted command component + description: Gets the whitelisted command component. + operationId: GetWhitelistedCommandComponentwhitelist_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 + - 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 + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - exportAgents - summary: Export a list of agent details. - description: Export a list of agent details. - operationId: ExportAgents_Post + - 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/ExportAgents' + $ref: '#/components/schemas/CreateWhitelistedCommandComponent' x-bodyName: body responses: '200': - description: Success + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /agentsRanked: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist/all: 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 + - commandParser + summary: Attempts to get all the whitelisted command components + description: Attempts to get all the whitelisted command components. + operationId: GetAllWhitelistedCommandComponentswhitelistall_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: + - 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 - - 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 + 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 + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/GetAgentsRankedResponse' + $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist/update: 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 + - 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/GetAgentsRanked' + $ref: '#/components/schemas/UpdateWhitelistedCommandComponent' x-bodyName: body responses: '200': - description: The response objeect for GetAgentsRanked + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/GetAgentsRankedResponse' + $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /commandParser/whitelist/updateMany: 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 + - 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/GroupMembers' + $ref: '#/components/schemas/UpdateWhitelistedCommandComponents' x-bodyName: body responses: '200': - description: The response to group members request. + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/GroupMembersResponse' + $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /groups: - get: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponent/addTemplates: + post: 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 + - 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: The response to a get groups request. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetGroupsResponse' + $ref: '#/components/schemas/CommandComponentTemplateResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponent/removeTemplates: post: tags: - - groups - summary: A request to return groups matching the criteria. - description: A request to return groups matching the criteria. - operationId: GetGroups_Post + - 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/GetGroups' + $ref: '#/components/schemas/RemoveTemplatesFromCommandComponent' x-bodyName: body responses: '200': - description: The response to a get groups request. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetGroupsResponse' + $ref: '#/components/schemas/CommandComponentTemplateResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /groupsTree: + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponent/templates: get: tags: - - groupsTree - summary: Gets a tree structure representing the groups hierarchy. - description: Gets a tree structure representing the groups hierarchy. - operationId: GetGroupsTree_Get + - 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: A returned tree structure representing the groups hierarchy. + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/GetGroupsTreeResponse' + $ref: '#/components/schemas/GetAllCommandComponentTemplatesResponse' security: - - Bearer: [ ] + - 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 + - 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/json: + application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GetGroupsTree' + $ref: '#/components/schemas/SetAllTemplatesOfCommandComponent' x-bodyName: body responses: '200': - description: A returned tree structure representing the groups hierarchy. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetGroupsTreeResponse' + $ref: '#/components/schemas/CommandComponentTemplateResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /commandParser/commandComponentMany/templates: 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 + - 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/DeleteGroup' + $ref: '#/components/schemas/GetAllCommandComponentsTemplates' x-bodyName: body responses: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetAllCommandComponentsTemplatesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /groups/add: + - $ref: '#/components/parameters/Accept' + /cloudTemplate/status: get: tags: - - groups - summary: Adds a new Group definition. - description: Adds a new Group definition. - operationId: AddGroupadd_Get + - 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: 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 + - 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: Represents a response to adding a new group + description: Success content: application/json: schema: - $ref: '#/components/schemas/AddGroupResponse' + $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - groups - summary: Adds a new Group definition. - description: Adds a new Group definition. - operationId: AddGroupadd_Post + - 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/AddGroup' + $ref: '#/components/schemas/GetCloudTemplateCreationStatus' x-bodyName: body responses: '200': - description: Represents a response to adding a new group + description: Success content: application/json: schema: - $ref: '#/components/schemas/AddGroupResponse' + $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /groups/update: + - $ref: '#/components/parameters/Accept' + /policyTemplate/setup: get: tags: - - groups - summary: Updates a Group definition. - description: Updates a Group definition. - operationId: UpdateGroupupdate_Get + - 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: 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 + - 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: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/SetupPolicyTemplateResponse' security: - - Bearer: [ ] + - Bearer: [] post: tags: - - groups - summary: Updates a Group definition. - description: Updates a Group definition. - operationId: UpdateGroupupdate_Post + - 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/UpdateGroup' + $ref: '#/components/schemas/SetupPolicyTemplate' x-bodyName: body responses: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/SetupPolicyTemplateResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /devices/delete: + - $ref: '#/components/parameters/Accept' + /policyTemplate/status: 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 + - 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: 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 + - 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: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/add: 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 + - 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/DeleteDevices' + $ref: '#/components/schemas/AddPolicyTemplate' x-bodyName: body responses: - '204': - description: No Content + '200': + description: Response to a request for matching config templates. content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplatesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /devices/overdue: + - $ref: '#/components/parameters/Accept' + /policyRecent: 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 + - 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: 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 + - 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: Lists devices that have not polled in for the specified amount of time. + description: Response to a request for matching config templates. content: application/json: schema: - $ref: '#/components/schemas/GetOverdueDevicesResponse' + $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/add/rules: 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 + - 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/GetOverdueDevices' + $ref: '#/components/schemas/AddPolicyTemplateRules' x-bodyName: body responses: '200': - description: Lists devices that have not polled in for the specified amount of time. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetOverdueDevicesResponse' + $ref: '#/components/schemas/AddPolicyTemplateRulesResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /devicePolicyTemplate/add: 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 + - 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/DeleteDevicePermanently' + $ref: '#/components/schemas/AddPolicyTemplateXml' 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.' + description: Response to adding a device policy template to the system. content: application/json: schema: - $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + $ref: '#/components/schemas/AddPolicyTemplateResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /devicePolicyTemplate/delete: 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 + - 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/ReRegisterDevice' + $ref: '#/components/schemas/DeletePolicyTemplate' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /group/deleteMembersPermanently: - get: + - $ref: '#/components/parameters/Accept' + /uploadPolicyTemplate: + 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_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 + - 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: '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.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + $ref: '#/components/schemas/UploadPolicyTemplateResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplateAsFile: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/DeleteGroupMembersPermanently' - x-bodyName: body + - 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: '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.' + description: Success content: application/json: schema: - $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceFilter/add: + - $ref: '#/components/parameters/Accept' + /agentProcesses: get: tags: - - deviceFilter - summary: Represents a request to add a DeviceFilter. - description: Represents a request to add a DeviceFilter. - operationId: AddDeviceFilteradd_Get + - 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: 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 + - 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: The response to a get defvice filters request. + description: Describes the list of running processes on a device. content: application/json: schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + $ref: '#/components/schemas/GetAgentProcessesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /startAgentTracker: post: tags: - - deviceFilter - summary: Represents a request to add a DeviceFilter. - description: Represents a request to add a DeviceFilter. - operationId: AddDeviceFilteradd_Post + - 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/AddDeviceFilter' + $ref: '#/components/schemas/StartAgentTracker' x-bodyName: body responses: '200': - description: The response to a get defvice filters request. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + $ref: '#/components/schemas/StartAgentTrackerResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceFilter/update: + - $ref: '#/components/parameters/Accept' + /agentServices: 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 + - 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: 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 + - 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: The response to a get defvice filters request. + description: Describes the list of running services on a device. content: application/json: schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + $ref: '#/components/schemas/GetAgentServicesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplates/activeVersion: 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 + - 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/UpdateDeviceFilter' + $ref: '#/components/schemas/SetActivePolicyTemplate' x-bodyName: body responses: - '200': - description: The response to a get defvice filters request. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /policyTemplates/update: 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 + - 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/PromoteDeviceFilter' + $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: The response to a get defvice filters request. + description: Represents a named policy tracking configuration and rule-set template. content: application/json: schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + $ref: '#/components/schemas/PolicyTemplateRuleSet' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceFilter/delete: + - $ref: '#/components/parameters/Accept' + /deviceConfigTemplateNames: 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 + - 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: Name - in: query - description: Specifies the name of the device filter to delete. - schema: + - 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: 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 + - 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: { } + application/json: + schema: + title: List + type: array + items: + type: string security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /addDeviceConfigProcessRules: 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 + - 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/DeleteDeviceFilter' + $ref: '#/components/schemas/AddDeviceConfigProcessRules' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceFilters: + - $ref: '#/components/parameters/Accept' + /groupPolicy: 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 + - 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: NameContains - in: query - description: Specifies text to search for in the filter Name - schema: + - 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: Name - in: query - description: Specifies an exact filter Name to search for - schema: + - 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 - - 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: + 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: [] + 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 + - 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. + description: Dictionary> content: application/json: schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + title: Dictionary> + type: object + additionalProperties: + type: array + items: + type: string + description: Dictionary> security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /groupPolicy/add: 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 + - 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/GetDeviceFilters' + $ref: '#/components/schemas/AddGroupPolicy' x-bodyName: body responses: '200': - description: The response to a get defvice filters request. + description: The response to the request to add a configured policy template to the group. content: application/json: schema: - $ref: '#/components/schemas/GetDeviceFiltersResponse' + $ref: '#/components/schemas/AddGroupPolicyResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /groupPolicy/delete: 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 + - 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/AddGroupMembers' + $ref: '#/components/schemas/DeleteGroupPolicy' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /groupMembers/delete: - get: + - $ref: '#/components/parameters/Accept' + /reParentDevices: + 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_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 + - 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: - '204': - description: No Content + '200': + description: Dictionary content: - application/json: { } + application/json: + schema: + title: Dictionary + type: object + additionalProperties: + type: string + description: Dictionary security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /exportAgents: 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 + - 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/DeleteGroupMembers' + $ref: '#/components/schemas/ExportAgents' x-bodyName: body responses: - '204': - description: No Content + '200': + description: Success content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceOnlineStatus: + - $ref: '#/components/parameters/Accept' + /agentsRanked: 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 + - 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: 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: + - 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 - - 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 + 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 + description: The response objeect for GetAgentsRanked content: application/json: schema: - title: string - type: string + $ref: '#/components/schemas/GetAgentsRankedResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /groupMembers: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetDeviceOnlineStatus' - x-bodyName: body + - 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: Success + description: The response to group members request. content: application/json: schema: - title: string - type: string + $ref: '#/components/schemas/GroupMembersResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /deviceSettings/update: + - $ref: '#/components/parameters/Accept' + /groups: 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 + - groups + summary: A request to return groups matching the criteria + description: A request to return groups matching the criteria. + operationId: GetGroups_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: + - 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: 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: + - 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 - - 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 + 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 device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' + description: The response to a get groups request. content: application/json: schema: - $ref: '#/components/schemas/DeviceSettings' + $ref: '#/components/schemas/GetGroupsResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /groupsTree: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/UpdateDeviceSettings' - x-bodyName: body + - 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: 'The device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' + description: A returned tree structure representing the groups hierarchy. content: application/json: schema: - $ref: '#/components/schemas/DeviceSettings' + $ref: '#/components/schemas/GetGroupsTreeResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /groups/delete: 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 + - 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/AddCredentialsToAgentDevice' + $ref: '#/components/schemas/DeleteGroup' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /groups/add: 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 + - 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/RemoveCredentialsFromAgentDevice' + $ref: '#/components/schemas/AddGroup' x-bodyName: body responses: - '204': - description: No Content + '200': + description: Represents a response to adding a new group content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/AddGroupResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /groups/update: 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 + - 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/SetAgentDeviceName' + $ref: '#/components/schemas/UpdateGroup' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /devices/delete: 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 + - 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/SetAgentHostType' + $ref: '#/components/schemas/DeleteDevices' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /testAgentCredentials: + - $ref: '#/components/parameters/Accept' + /devices/overdue: 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 + - 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: AgentDeviceId - in: query - description: Specifies the agent device id whose credentials are to be tested. - schema: + - 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: 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: 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: Success + description: Lists devices that have not polled in for the specified amount of time. content: application/json: schema: - $ref: '#/components/schemas/TestAgentCredentialsResponse' + $ref: '#/components/schemas/GetOverdueDevicesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /device/deletePermanently: 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 + - 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/TestAgentCredentials' + $ref: '#/components/schemas/DeleteDevicePermanently' x-bodyName: body responses: '200': - description: Success + 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/TestAgentCredentialsResponse' + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /device/reRegister: 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 + - 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/GetIpBlocking' + $ref: '#/components/schemas/ReRegisterDevice' x-bodyName: body responses: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - title: List - type: array - items: - $ref: '#/components/schemas/IpAddressBlockingStatus' + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /group/deleteMembersPermanently: 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 + - 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/AddIpBlocking' + $ref: '#/components/schemas/DeleteGroupMembersPermanently' x-bodyName: body responses: '200': - description: Success + 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: - title: List - type: array - items: - $ref: '#/components/schemas/IpAddressBlockingStatus' + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /deviceFilter/add: post: tags: - - ipBlocking - summary: Removes blocking of a specified ip address. - description: Removes blocking of a specified ip address. - operationId: DeleteIpBlockingdelete_Post + - 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/DeleteIpBlocking' + $ref: '#/components/schemas/AddDeviceFilter' x-bodyName: body responses: '200': - description: Success + description: The response to a get defvice filters request. content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/IpAddressBlockingStatus' + $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /discoverDevices: - get: + - $ref: '#/components/parameters/Accept' + /deviceFilter/update: + 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_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 + - 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: Success + description: The response to a get defvice filters request. content: application/json: schema: - $ref: '#/components/schemas/DiscoverDevicesResponse' + $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilter/promote: 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 + - 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/DiscoverDevices' + $ref: '#/components/schemas/PromoteDeviceFilter' x-bodyName: body responses: '200': - description: Success + description: The response to a get defvice filters request. content: application/json: schema: - $ref: '#/components/schemas/DiscoverDevicesResponse' + $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /deviceFilter/delete: 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 + - 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/SubmitDiscoveredDevices' + $ref: '#/components/schemas/DeleteDeviceFilter' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /acknowledgeEvents: + - $ref: '#/components/parameters/Accept' + /deviceFilters: get: tags: - - acknowledgeEvents - summary: Acknowledge a list of events as 'planned'. - description: Acknowledge a list of events as 'planned'. - operationId: AcknowledgeEvents_Get + - 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: 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: + - 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 - - 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 + 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 + '200': + description: The response to a get defvice filters request. content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /groupMembers/add: post: tags: - - acknowledgeEvents - summary: Acknowledge a list of events as 'planned'. - description: Acknowledge a list of events as 'planned'. - operationId: AcknowledgeEvents_Post + - 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/AcknowledgeEvents' + $ref: '#/components/schemas/AddGroupMembers' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /groupMembers/delete: 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 + - 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/ResubmitEvents' + $ref: '#/components/schemas/DeleteGroupMembers' x-bodyName: body responses: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/event/history/{EventId}': + - $ref: '#/components/parameters/Accept' + /deviceOnlineStatus: get: tags: - - event - summary: Get the event history for one specific event. - description: Get the event history for one specific event. - operationId: GetEventHistoryhistoryEventId_Get + - 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: 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 + - 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: Describes an event's history. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetEventHistoryResponse' + title: string + type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /eventDeviceGroups: + - $ref: '#/components/parameters/Accept' + /deviceSettings/update: 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 + - 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: 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 + - 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: Represents the list of groups that the devices associated with the given events are members of. + 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/GetEventDeviceGroupsResponse' + $ref: '#/components/schemas/DeviceSettings' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceCredentials/add: 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 + - 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/GetEventDeviceGroups' + $ref: '#/components/schemas/AddCredentialsToAgentDevice' 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: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceCredentials/delete: post: tags: - - setCommentsForEvents - summary: Set comments for events - description: Set comments for events - operationId: SetCommentForEvents_Post + - 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/SetCommentForEvents' + $ref: '#/components/schemas/RemoveCredentialsFromAgentDevice' 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' + description: No Content + content: + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceName/update: 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 + - 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/GetInventory' + $ref: '#/components/schemas/SetAgentDeviceName' x-bodyName: body responses: - '200': - description: The paging response base. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetInventoryResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /agentInventoryGrouped: - get: + - $ref: '#/components/parameters/Accept' + /deviceHostType/update: + 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_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 + - 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: - '200': - description: The paging response base. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /testAgentCredentials: 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 + - 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/GetAgentInventoryItemsGrouped' + $ref: '#/components/schemas/TestAgentCredentials' x-bodyName: body responses: '200': - description: The paging response base. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + $ref: '#/components/schemas/TestAgentCredentialsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /agentInventoryAgentsDetail: + - $ref: '#/components/parameters/Accept' + /ipBlocking: 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 + - 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: 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 + - 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. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /ipBlocking/add: 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 + - 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/GetAgentInventoryAgentsDetail' + $ref: '#/components/schemas/AddIpBlocking' x-bodyName: body responses: '200': - description: The paging response base. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' security: - - Bearer: [ ] + - 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: [ ] + - $ref: '#/components/parameters/Accept' + /ipBlocking/delete: 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 + - 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/GetVulnerabilityOverview' + $ref: '#/components/schemas/DeleteIpBlocking' x-bodyName: body responses: '200': - description: The response object for GetVulnerabilityOverview + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetVulnerabilityOverviewResponse' + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/vulnerabilities: - get: + - $ref: '#/components/parameters/Accept' + /discoverDevices: + 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_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 + - 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: The response object for GetVulnerability + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetVulnerabilityResponse' + $ref: '#/components/schemas/DiscoverDevicesResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /discoveredDevices: 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 + - 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/GetVulnerability' + $ref: '#/components/schemas/SubmitDiscoveredDevices' x-bodyName: body responses: - '200': - description: The response object for GetVulnerability + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetVulnerabilityResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/softwareVulnerability: - get: + - $ref: '#/components/parameters/Accept' + /acknowledgeEvents: + 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_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 + - 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: - '200': - description: The response object for GetSoftwareVulnerability + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' + application/json: {} security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /resubmitEvents: 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 + - 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/GetSoftwareVulnerability' + $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: The response object for GetSoftwareVulnerability + description: Describes an event's history. content: application/json: schema: - $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' + $ref: '#/components/schemas/GetEventHistoryResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/update: + - $ref: '#/components/parameters/Accept' + /eventDeviceGroups: 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 + - 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: 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: 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: Success + description: Represents the list of groups that the devices associated with the given events are members of. content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetEventDeviceGroupsResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /setCommentsForEvents: 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 + - 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/MarkInventoryItemsRequiringUpdate' + $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: Success + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetInventoryResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/softwareVulnerabilityDetail: + - $ref: '#/components/parameters/Accept' + /agentInventoryGrouped: 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 + - 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: 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: + - 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 - - 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 + 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 + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' + $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /agentInventoryAgentsDetail: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetSoftwareVulnerabilityDetail' - x-bodyName: body + - 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 response object for GetSoftwareVulnerabilityDetail + description: The paging response base. content: application/json: schema: - $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' + $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/deviceVulnerability: + - $ref: '#/components/parameters/Accept' + /inventory/vulnerabilityOverview: 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 + - 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: 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: + - 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 - - 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 + 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 + description: The response object for GetVulnerabilityOverview content: application/json: schema: - $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' + $ref: '#/components/schemas/GetVulnerabilityOverviewResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/vulnerabilities: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetDeviceVulnerability' - x-bodyName: body + - 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 GetDeviceVulnerability + description: The response object for GetVulnerability content: application/json: schema: - $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' + $ref: '#/components/schemas/GetVulnerabilityResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/deviceVulnerabilityDetail: + - $ref: '#/components/parameters/Accept' + /inventory/softwareVulnerability: 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 + - 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: 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 + - 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 GetDeviceVulnerabilityDetail + description: The response object for GetSoftwareVulnerability content: application/json: schema: - $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' + $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/update: 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 + - 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/GetDeviceVulnerabilityDetail' + $ref: '#/components/schemas/MarkInventoryItemsRequiringUpdate' x-bodyName: body responses: '200': - description: The response object for GetDeviceVulnerabilityDetail + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/relatedSoftwareVulnerabilityDetail: + - $ref: '#/components/parameters/Accept' + /inventory/softwareVulnerabilityDetail: 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 + - 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: 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: + - 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 GetCvesForRelatedCpes + description: The response object for GetSoftwareVulnerabilityDetail content: application/json: schema: - $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' + $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/deviceVulnerability: + 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_Post + - 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: 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: + - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetCvesForRelatedCpes' - x-bodyName: body + 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 GetCvesForRelatedCpes + description: The response object for GetDeviceVulnerability content: application/json: schema: - $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' + $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/vulnerableDeviceDetail: + - $ref: '#/components/parameters/Accept' + /inventory/deviceVulnerabilityDetail: 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 + - 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: 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: + - 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 - - 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 + 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' + $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' security: - - Bearer: [ ] - post: + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/relatedSoftwareVulnerabilityDetail: + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GetVulnerableDeviceDetail' - x-bodyName: body + - 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 GetDeviceVulnerabilityDetail + description: The response object for GetCvesForRelatedCpes content: application/json: schema: - $ref: '#/components/schemas/GetVulnerableDeviceDetailResponse' + $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - /inventory/ignoreCves: + - $ref: '#/components/parameters/Accept' + /inventory/vulnerableDeviceDetail: 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 + - 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: 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: 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: Success + description: The response object for GetDeviceVulnerabilityDetail content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetVulnerableDeviceDetailResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /inventory/ignoreCves: post: tags: - - inventory - summary: A request to ignore one or more Cves until a given data. + - 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: @@ -15658,85 +9742,64 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /vulnerabilityscanstatus: get: tags: - - vulnerabilityscanstatus - summary: A request to return the software vulnerability scan status. + - 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: + - 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 - - 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 + 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 @@ -15745,13 +9808,13 @@ paths: schema: $ref: '#/components/schemas/GetVulnerabilityScanStatusResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /log4netConfigs/all: get: tags: - - log4netConfigs + - log4netConfigs summary: Retrieves a list of log4net logger configurations description: Retrieves a list of log4net logger configurations operationId: GetAllLog4NetConfigItemsall_Get @@ -15763,44 +9826,23 @@ paths: 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: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /log4netConfigs/add: post: tags: - - log4netConfigs + - log4netConfigs operationId: AddLog4NetConfigItemadd_Post parameters: - - name: LoggerName - in: query - schema: - type: string - - name: LogLevel - in: query - schema: - type: string + - name: LoggerName + in: query + schema: + type: string + - name: LogLevel + in: query + schema: + type: string requestBody: content: application/json: @@ -15815,27 +9857,27 @@ paths: schema: $ref: '#/components/schemas/AddLog4NetConfigItemResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /log4netConfigs/update: post: tags: - - log4netConfigs + - 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 + 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: @@ -15850,19 +9892,19 @@ paths: schema: $ref: '#/components/schemas/UpdateLog4NetConfigItemResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /log4netConfigs/delete: post: tags: - - log4netConfigs + - log4netConfigs operationId: DeleteLog4NetConfigItemdelete_Post parameters: - - name: Id - in: query - schema: - type: string + - name: Id + in: query + schema: + type: string requestBody: content: application/json: @@ -15877,85 +9919,64 @@ paths: schema: $ref: '#/components/schemas/DeleteLog4NetConfigItemResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /log4netConfigs: get: tags: - - log4netConfigs - summary: Retrieves a list of log4net logger configurations with pagination support. + - 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: + - 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 - - 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 + 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 @@ -15964,45 +9985,24 @@ paths: schema: $ref: '#/components/schemas/GetLog4NetConfigItemsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /reportDescription: get: tags: - - reportDescription - summary: Returns a description for the specified report. + - 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 + - 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 @@ -16011,48 +10011,24 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /reportDifferences: get: tags: - - reportDifferences - summary: Get a list of differences between two reports runs. + - 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 + - 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 @@ -16064,85 +10040,64 @@ paths: items: $ref: '#/components/schemas/ReportChangeDetail' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/reportData/{reportId}': + - $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.' + - 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: + - 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 - - 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 + 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. @@ -16151,62 +10106,41 @@ paths: schema: $ref: '#/components/schemas/GetReportDataResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /availableReports: get: tags: - - availableReports + - 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 + - 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. @@ -16215,50 +10149,29 @@ paths: schema: $ref: '#/components/schemas/GetAvailableReportsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /userDashboard: get: tags: - - userDashboard - summary: Gets the user dashboard widget layout. + - 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 + - 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. @@ -16267,50 +10180,29 @@ paths: schema: $ref: '#/components/schemas/DashboardLayout' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /userDashboard/named: get: tags: - - userDashboard - summary: Gets the user dashboard widget layout by name. + - 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 + - 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. @@ -16319,55 +10211,14 @@ paths: schema: $ref: '#/components/schemas/DashboardLayout' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - userDashboard + summary: Stores the user dashboard widget layout description: Stores the user dashboard widget layout. operationId: SaveUserDashboardsave_Post requestBody: @@ -16375,49 +10226,23 @@ paths: 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 + x-bodyName: body responses: - '204': - description: No Content + '200': + description: Response to the SaveUserDashboard request. content: - application/json: { } + application/json: + schema: + $ref: '#/components/schemas/SaveUserDashboardResponse' security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /userDashboard/delete: post: tags: - - userDashboard - summary: Deletes the user dashboard widget layout. + - userDashboard + summary: Deletes the user dashboard widget layout description: Deletes the user dashboard widget layout. operationId: DeleteUserDashboarddelete_Post requestBody: @@ -16430,47 +10255,26 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /userSettings: get: tags: - - userSettings - summary: Gets the user settings and selections. + - 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 + - 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. @@ -16479,52 +10283,14 @@ paths: schema: $ref: '#/components/schemas/GetUserSettingsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - userSettings + summary: Stores the user settings and selections description: Stores the user settings and selections. operationId: SaveUserSettingssave_Post requestBody: @@ -16541,45 +10307,24 @@ paths: schema: $ref: '#/components/schemas/GetUserSettingsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /dashboard/widgetTemplates: get: tags: - - dashboard - summary: Gets the dashboard widgets. + - 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 + - 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. @@ -16588,85 +10333,64 @@ paths: schema: $ref: '#/components/schemas/GetDashboardWidgetsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/stats/plannedChanges/hours/{PeriodHours}': + - $ref: '#/components/parameters/Accept' + /stats/plannedChanges/hours/{PeriodHours}: get: tags: - - stats + - 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: + - 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 - - 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 + 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 @@ -16675,314 +10399,230 @@ paths: schema: $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/stats/compliancedata/start/{Start}': + - $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.' + - 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: + - 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 - - 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 + 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.' + description: Compliance data by report, for either individual devices, or as group average. content: application/json: schema: $ref: '#/components/schemas/GetComplianceDataResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/stats/compliancedata/end/{End}': + - $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.' + - 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: + - 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 - - 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 + 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.' + description: Compliance data by report, for either individual devices, or as group average. content: application/json: schema: $ref: '#/components/schemas/GetComplianceDataResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/stats/compliancedata/start/{Start}/end/{End}': + - $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.' + - 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: + - 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 - - 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 + 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.' + 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: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/events/invalidate: post: tags: - - stats - summary: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + - 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: @@ -16995,39 +10635,16 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - testSmtpConnection + summary: Tests the specified SMTP details description: Tests the specified SMTP details. operationId: TestSmtpConnection_Post requestBody: @@ -17044,37 +10661,14 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - testFastConnection + summary: Tests the configured Fast service can be contacted description: Tests the configured Fast service can be contacted. operationId: TestFastConnection_Post requestBody: @@ -17091,37 +10685,14 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17138,37 +10709,14 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - testSyslogConnection + summary: Tests the specified SysLog details description: Tests the specified SysLog details. operationId: TestSyslogConnection_Post requestBody: @@ -17185,37 +10733,14 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - testServiceNowConnection + summary: Tests the specified ServiceNow details description: Tests the specified ServiceNow details. operationId: TestServiceNowConnection_Post requestBody: @@ -17232,37 +10757,14 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - testAuditorConnection + summary: Tests the specified Auditor details description: Tests the specified Auditor details. operationId: TestAuditorConnection_Post requestBody: @@ -17279,48 +10781,24 @@ paths: schema: $ref: '#/components/schemas/ResponseStatus' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /pipelineNodes: get: tags: - - pipelineNodes - summary: Gets a list of pipeline node names. + - 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 + - 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 @@ -17332,37 +10810,14 @@ paths: items: type: string security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - users + summary: Add a user description: Add a user. operationId: AddUseradd_Post requestBody: @@ -17379,14 +10834,14 @@ paths: schema: $ref: '#/components/schemas/UserDetails' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17403,12 +10858,12 @@ paths: schema: $ref: '#/components/schemas/GetUserTwoFactorStatusResponse' parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17425,33 +10880,14 @@ paths: schema: $ref: '#/components/schemas/AuthenticateResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - users + summary: Validates a user password description: Validates a user password. operationId: ValidateUserPasswordvalidatePassword_Post requestBody: @@ -17464,35 +10900,14 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - users + summary: Delete a user description: Delete a user. operationId: DeleteUserdelete_Post requestBody: @@ -17505,47 +10920,26 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/users/{UserName}': + - $ref: '#/components/parameters/Accept' + /users/{UserName}: get: tags: - - users - summary: Get a user's details. + - 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 + - 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 @@ -17554,35 +10948,14 @@ paths: schema: $ref: '#/components/schemas/UserDetails' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17595,37 +10968,16 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17638,37 +10990,16 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17681,39 +11012,16 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17730,14 +11038,14 @@ paths: schema: $ref: '#/components/schemas/ResetUserPasswordResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17754,35 +11062,14 @@ paths: schema: $ref: '#/components/schemas/PreviewResetUserPasswordResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - 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: @@ -17795,38 +11082,15 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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 + - 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 @@ -17844,48 +11108,24 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /timezones: get: tags: - - timezones - summary: Gets a list of possible time zone names. + - 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 + - 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 @@ -17897,46 +11137,24 @@ paths: items: $ref: '#/components/schemas/TimeZoneDetail' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /userHasChangedPassword: get: tags: - - userHasChangedPassword + - 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 + - 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 @@ -17946,37 +11164,14 @@ paths: title: string type: boolean security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - groupAlerts + summary: Add a group alert to a user description: Add a group alert to a user. operationId: AddGroupAlertToUseradd_Post requestBody: @@ -17993,44 +11188,13 @@ paths: schema: $ref: '#/components/schemas/UserDetails' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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 + - groupAlerts summary: Remove a group notification from a user description: Remove a group notification from a user operationId: DeleteGroupAlertFromUserdelete_Post @@ -18044,36 +11208,15 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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 + - groupAlerts summary: Update a group notification from a user description: Update a group notification from a user operationId: UpdateGroupAlertForUserupdate_Post @@ -18087,50 +11230,26 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupAlerts: get: tags: - - groupAlerts - summary: Get the configured notifications for the specified group. + - 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 + - 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 @@ -18142,48 +11261,24 @@ paths: items: $ref: '#/components/schemas/GroupAlert' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /users/: get: tags: - - users - summary: Get a list of user names. + - 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 + - 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 @@ -18195,36 +11290,15 @@ paths: items: $ref: '#/components/schemas/UserDetails' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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: @@ -18240,34 +11314,13 @@ paths: 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' + - $ref: '#/components/parameters/Accept' + /resetAdminPassword/{AdminName}: 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.' + - 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: @@ -18283,34 +11336,13 @@ paths: 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' + - $ref: '#/components/parameters/Accept' + /resetAdminPassword/{OrganizationId}/{AdminName}: 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.' + - 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: @@ -18326,43 +11358,22 @@ paths: schema: $ref: '#/components/schemas/Object' parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /userRoles: get: tags: - - userRoles - summary: Get a list of user roles defined in the system. + - 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 + - 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 @@ -18371,120 +11382,42 @@ paths: schema: $ref: '#/components/schemas/GetUserRolesResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /permissions/: get: tags: - - permissions - summary: Gets a list of permissions names defined in the system. + - 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 + - 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' + title: List + type: array + items: + type: string security: - - Bearer: [ ] + - Bearer: [] + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles/add: post: tags: - - userRoles + - userRoles summary: Adds a custom user role description: Adds a custom user role operationId: AddUserRoleadd_Post @@ -18502,62 +11435,13 @@ paths: schema: $ref: '#/components/schemas/AddUserRoleResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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 + - userRoles summary: Update a user role description: Update a user role operationId: UpdateUserRoleupdate_Post @@ -18575,37 +11459,14 @@ paths: schema: $ref: '#/components/schemas/UpdateUserRoleResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - userRoles + summary: Clone an existing user role description: Clone an existing user role. operationId: CloneUserRoleclone_Post requestBody: @@ -18622,41 +11483,14 @@ paths: schema: $ref: '#/components/schemas/UserRole' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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. + - userRoles + summary: Delete a user role description: Delete a user role. operationId: DeleteUserRoledelete_Post requestBody: @@ -18669,47 +11503,26 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /licenseInfo: get: tags: - - licenseInfo - summary: Represents a request to get an Organization's license info. + - 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 + - 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. @@ -18718,47 +11531,15 @@ paths: schema: $ref: '#/components/schemas/GetLicenseInfoResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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: @@ -18770,48 +11551,26 @@ paths: '204': description: No Content content: - application/json: { } + application/json: {} security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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 + - 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 @@ -18821,46 +11580,24 @@ paths: title: string type: boolean security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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 + - 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 @@ -18870,45 +11607,24 @@ paths: title: string type: boolean security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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 + - 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. @@ -18917,45 +11633,24 @@ paths: schema: $ref: '#/components/schemas/GetRolesAndPermissionsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' + - $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.' + - 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 + - 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. @@ -18964,54 +11659,54 @@ paths: schema: $ref: '#/components/schemas/GetRolesAndPermissionsResponse' security: - - Bearer: [ ] + - Bearer: [] parameters: - - $ref: '#/components/parameters/Accept' - '/auth/{provider}': + - $ref: '#/components/parameters/Accept' + /auth/{provider}: get: tags: - - auth + - 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 + - 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 @@ -19021,48 +11716,48 @@ paths: $ref: '#/components/schemas/AuthenticateResponse' post: tags: - - auth + - 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 + - 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: @@ -19077,51 +11772,51 @@ paths: schema: $ref: '#/components/schemas/AuthenticateResponse' parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /auth: get: tags: - - auth + - 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 + - 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 @@ -19131,47 +11826,47 @@ paths: $ref: '#/components/schemas/AuthenticateResponse' post: tags: - - auth + - 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 + - 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: @@ -19186,21 +11881,21 @@ paths: schema: $ref: '#/components/schemas/AuthenticateResponse' parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /access-token: get: tags: - - auth + - auth operationId: GetAccessToken_Get parameters: - - name: RefreshToken - in: query - schema: - type: string - - name: Meta - in: query - schema: - type: string + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string responses: '200': description: Success @@ -19210,17 +11905,17 @@ paths: $ref: '#/components/schemas/GetAccessTokenResponse' put: tags: - - auth + - auth operationId: GetAccessToken_Create parameters: - - name: RefreshToken - in: query - schema: - type: string - - name: Meta - in: query - schema: - type: string + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string requestBody: content: application/json: @@ -19236,17 +11931,17 @@ paths: $ref: '#/components/schemas/GetAccessTokenResponse' post: tags: - - auth + - auth operationId: GetAccessToken_Post parameters: - - name: RefreshToken - in: query - schema: - type: string - - name: Meta - in: query - schema: - type: string + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string requestBody: content: application/json: @@ -19262,17 +11957,17 @@ paths: $ref: '#/components/schemas/GetAccessTokenResponse' delete: tags: - - auth + - auth operationId: GetAccessToken_Delete parameters: - - name: RefreshToken - in: query - schema: - type: string - - name: Meta - in: query - schema: - type: string + - name: RefreshToken + in: query + schema: + type: string + - name: Meta + in: query + schema: + type: string responses: '200': description: Success @@ -19281,7 +11976,7 @@ paths: schema: $ref: '#/components/schemas/GetAccessTokenResponse' parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' components: schemas: Object: @@ -19290,9 +11985,9 @@ components: GetAgentPoll: title: GetAgentPoll required: - - UniqueId - - AgentId - - PollTimeUtc + - UniqueId + - AgentId + - PollTimeUtc type: object properties: UniqueId: @@ -19323,7 +12018,7 @@ components: 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.' + 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. @@ -19354,16 +12049,16 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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' + title: Dictionary type: object additionalProperties: type: string - description: 'Dictionary' + description: Dictionary DeviceActivity: title: DeviceActivity type: object @@ -19420,7 +12115,7 @@ components: 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.' + 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 @@ -19450,7 +12145,7 @@ components: 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.' + 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. @@ -19475,9 +12170,9 @@ components: SubmitAgentTaskResultStream: title: SubmitAgentTaskResultStream required: - - AgentId - - DeviceId - - TaskId + - AgentId + - DeviceId + - TaskId type: object properties: RequestStream: @@ -19495,7 +12190,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -19509,7 +12204,7 @@ components: 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.' + 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.' @@ -19525,13 +12220,13 @@ components: description: Specifies the result data items. Status: type: string - description: 'Specifies the status of the task. e.g complete, or error.' + 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.' + 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.' + 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 @@ -19592,17 +12287,17 @@ components: 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>' + title: Dictionary> type: object additionalProperties: $ref: '#/components/schemas/Dictionary_String_String_' - description: 'Dictionary>' + description: Dictionary> SubmitAgentTaskResult: title: SubmitAgentTaskResult required: - - AgentId - - DeviceId - - TaskId + - AgentId + - DeviceId + - TaskId type: object properties: AgentId: @@ -19623,23 +12318,23 @@ components: 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).' + 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.' + 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.' + 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.' + description: Adds task result data for the given agent task, called by the agent. AgentDataItem: title: AgentDataItem type: object @@ -19751,13 +12446,13 @@ components: items: $ref: '#/components/schemas/RuleItemResult' Dictionary_String_List_RuleItemResult__: - title: 'Dictionary>' + title: Dictionary> type: object additionalProperties: type: array items: $ref: '#/components/schemas/RuleItemResult' - description: 'Dictionary>' + description: Dictionary> GetCredentials: title: GetCredentials type: object @@ -19770,7 +12465,7 @@ components: 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.' + 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). @@ -19855,7 +12550,7 @@ components: 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.' + 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. @@ -19868,11 +12563,11 @@ components: description: Specifies the report template name. ReturnConfigAsXml: type: boolean - description: 'For any config that needs to be applied, return as XML.' + 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.' + 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. @@ -19884,7 +12579,7 @@ components: $ref: '#/components/schemas/AgentDevice' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -19898,7 +12593,7 @@ components: 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.' + 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 @@ -19907,7 +12602,7 @@ components: $ref: '#/components/schemas/AgentDevice' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -19923,14 +12618,14 @@ components: 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.' + 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.' + 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.' + description: A request to return groups this agent or group is a member of, including parents of parents etc. GetAgents: title: GetAgents type: object @@ -19989,7 +12684,7 @@ components: 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.' + 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. @@ -20003,7 +12698,7 @@ components: format: date-time Type: type: string - description: 'Gets or sets the type, inferred from the presence and number of GroupNames and AgentDeviceIds' + 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. @@ -20049,7 +12744,7 @@ components: 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.' + 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 @@ -20059,7 +12754,7 @@ components: x-nullable: false AllSelected: type: boolean - description: 'Gets a value indicating whether all selected, i.e. no GroupNames or AgentDeviceIds have been specified.' + description: Gets a value indicating whether all selected, i.e. no GroupNames or AgentDeviceIds have been specified. x-nullable: false OnlineStatus: type: string @@ -20070,7 +12765,7 @@ components: 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.' + 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 @@ -20131,7 +12826,7 @@ components: 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.' + 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. @@ -20149,10 +12844,10 @@ components: 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.' + 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.' + 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. @@ -20243,11 +12938,11 @@ components: 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.' + 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.' + 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. @@ -20278,13 +12973,13 @@ components: 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.' + 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.' + 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. @@ -20362,7 +13057,7 @@ components: 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''.' + description: Specifies the 'OnlineDetection' ping timeout seconds, used with 'CredentialsService.Types.OnlineDetection.Ping'. format: int32 x-nullable: false TcpConnectPort: @@ -20378,13 +13073,13 @@ components: $ref: '#/components/schemas/DbConnection' CredentialsTestStatus: type: string - description: 'Specifies the status of the last credentials test, if any.' + 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.' + 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 @@ -20400,7 +13095,7 @@ components: 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.' + 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 @@ -20434,7 +13129,7 @@ components: 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.' + 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. @@ -20449,7 +13144,7 @@ components: 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.' + 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. @@ -20461,7 +13156,7 @@ components: $ref: '#/components/schemas/AgentDevice' AgentDeviceId: type: string - description: 'Specifies the combined agent and device id, for example 1,1.' + 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. @@ -20472,7 +13167,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -20491,10 +13186,10 @@ components: 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.' + 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.' + 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 @@ -20504,7 +13199,7 @@ components: 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.' + 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: @@ -20515,7 +13210,7 @@ components: 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.' + 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 @@ -20584,7 +13279,7 @@ components: 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.' + 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. @@ -20722,13 +13417,13 @@ components: 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.' + description: The event filter text match specifies text to match, together with and operator an case sensitivity setting. Dictionary_String_TextMatch_: - title: 'Dictionary' + title: Dictionary type: object additionalProperties: $ref: '#/components/schemas/TextMatch' - description: 'Dictionary' + description: Dictionary ScoreRange: title: ScoreRange type: object @@ -20755,7 +13450,7 @@ components: 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.' + 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. @@ -20781,7 +13476,7 @@ components: 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.' + 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. @@ -20814,12 +13509,12 @@ components: x-nullable: false DateDevice: type: string - description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + 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.' + 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: @@ -20837,7 +13532,7 @@ components: x-nullable: false Origin: type: string - description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + description: Gets or sets the origin of the event (Polling, LiveTracking etc) TimeZoneId: type: string description: Gets or sets the time zone id. @@ -20868,12 +13563,12 @@ components: 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.' + 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: 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 @@ -20901,7 +13596,7 @@ components: 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.' + 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. @@ -20916,7 +13611,7 @@ components: 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.' + 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. @@ -20932,7 +13627,7 @@ components: 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.' + 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. @@ -20942,7 +13637,7 @@ components: 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' + 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: @@ -20952,7 +13647,7 @@ components: 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.' + 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. @@ -21006,12 +13701,12 @@ components: x-nullable: false DateDevice: type: string - description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + 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.' + 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: @@ -21029,7 +13724,7 @@ components: x-nullable: false Origin: type: string - description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + description: Gets or sets the origin of the event (Polling, LiveTracking etc) TimeZoneId: type: string description: Gets or sets the time zone id. @@ -21060,12 +13755,12 @@ components: 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.' + 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: 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 @@ -21078,7 +13773,7 @@ components: 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.' + 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. @@ -21093,7 +13788,7 @@ components: 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.' + 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. @@ -21103,7 +13798,7 @@ components: properties: BaselineType: type: string - description: 'Gets or sets the baseline type, from None (normal device change event), current baseline state event, historical baseline event.' + 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.' @@ -21113,12 +13808,12 @@ components: 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' + 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.' + description: Gets or sets the names of the changed attributes, if any. AttributeSeparators: $ref: '#/components/schemas/Dictionary_String_String_' CurrentAttributes: @@ -21128,7 +13823,7 @@ components: 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.' + 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. @@ -21151,12 +13846,12 @@ components: 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.' + 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' + description: List of line text differences, for process output tracker content comparison Comment: type: string description: Gets or sets the event comment. @@ -21189,12 +13884,12 @@ components: x-nullable: false DateDevice: type: string - description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + 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.' + 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: @@ -21212,7 +13907,7 @@ components: x-nullable: false Origin: type: string - description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + description: Gets or sets the origin of the event (Polling, LiveTracking etc) TimeZoneId: type: string description: Gets or sets the time zone id. @@ -21243,12 +13938,12 @@ components: 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.' + 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: 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 @@ -21270,7 +13965,7 @@ components: 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.' + 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. @@ -21280,7 +13975,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -21290,7 +13985,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -21300,7 +13995,7 @@ components: 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).' + 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). @@ -21331,17 +14026,17 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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.' + 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. @@ -21351,20 +14046,20 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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.' + 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.' + description: Gets the pipeline status, returning a dictionary of pipeline components and their current status. GetPipelineMetrics: title: GetPipelineMetrics type: object @@ -21381,7 +14076,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -21391,7 +14086,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -21401,7 +14096,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -21415,7 +14110,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -21431,7 +14126,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -21443,7 +14138,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -21468,7 +14163,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -21488,7 +14183,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -21508,16 +14203,16 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - ReportTemplateType + - TemplateName + - TemplateVersion type: object properties: ReportTemplateType: @@ -21531,14 +14226,14 @@ components: 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.' + 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 + - DateRange type: object properties: ExcludeEvents: @@ -21573,7 +14268,7 @@ components: 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' + 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: @@ -21583,10 +14278,10 @@ components: 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.' + 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.' + 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 @@ -21636,15 +14331,15 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - ReportItemId + - ReportInstanceId type: object properties: ReportItemId: @@ -21658,7 +14353,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + description: Specifies the request version. If specified, this indicates the service model version the request complies with. format: int32 x-nullable: false description: GetComplianceReportSummaryData @@ -21696,14 +14391,14 @@ components: 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.' + 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 + - ReportItemId type: object properties: DeviceFilter: @@ -21764,10 +14459,10 @@ components: 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.' + 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.' + description: Get report summaries by report, for either individual devices, or as group average. GetAvailableComplianceData: title: GetAvailableComplianceData type: object @@ -21785,7 +14480,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -21807,7 +14502,7 @@ components: $ref: '#/components/schemas/DeviceFilter' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -21882,10 +14577,10 @@ components: 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.' + 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.' + 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 @@ -21894,11 +14589,11 @@ components: 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.' + 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 + - ReportItemId type: object properties: ReportItemId: @@ -21906,7 +14601,7 @@ components: 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.' + 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 @@ -21924,14 +14619,14 @@ components: 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.' + 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.' + 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 @@ -22042,8 +14737,8 @@ components: RenderReport: title: RenderReport required: - - ReportItemId - - InstanceId + - ReportItemId + - InstanceId type: object properties: RendererType: @@ -22063,18 +14758,18 @@ components: 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.' + 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.' + 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 + - ReportItemId + - InstanceId type: object properties: RendererType: @@ -22091,10 +14786,10 @@ components: $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.' + 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.' + 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 @@ -22109,7 +14804,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -22123,15 +14818,15 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - ReportItemId + - InstanceId type: object properties: ReportItemId: @@ -22142,15 +14837,15 @@ components: 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.' + 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 + - ReportItemId + - InstanceId type: object properties: ReportItemId: @@ -22165,7 +14860,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -22178,26 +14873,26 @@ components: 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.' + 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 + - Id type: object properties: Id: type: string - description: 'The id of the type of report to add, from the list supplied by GetAvailableReportTypes' + 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' + 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 @@ -22208,7 +14903,7 @@ components: 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.' + 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 @@ -22230,17 +14925,17 @@ components: 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.' + 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.' + 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.' + description: Specifies long to wait for a run's queries to complete, in minutes. format: int32 x-nullable: false OverrideWaitForResults: @@ -22265,7 +14960,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -22306,7 +15001,7 @@ components: 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' + 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: @@ -22316,10 +15011,10 @@ components: 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.' + 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.' + 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 @@ -22440,15 +15135,15 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - ReportItemId + - InstanceId type: object properties: SummaryOnly: @@ -22463,7 +15158,7 @@ components: 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.' + 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 @@ -22473,7 +15168,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -22503,7 +15198,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -22513,13 +15208,13 @@ components: properties: VersionRequested: type: string - description: 'Used when requesting an update file from the hub, specifies the specific version required.' + 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).' + 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.' + 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. @@ -22532,7 +15227,7 @@ components: 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.' + 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. @@ -22548,13 +15243,13 @@ components: description: Specifies the specific agent update ID to get. UpdateType: type: string - description: 'Gets or sets the update type (deb, rpm etc)' + 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.' + 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.' + description: Gets a list of Agent updates, by version or specific ID. GetAgentSoftwareUpdateScheduleForGroup: title: GetAgentSoftwareUpdateScheduleForGroup type: object @@ -22564,7 +15259,7 @@ components: 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.' + 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. @@ -22577,7 +15272,7 @@ components: 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.' + 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. @@ -22592,7 +15287,7 @@ components: $ref: '#/components/schemas/GroupAgentUpdateSchedule' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22638,7 +15333,7 @@ components: $ref: '#/components/schemas/GroupAgentUpdateSchedule' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22670,15 +15365,15 @@ components: 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.' + 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 + - Key + - Value type: object properties: Key: @@ -22693,15 +15388,15 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - Key + - Value type: object properties: Key: @@ -22716,14 +15411,14 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - Key type: object properties: Key: @@ -22731,7 +15426,7 @@ components: description: The configuration key Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22752,7 +15447,7 @@ components: description: Specifies a list of specific configuration parameter 'Keys' to retrieved (Optional). IncludeHidden: type: boolean - description: 'Include hidden, ''system'', parameters.' + description: Include hidden, 'system', parameters. x-nullable: false CountOnly: type: boolean @@ -22778,7 +15473,7 @@ components: 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.' + 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. @@ -22790,7 +15485,7 @@ components: $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.' + 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. @@ -22805,7 +15500,7 @@ components: 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.' + 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. @@ -22827,7 +15522,7 @@ components: 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.' + 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. @@ -22843,7 +15538,7 @@ components: 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.' + 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. @@ -22863,7 +15558,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22878,7 +15573,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22890,7 +15585,7 @@ components: $ref: '#/components/schemas/Credentials' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22945,7 +15640,7 @@ components: type: string DiscoveryTaskStatus: type: string - description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + description: Represents some credentials used to connect to a remote service (e.g SSH, database etc). UpdateCredentials: title: UpdateCredentials type: object @@ -22960,7 +15655,7 @@ components: $ref: '#/components/schemas/Credentials' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22976,7 +15671,7 @@ components: description: Specifies the key. Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -22986,10 +15681,10 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + description: Get a list of all the known credentials, keyed by the type. GetCredentialsList: title: GetCredentialsList type: object @@ -23001,7 +15696,7 @@ components: $ref: '#/components/schemas/DeviceFilter' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -23022,10 +15717,10 @@ components: format: int32 Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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 @@ -23037,7 +15732,7 @@ components: 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.' + 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. @@ -23084,10 +15779,10 @@ components: x-nullable: false Status: type: string - description: 'Specifies the status, ''in progress'', ''complete'' etc. See ''AgentTaskStatus''.' + description: Specifies the status, 'in progress', 'complete' etc. See 'AgentTaskStatus'. StatusMessage: type: string - description: 'Specifies the additional status message, if any.' + description: Specifies the additional status message, if any. StatusUpdatedUtc: type: string description: Specifies the utc time the status of the task was updated. @@ -23138,19 +15833,19 @@ components: x-nullable: false HostType: type: string - description: 'Specifies the host type the file hash binary is required for (e.g Unix, Windows etc)' + 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' + 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.' + 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. @@ -23160,14 +15855,14 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - InstanceId type: object properties: InstanceId: @@ -23175,14 +15870,14 @@ components: 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.' + 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 + - InstanceId type: object properties: InstanceId: @@ -23194,14 +15889,14 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - InstanceId type: object properties: GroupName: @@ -23215,7 +15910,7 @@ components: 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.' + 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 @@ -23225,7 +15920,7 @@ components: 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.' + 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. @@ -23237,7 +15932,7 @@ components: 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.' + 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: @@ -23278,7 +15973,7 @@ components: 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.' + 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 @@ -23286,14 +15981,14 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - InstanceId type: object properties: InstanceId: @@ -23332,7 +16027,7 @@ components: 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.' + 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. @@ -23357,14 +16052,14 @@ components: 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.' + 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 + - InstanceId type: object properties: InstanceId: @@ -23376,7 +16071,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -23413,11 +16108,11 @@ components: 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.' + 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.' + 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 @@ -23454,14 +16149,14 @@ components: 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.' + 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.' + description: Gets planned change instances name and id, filtering by name, id or groups that are members. AddPlannedChangeInstanceMember: title: AddPlannedChangeInstanceMember required: - - InstanceId + - InstanceId type: object properties: MemberGroups: @@ -23479,14 +16174,14 @@ components: 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.' + 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 + - InstanceId type: object properties: AllEventsSelected: @@ -23538,10 +16233,10 @@ components: 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.' + 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.' + 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. @@ -23594,7 +16289,7 @@ components: AddReEvaluationOfPlannedChangeInstanceEvents: title: AddReEvaluationOfPlannedChangeInstanceEvents required: - - InstanceId + - InstanceId type: object properties: InstanceId: @@ -23613,7 +16308,7 @@ components: 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.' + 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. @@ -23650,18 +16345,18 @@ components: 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.' + 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.' + 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.' + 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 @@ -23698,17 +16393,17 @@ components: 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.' + 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.' + 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.' + description: Specifies the request version. If specified, this indicates the service model version the request complies with. format: int32 x-nullable: false Name: @@ -23722,7 +16417,7 @@ components: 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.' + 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. @@ -23735,7 +16430,7 @@ components: 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.' + 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_' @@ -23788,7 +16483,7 @@ components: 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' + 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. @@ -23796,14 +16491,14 @@ components: 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: 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' + title: Dictionary type: object additionalProperties: $ref: '#/components/schemas/PlannedChangeRule' - description: 'Dictionary' + description: Dictionary UploadPlannedChange: title: UploadPlannedChange type: object @@ -23814,7 +16509,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -23835,7 +16530,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -23857,15 +16552,15 @@ components: 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.' + 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.' + 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.' + 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 @@ -23878,7 +16573,7 @@ components: 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.' + 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. @@ -23896,10 +16591,10 @@ components: 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.' + 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.' + description: Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change. ApplyPlannedChangePlan: title: ApplyPlannedChangePlan type: object @@ -23916,10 +16611,10 @@ components: $ref: '#/components/schemas/RuleReductionPlan2' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + description: Apply rule reduction plans to the specified planned change, simplifying the associated rulesets. RuleReductionPlan2: title: RuleReductionPlan2 type: object @@ -23945,7 +16640,7 @@ components: $ref: '#/components/schemas/PlannedChangeRule' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -23960,7 +16655,7 @@ components: $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.' + 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 @@ -23976,7 +16671,7 @@ components: 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.' + 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 @@ -23989,7 +16684,7 @@ components: 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.' + 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. @@ -24004,7 +16699,7 @@ components: $ref: '#/components/schemas/PlannedChangeRule' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -24048,10 +16743,10 @@ components: 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.' + 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.' + description: Gets a list of planned change ruleset definitions, filtered by name or id. ParseCommands: title: ParseCommands type: object @@ -24072,10 +16767,10 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + description: Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure. CreateWhitelistedCommandComponent: title: CreateWhitelistedCommandComponent type: object @@ -24093,7 +16788,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24109,7 +16804,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24162,7 +16857,7 @@ components: 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.' + 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. @@ -24184,7 +16879,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24201,7 +16896,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24221,7 +16916,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24237,7 +16932,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24271,7 +16966,7 @@ components: 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.' + 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. @@ -24305,7 +17000,7 @@ components: 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.' + 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. @@ -24321,10 +17016,10 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + description: Attempts to set the given template(s) to a command component, clearing old templates if they exist. GetCloudTemplateCreationStatus: title: GetCloudTemplateCreationStatus type: object @@ -24341,7 +17036,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -24354,7 +17049,7 @@ components: 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.' + 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. @@ -24367,7 +17062,7 @@ components: 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.' + 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. @@ -24381,13 +17076,13 @@ components: type: array items: type: string - description: 'Specifies the policy usages type to store on the Template e.g. Baseline, Tracking etc...' + 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.' + 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. @@ -24779,7 +17474,7 @@ components: $ref: '#/components/schemas/AgentTracker' NotificationRefId: type: string - description: 'Specifies a value indicating the default NotificationRefId for the template, used for future trackers' + 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 @@ -24805,7 +17500,7 @@ components: 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.' + 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: @@ -24814,7 +17509,7 @@ components: x-nullable: false IsSystem: type: boolean - description: 'Specifies a value indicating whether this is a system item, or local to the template.' + 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: @@ -24850,7 +17545,7 @@ components: x-nullable: false IsSystem: type: boolean - description: 'Specifies a value indicating whether this is a system item, or local to the template.' + 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: @@ -24881,7 +17576,7 @@ components: x-nullable: false IsSystem: type: boolean - description: 'Specifies a value indicating whether this is a system item, or local to the template.' + 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: @@ -24932,7 +17627,7 @@ components: x-nullable: false Attributes: type: boolean - description: 'Specifies a value indicating whether to report changes to file attributes (readonly, archive, hidden etc).' + description: Specifies a value indicating whether to report changes to file attributes (readonly, archive, hidden etc). x-nullable: false Security: type: boolean @@ -24944,7 +17639,7 @@ components: x-nullable: false IsSystem: type: boolean - description: 'Specifies a value indicating whether this is a system item, or local to the template.' + description: Specifies a value indicating whether this is a system item, or local to the template. x-nullable: false All: type: boolean @@ -25006,7 +17701,7 @@ components: $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.' + 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. @@ -25018,7 +17713,7 @@ components: 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.' + 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: @@ -25050,7 +17745,7 @@ components: 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.' + 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: @@ -25233,13 +17928,13 @@ components: $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.' + 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.' + 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: @@ -25271,7 +17966,7 @@ components: 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.' + 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: @@ -25441,7 +18136,7 @@ components: description: Gets or sets the command line. CommandLineScript: type: string - description: 'Gets or sets the multi-line command script, when CommandType is PowerShellScript.' + 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. @@ -25505,7 +18200,7 @@ components: 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''.' + 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: @@ -25740,7 +18435,7 @@ components: 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.' + 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. @@ -25768,7 +18463,7 @@ components: $ref: '#/components/schemas/ProposedPolicyChange' StartUtc: type: string - description: 'Gets or sets the start of the period to return events for, null implies all.' + description: Gets or sets the start of the period to return events for, null implies all. format: date-time ApplyProcessPortRange: type: boolean @@ -25780,7 +18475,7 @@ components: 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.' + 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 @@ -25809,7 +18504,7 @@ components: x-nullable: false PortProcEphemeralRange: type: boolean - description: 'Specifies if true, that only ports in the ephemeral range opened by known processes are allowed' + description: Specifies if true, that only ports in the ephemeral range opened by known processes are allowed x-nullable: false NoOthersRuleTrackerName: type: string @@ -25899,7 +18594,7 @@ components: 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' + description: Specifies a copy of an existing template should only copy the tracking information, not the values x-nullable: false AsCopyOfVersion: type: string @@ -25909,7 +18604,7 @@ components: items: type: string x-nullable: false - description: 'Specifies extra UsageTagsApplicable to record against the template, in addition to those specified in the Xml' + 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 @@ -25927,7 +18622,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -25940,10 +18635,10 @@ components: 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.' + 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.' + 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. @@ -25965,7 +18660,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -25981,7 +18676,7 @@ components: 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.' + 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. @@ -25993,7 +18688,7 @@ components: $ref: '#/components/schemas/AgentDevice' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26011,7 +18706,7 @@ components: 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.' + 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. @@ -26023,7 +18718,7 @@ components: $ref: '#/components/schemas/AgentDevice' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26039,7 +18734,7 @@ components: 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.' + 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. @@ -26110,7 +18805,7 @@ components: 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.' + 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. @@ -26127,7 +18822,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26144,13 +18839,13 @@ components: 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.' + 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.' + 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).' + 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 @@ -26165,7 +18860,7 @@ components: 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.' + 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. @@ -26208,7 +18903,7 @@ components: 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.' + 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. @@ -26223,7 +18918,7 @@ components: 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.' + 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. @@ -26233,7 +18928,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + description: Specifies the request version. If specified, this indicates the service model version the request complies with. format: int32 x-nullable: false VersionString: @@ -26266,7 +18961,7 @@ components: 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.' + 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. @@ -26288,7 +18983,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26309,7 +19004,7 @@ components: 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.' + 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. @@ -26367,7 +19062,7 @@ components: 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.' + 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. @@ -26405,7 +19100,7 @@ components: 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.' + 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. @@ -26429,7 +19124,7 @@ components: 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.' + 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. @@ -26458,7 +19153,7 @@ components: 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.' + 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. @@ -26475,14 +19170,14 @@ components: 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.' + 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 + - GroupType type: object properties: ParentGroupName: @@ -26493,10 +19188,10 @@ components: description: Specifies the display name of the new group GroupType: enum: - - None - - UserContainer - - DeviceContainer - - GroupContainer + - 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 @@ -26514,14 +19209,14 @@ components: 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.' + 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 + - Name type: object properties: Name: @@ -26540,7 +19235,7 @@ components: 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.' + 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. @@ -26552,17 +19247,17 @@ components: type: array items: type: string - description: 'The agent device ids to delete from their current groups, moving them to the Deleted group.' + 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.' + 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 + - OfflineSeconds type: object properties: OfflineSeconds: @@ -26582,7 +19277,7 @@ components: 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.' + 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. @@ -26604,10 +19299,10 @@ components: 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.' + 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.' + 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 @@ -26619,7 +19314,7 @@ components: 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.' + 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. @@ -26635,10 +19330,10 @@ components: 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.' + 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.' + 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 @@ -26647,7 +19342,7 @@ components: $ref: '#/components/schemas/DeviceFilter' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26662,7 +19357,7 @@ components: $ref: '#/components/schemas/DeviceFilter' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26674,10 +19369,10 @@ components: $ref: '#/components/schemas/DeviceFilter' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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 @@ -26687,7 +19382,7 @@ components: 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.' + 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. @@ -26725,7 +19420,7 @@ components: 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.' + 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. @@ -26753,7 +19448,7 @@ components: 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.' + 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. @@ -26776,7 +19471,7 @@ components: 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.' + 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. @@ -26792,7 +19487,7 @@ components: 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.' + 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 @@ -26814,10 +19509,10 @@ components: 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.' + 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.' + description: Gets the device settings for the device, based on the global device settings and any device specific overrides. AddCredentialsToAgentDevice: title: AddCredentialsToAgentDevice type: object @@ -26829,7 +19524,7 @@ components: 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.' + 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. @@ -26844,7 +19539,7 @@ components: 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.' + 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. @@ -26859,7 +19554,7 @@ components: 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.' + 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. @@ -26882,7 +19577,7 @@ components: 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.' + 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. @@ -26892,7 +19587,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26910,7 +19605,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26923,7 +19618,7 @@ components: 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.' + 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. @@ -26955,7 +19650,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -26982,7 +19677,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -27032,18 +19727,18 @@ components: $ref: '#/components/schemas/EventFilter' StartUtc: type: string - description: 'Gets or sets the start of the period to return events for, null implies all.' + 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.' + 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.' + 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'. @@ -27055,7 +19750,7 @@ components: $ref: '#/components/schemas/GetEvents' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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).' @@ -27068,7 +19763,7 @@ components: 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.' + 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. @@ -27091,11 +19786,11 @@ components: $ref: '#/components/schemas/EventFilter' StartUtc: type: string - description: 'Gets or sets the start of the period to return events for, null implies all.' + 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.' + 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 @@ -27105,10 +19800,10 @@ components: 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.' + 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.' + 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 @@ -27120,7 +19815,7 @@ components: description: The comment Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -27175,7 +19870,7 @@ components: 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.' + 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. @@ -27275,7 +19970,7 @@ components: 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.' + 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. @@ -27311,7 +20006,7 @@ components: 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.' + 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. @@ -27361,7 +20056,7 @@ components: 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.' + 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. @@ -27400,7 +20095,7 @@ components: 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.' + 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. @@ -27447,7 +20142,7 @@ components: 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.' + 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. @@ -27472,7 +20167,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -27657,7 +20352,7 @@ components: 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.' + 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. @@ -27701,7 +20396,7 @@ components: 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.' + 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. @@ -27738,7 +20433,7 @@ components: 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.' + 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. @@ -27791,7 +20486,7 @@ components: 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.' + 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. @@ -27813,7 +20508,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -27845,7 +20540,7 @@ components: 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.' + 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. @@ -27908,7 +20603,7 @@ components: 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.' + 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. @@ -27923,7 +20618,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -27943,7 +20638,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -27977,10 +20672,10 @@ components: 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.' + 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.' + description: Gets report results for the specified agent, device or task id. GetAvailableReports: title: GetAvailableReports type: object @@ -27997,7 +20692,7 @@ components: format: date-time Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' @@ -28010,7 +20705,7 @@ components: 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.' + 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. @@ -28023,7 +20718,7 @@ components: 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.' + 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. @@ -28033,7 +20728,7 @@ components: properties: Id: type: string - description: 'The identifier of the dashboard to get. If not supplied a new record is created, else existing is updated.' + 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. @@ -28044,7 +20739,7 @@ components: description: The widgets. Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28107,7 +20802,7 @@ components: x-nullable: false timePeriodSizeSeconds: type: integer - description: 'The time period size of the widget data, in seconds.' + description: The time period size of the widget data, in seconds. format: int32 x-nullable: false eventTypes: @@ -28134,7 +20829,7 @@ components: 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.' + 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. @@ -28144,7 +20839,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28163,7 +20858,7 @@ components: 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.' + 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. @@ -28173,7 +20868,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28191,7 +20886,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28223,7 +20918,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28233,7 +20928,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28243,7 +20938,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28267,7 +20962,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28292,7 +20987,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28319,7 +21014,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28335,7 +21030,7 @@ components: format: date-time Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28352,7 +21047,7 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28426,11 +21121,11 @@ components: UserDateFormats: title: UserDateFormats required: - - Name - - LongDateTimeFormatNet - - ShortDateTimeFormatNet - - LongDateTimeFormatJs - - ShortDateTimeFormatJs + - Name + - LongDateTimeFormatNet + - ShortDateTimeFormatNet + - LongDateTimeFormatJs + - ShortDateTimeFormatJs type: object properties: Name: @@ -28483,7 +21178,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28495,7 +21190,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28511,7 +21206,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28523,7 +21218,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28535,7 +21230,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28547,7 +21242,7 @@ components: $ref: '#/components/schemas/UserDetails' Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28563,7 +21258,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28575,7 +21270,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28591,7 +21286,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28603,7 +21298,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28615,7 +21310,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28631,7 +21326,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -28641,7 +21336,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28651,7 +21346,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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? @@ -28672,7 +21367,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28688,7 +21383,7 @@ components: 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.' + 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 @@ -28711,7 +21406,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 @@ -28723,7 +21418,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28735,7 +21430,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28751,10 +21446,10 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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 @@ -28763,7 +21458,7 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28773,15 +21468,15 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - DisplayName + - ReadOnly type: object properties: Name: @@ -28800,20 +21495,20 @@ components: 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.' + 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.' + 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 + - Name + - DisplayName + - Permissions type: object properties: Name: @@ -28832,7 +21527,7 @@ components: 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.' + 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 @@ -28846,14 +21541,14 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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 + - Name type: object properties: Name: @@ -28861,7 +21556,7 @@ components: 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.' + 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. @@ -28871,7 +21566,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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. @@ -28888,10 +21583,10 @@ components: x-nullable: false Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + description: Represents a request to update an Organization, used to set the license. HasRoleOrPermission: title: HasRoleOrPermission type: object @@ -28908,10 +21603,10 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + description: Checks whether the caller, or the named user if supplied, has the specified roles and permissions. GetRolesAndPermissions: title: GetRolesAndPermissions type: object @@ -28920,17 +21615,17 @@ components: type: string Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + 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.' + 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' + description: AuthProvider, e.g. credentials UserName: type: string Password: @@ -28960,7 +21655,7 @@ components: GetAgentPollResponse: title: GetAgentPollResponse required: - - Version + - Version type: object properties: AgentId: @@ -28983,7 +21678,7 @@ components: 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.' + 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' @@ -28994,12 +21689,12 @@ components: x-nullable: false description: The response object for GetAgentPoll Dictionary_String_Nullable_DateTime__: - title: 'Dictionary>' + title: Dictionary> type: object additionalProperties: type: string format: date-time - description: 'Dictionary>' + description: Dictionary> DeviceSettings: title: DeviceSettings type: object @@ -29017,7 +21712,7 @@ components: 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.' + 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 @@ -29039,7 +21734,7 @@ components: 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.' + 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: @@ -29057,7 +21752,7 @@ components: x-nullable: false PollPeriodSeconds: type: integer - description: 'The poll period / frequency for this device / group, in seconds.' + description: The poll period / frequency for this device / group, in seconds. format: int32 x-nullable: false PollGracePeriodSeconds: @@ -29093,11 +21788,11 @@ components: 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.' + 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 + - Version type: object properties: Tasks: @@ -29124,8 +21819,8 @@ components: SubmitAgentTaskResultStreamResponse: title: SubmitAgentTaskResultStreamResponse required: - - StoredId - - Version + - StoredId + - Version type: object properties: StoredId: @@ -29140,7 +21835,7 @@ components: GetPolicyTemplatesResponse: title: GetPolicyTemplatesResponse required: - - Version + - Version type: object properties: Templates: @@ -29231,7 +21926,7 @@ components: type: array items: type: string - description: 'Specifies the names of the trackers configured in this template, if it is a ''PolicyTemplateType.DeviceConfig''.' + 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. @@ -29248,11 +21943,11 @@ components: 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.' + 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 + - Version type: object properties: PolicyTemplateName: @@ -29304,7 +21999,7 @@ components: GetAgentsResponse: title: GetAgentsResponse required: - - Version + - Version type: object properties: AgentCredentials: @@ -29336,7 +22031,7 @@ components: 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.' + 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. @@ -29371,7 +22066,7 @@ components: 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.' + 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. @@ -29425,7 +22120,7 @@ components: SearchAgentsResponse: title: SearchAgentsResponse required: - - Version + - Version type: object properties: Agents: @@ -29462,7 +22157,7 @@ components: GetDeviceConfigResponse: title: GetDeviceConfigResponse required: - - Version + - Version type: object properties: DeviceTemplate: @@ -29471,7 +22166,7 @@ components: $ref: '#/components/schemas/PolicyTemplateRuleSet' Xml: type: string - description: 'Specifies the xml. Only one of DeviceTemplate, PolicyRuleSet or Xml string can be returned.' + 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. @@ -29481,24 +22176,24 @@ components: GetDeviceSettingsResponse: title: GetDeviceSettingsResponse required: - - Version + - 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.' + 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.' + description: Represents the device specific options such as customised local ui password details, and tracker performance settings. GetEventsResponse: title: GetEventsResponse required: - - Version + - Version type: object properties: Events: @@ -29592,12 +22287,12 @@ components: x-nullable: false DateDevice: type: string - description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + 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.' + 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: @@ -29615,7 +22310,7 @@ components: x-nullable: false Origin: type: string - description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + description: Gets or sets the origin of the event (Polling, LiveTracking etc) TimeZoneId: type: string description: Gets or sets the time zone id. @@ -29646,12 +22341,12 @@ components: 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.' + 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: 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 @@ -29708,12 +22403,12 @@ components: x-nullable: false DateDevice: type: string - description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + 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.' + 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: @@ -29731,7 +22426,7 @@ components: x-nullable: false Origin: type: string - description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + description: Gets or sets the origin of the event (Polling, LiveTracking etc) TimeZoneId: type: string description: Gets or sets the time zone id. @@ -29762,12 +22457,12 @@ components: 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.' + 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: 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 @@ -29810,12 +22505,12 @@ components: x-nullable: false DateDevice: type: string - description: 'Gets or sets the device date and time of the event, based on the event UtcOffsetHours' + 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.' + 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: @@ -29833,7 +22528,7 @@ components: x-nullable: false Origin: type: string - description: 'Gets or sets the origin of the event (Polling, LiveTracking etc)' + description: Gets or sets the origin of the event (Polling, LiveTracking etc) TimeZoneId: type: string description: Gets or sets the time zone id. @@ -29864,17 +22559,17 @@ components: 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.' + 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: 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 + - Version type: object properties: BackOffSeconds: @@ -29890,7 +22585,7 @@ components: SubmitBaselineEventsLimitedResponse: title: SubmitBaselineEventsLimitedResponse required: - - Version + - Version type: object properties: BackOffSeconds: @@ -29906,7 +22601,7 @@ components: SubmitDeviceEventsLimitedResponse: title: SubmitDeviceEventsLimitedResponse required: - - Version + - Version type: object properties: BackOffSeconds: @@ -29922,7 +22617,7 @@ components: SystemReadyResponse: title: SystemReadyResponse required: - - Version + - Version type: object properties: IsReady: @@ -29974,12 +22669,12 @@ components: properties: SessionTimeout: type: integer - description: 'Specifies the length of time after which a session should timeout, expressed in minutes.' + 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.' + description: Specifies the length of time a session timeout warning should be available, expressed in seconds. format: int32 x-nullable: false LicenseDaysRemaining: @@ -30134,20 +22829,20 @@ components: items: $ref: '#/components/schemas/BackgroundTaskDetails' Dictionary_String_ComponentStatus_: - title: 'Dictionary' + title: Dictionary type: object additionalProperties: enum: - - Unknown - - Starting - - Up - - Stopping - - Down - - Busy - - Fault - - RequiresUpgrade + - Unknown + - Starting + - Up + - Stopping + - Down + - Busy + - Fault + - RequiresUpgrade type: string - description: 'Dictionary' + description: Dictionary PerformanceSnapshot: title: PerformanceSnapshot type: object @@ -30195,13 +22890,13 @@ components: type: string description: PerformanceItem Dictionary_String_Double_: - title: 'Dictionary' + title: Dictionary type: object additionalProperties: type: number format: double x-nullable: false - description: 'Dictionary' + description: Dictionary List_PerformanceSnapshot_: title: List type: array @@ -30210,7 +22905,7 @@ components: GetCacheStatsResponse: title: GetCacheStatsResponse required: - - Version + - Version type: object properties: GroupCounts: @@ -30243,7 +22938,7 @@ components: GetAvailableReportTypesResponse: title: GetAvailableReportTypesResponse required: - - Version + - Version type: object properties: Items: @@ -30268,7 +22963,7 @@ components: GetReportTemplatesResponse: title: GetReportTemplatesResponse required: - - Version + - Version type: object properties: Items: @@ -30317,7 +23012,7 @@ components: GetScheduledReportsResponse: title: GetScheduledReportsResponse required: - - Version + - Version type: object properties: Items: @@ -30330,7 +23025,7 @@ components: 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' + 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 @@ -30388,12 +23083,12 @@ components: $ref: '#/components/schemas/ReportEmailDelivery' KeepUnscheduledResultsForMinutes: type: integer - description: 'Specifies how long to keep ''adhoc'' (ie non-scheduled) report results for, in minutes.' + 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.' + description: Specifies how long to keep scheduled report results for, in minutes. format: int32 x-nullable: false ScheduledState: @@ -30403,7 +23098,7 @@ components: 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.' + description: Specifies long to wait for a run's queries to complete, in minutes. format: int32 x-nullable: false OverrideWaitForResults: @@ -30414,7 +23109,7 @@ components: UpdateReportTemplateResponse: title: UpdateReportTemplateResponse required: - - Version + - Version type: object properties: FileId: @@ -30428,7 +23123,7 @@ components: DataSpecDeviceMonitoringReportResponse: title: DataSpecDeviceMonitoringReportResponse required: - - Version + - Version type: object properties: ReportMetadata: @@ -30448,14 +23143,14 @@ components: 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' + 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.' + 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.' + 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. @@ -30468,13 +23163,13 @@ components: ReportMetadata: title: ReportMetadata required: - - ReportItemId - - ReportInstanceId + - ReportItemId + - ReportInstanceId type: object properties: AgentDeviceId: type: string - description: 'Specifies the combined agent and device id, for example 1,1.' + description: Specifies the combined agent and device id, for example 1,1. DeviceName: type: string description: Specifies the device name. @@ -30535,7 +23230,7 @@ components: description: Specifies the report error message if any. DeviceStatusMessage: type: string - description: 'Specifies the report status message for the device, if any.' + description: Specifies the report status message for the device, if any. Id: type: string InstanceType: @@ -30646,19 +23341,19 @@ components: 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.' + 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)' + 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.' + 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.' + 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.. @@ -30710,7 +23405,7 @@ components: 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''.' + description: Specifies the 'OnlineDetection' ping timeout seconds, used with 'CredentialsService.Types.OnlineDetection.Ping'. format: int32 x-nullable: false TcpConnectPort: @@ -30724,7 +23419,7 @@ components: 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.' + 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. @@ -30780,12 +23475,12 @@ components: type: array items: $ref: '#/components/schemas/NameValuePair' - description: 'Specifies the list of agent credentials, used by this agent to connect to other proxied devices.' + 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.' + 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. @@ -30829,7 +23524,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + description: Specifies the request version. If specified, this indicates the service model version the request complies with. format: int32 x-nullable: false VersionString: @@ -30900,13 +23595,13 @@ components: items: $ref: '#/components/schemas/PolicyTemplateDetails' Dictionary_String_List_PolicyTemplateDetails__: - title: 'Dictionary>' + title: Dictionary> type: object additionalProperties: type: array items: $ref: '#/components/schemas/PolicyTemplateDetails' - description: 'Dictionary>' + description: Dictionary> DeviceEventCountsSummary: title: DeviceEventCountsSummary type: object @@ -31040,7 +23735,7 @@ components: GetRuleResultsResponse: title: GetRuleResultsResponse required: - - Version + - Version type: object properties: Items: @@ -31102,17 +23797,17 @@ components: $ref: '#/components/schemas/TextDifference' description: RuleResultState Dictionary_String_List_String__: - title: 'Dictionary>' + title: Dictionary> type: object additionalProperties: type: array items: type: string - description: 'Dictionary>' + description: Dictionary> ComplianceReportSummaryResponse: title: ComplianceReportSummaryResponse required: - - Version + - Version type: object properties: GroupName: @@ -31216,7 +23911,7 @@ components: GetCurrentPlannedChangesResponse: title: GetCurrentPlannedChangesResponse required: - - Version + - Version type: object properties: PlannedChanges: @@ -31262,7 +23957,7 @@ components: GetComplianceDataResponse: title: GetComplianceDataResponse required: - - Version + - Version type: object properties: ReportSummaries: @@ -31284,7 +23979,7 @@ components: 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.' + description: Compliance data by report, for either individual devices, or as group average. ReportSummary: title: ReportSummary type: object @@ -31330,8 +24025,8 @@ components: ReportScore: title: ReportScore required: - - ReportItemId - - ReportInstanceId + - ReportItemId + - ReportInstanceId type: object properties: Version: @@ -31391,7 +24086,7 @@ components: GetAvailableComplianceDataResponse: title: GetAvailableComplianceDataResponse required: - - Version + - Version type: object properties: AvailableComplianceReports: @@ -31409,7 +24104,7 @@ components: ComplianceReportRun: title: ComplianceReportRun required: - - ReportItemId + - ReportItemId type: object properties: GroupDisplayName: @@ -31428,13 +24123,13 @@ components: items: $ref: '#/components/schemas/ComplianceReportRun' Dictionary_String_List_ComplianceReportRun__: - title: 'Dictionary>' + title: Dictionary> type: object additionalProperties: type: array items: $ref: '#/components/schemas/ComplianceReportRun' - description: 'Dictionary>' + description: Dictionary> ComplianceReportRunDetails: title: ComplianceReportRunDetails type: object @@ -31480,7 +24175,7 @@ components: GetDeviceActivityResponse: title: GetDeviceActivityResponse required: - - Version + - Version type: object properties: TotalDevices: @@ -31555,7 +24250,7 @@ components: GetEventCountsResponse: title: GetEventCountsResponse required: - - Version + - Version type: object properties: DeviceOrGroupName: @@ -31603,7 +24298,7 @@ components: 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.' + 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 @@ -31668,13 +24363,13 @@ components: x-nullable: false description: EventCountsSummary Dictionary_EventType_Int32_: - title: 'Dictionary' + title: Dictionary type: object additionalProperties: type: integer format: int32 x-nullable: false - description: 'Dictionary' + description: Dictionary List_GetEventCountsResponse_: title: List type: array @@ -31683,7 +24378,7 @@ components: ExecuteReportResponse: title: ExecuteReportResponse required: - - Version + - Version type: object properties: Instance: @@ -31736,7 +24431,7 @@ components: GetScheduledInstancesResponse: title: GetScheduledInstancesResponse required: - - Version + - Version type: object properties: Items: @@ -31752,7 +24447,7 @@ components: GetScheduledInstanceRenderedResponse: title: GetScheduledInstanceRenderedResponse required: - - Version + - Version type: object properties: Items: @@ -31789,7 +24484,7 @@ components: type: string ReportInstanceId: type: string - description: 'Represents the previously rendered output, for example a pdf file, for a specific report run.' + description: Represents the previously rendered output, for example a pdf file, for a specific report run. AgentSoftwareUpdate: title: AgentSoftwareUpdate type: object @@ -31799,7 +24494,7 @@ components: description: Specifies the update ID UpdateType: type: string - description: 'Specifies the agent software update type (deb, rpm etc)' + description: Specifies the agent software update type (deb, rpm etc) ZipFileName: type: string description: Specifies the zip file name @@ -31834,7 +24529,7 @@ components: GetSyncServiceConfigItemsResponse: title: GetSyncServiceConfigItemsResponse required: - - Version + - Version type: object properties: ConfigurationValues: @@ -31876,7 +24571,7 @@ components: AddSyncServiceConfigItemResponse: title: AddSyncServiceConfigItemResponse required: - - Version + - Version type: object properties: ConfigurationValue: @@ -31890,7 +24585,7 @@ components: GetConfigItemsResponse: title: GetConfigItemsResponse required: - - Version + - Version type: object properties: ConfigItems: @@ -31954,15 +24649,15 @@ components: description: The id of the new item created. description: The id of the new item created. Dictionary_String_NewId_: - title: 'Dictionary' + title: Dictionary type: object additionalProperties: $ref: '#/components/schemas/NewId' - description: 'Dictionary' + description: Dictionary AddConfigItemResponse: title: AddConfigItemResponse required: - - Version + - Version type: object properties: ConfigItems: @@ -31977,13 +24672,13 @@ components: x-nullable: false description: The response delivered after adding a new config key / value. Dictionary_CredentialType_List_String__: - title: 'Dictionary>' + title: Dictionary> type: object additionalProperties: type: array items: type: string - description: 'Dictionary>' + description: Dictionary> List_Credentials_: title: List type: array @@ -31992,7 +24687,7 @@ components: GetAgentTaskStatusesResponse: title: GetAgentTaskStatusesResponse required: - - Version + - Version type: object properties: Statuses: @@ -32060,7 +24755,7 @@ components: SubmitAgentTasksResponse: title: SubmitAgentTasksResponse required: - - Version + - Version type: object properties: Tasks: @@ -32086,13 +24781,13 @@ components: 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.' + 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: Specifies the variant (X64, i386 etc) associated with this file hash binary. description: Describes a file hash binary. List_FileHashBinary_: title: List @@ -32102,8 +24797,8 @@ components: GetPlannedChangeInstanceMembersResponse: title: GetPlannedChangeInstanceMembersResponse required: - - InstanceId - - Version + - InstanceId + - Version type: object properties: InstanceId: @@ -32139,7 +24834,7 @@ components: GetPlannedChangesInstancesResponse: title: GetPlannedChangesInstancesResponse required: - - Version + - Version type: object properties: PlannedChangeInstances: @@ -32161,11 +24856,11 @@ components: 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.' + description: Describes planned change instances, filtered by name, id or groups that are members. PlannedChangeInstance: title: PlannedChangeInstance required: - - InstanceId + - InstanceId type: object properties: Version: @@ -32179,7 +24874,7 @@ components: 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.' + 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 @@ -32200,7 +24895,7 @@ components: 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.' + 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. @@ -32284,7 +24979,7 @@ components: properties: Version: type: integer - description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + description: Specifies the request version. If specified, this indicates the service model version the request complies with. format: int32 x-nullable: false Name: @@ -32298,7 +24993,7 @@ components: 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.' + 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. @@ -32311,7 +25006,7 @@ components: 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.' + 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_' @@ -32333,7 +25028,7 @@ components: GetPlannedChangeInstancesNameValueResponse: title: GetPlannedChangeInstancesNameValueResponse required: - - Version + - Version type: object properties: PlannedChangeInstances: @@ -32355,11 +25050,11 @@ components: 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.' + description: Describes planned change instances, filtered by name, id or groups that are members. PlannedChangeInstanceNameValue: title: PlannedChangeInstanceNameValue required: - - InstanceId + - InstanceId type: object properties: InstanceId: @@ -32375,7 +25070,7 @@ components: 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''.' + 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' @@ -32385,7 +25080,7 @@ components: GetPlannedChangesResponse: title: GetPlannedChangesResponse required: - - Version + - Version type: object properties: PlannedChanges: @@ -32412,7 +25107,7 @@ components: AnalyzePlannedChangeResponse: title: AnalyzePlannedChangeResponse required: - - Version + - Version type: object properties: RuleIdsReplaced: @@ -32521,7 +25216,7 @@ components: WhitelistCommandComponentResponse: title: WhitelistCommandComponentResponse required: - - Version + - Version type: object properties: Success: @@ -32554,7 +25249,7 @@ components: CommandComponentTemplateResponse: title: CommandComponentTemplateResponse required: - - Version + - Version type: object properties: Success: @@ -32571,7 +25266,7 @@ components: GetAllCommandComponentTemplatesResponse: title: GetAllCommandComponentTemplatesResponse required: - - Version + - Version type: object properties: Success: @@ -32602,7 +25297,7 @@ components: GetAllCommandComponentsTemplatesResponse: title: GetAllCommandComponentsTemplatesResponse required: - - Version + - Version type: object properties: Success: @@ -32621,7 +25316,7 @@ components: GetCloudTemplateCreationStatusResponse: title: GetCloudTemplateCreationStatusResponse required: - - Version + - Version type: object properties: CloudSystemName: @@ -32688,7 +25383,7 @@ components: SetupPolicyTemplateResponse: title: SetupPolicyTemplateResponse required: - - Version + - Version type: object properties: Version: @@ -32700,7 +25395,7 @@ components: GetPolicyTemplateCreationStatusResponse: title: GetPolicyTemplateCreationStatusResponse required: - - Version + - Version type: object properties: PolicyTemplateName: @@ -32789,7 +25484,7 @@ components: GetMostRecentPolicyResultsResponse: title: GetMostRecentPolicyResultsResponse required: - - Version + - Version type: object properties: Results: @@ -32995,7 +25690,7 @@ components: AddPolicyTemplateRulesResponse: title: AddPolicyTemplateRulesResponse required: - - Version + - Version type: object properties: ActionsTaken: @@ -33036,7 +25731,7 @@ components: UploadPolicyTemplateResponse: title: UploadPolicyTemplateResponse required: - - Version + - Version type: object properties: AddPolicyTemplateResponses: @@ -33053,7 +25748,7 @@ components: GetAgentProcessesResponse: title: GetAgentProcessesResponse required: - - Version + - Version type: object properties: TaskId: @@ -33071,7 +25766,7 @@ components: StartAgentTrackerResponse: title: StartAgentTrackerResponse required: - - Version + - Version type: object properties: TaskId: @@ -33089,7 +25784,7 @@ components: GetAgentServicesResponse: title: GetAgentServicesResponse required: - - Version + - Version type: object properties: TaskId: @@ -33107,7 +25802,7 @@ components: GetGroupPolicyResponse: title: GetGroupPolicyResponse required: - - Version + - Version type: object properties: Templates: @@ -33133,7 +25828,7 @@ components: AddGroupPolicyResponse: title: AddGroupPolicyResponse required: - - Version + - Version type: object properties: Templates: @@ -33159,7 +25854,7 @@ components: GetAgentsRankedResponse: title: GetAgentsRankedResponse required: - - Version + - Version type: object properties: AgentCredentials: @@ -33201,7 +25896,7 @@ components: 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.' + 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. @@ -33239,18 +25934,18 @@ components: x-nullable: false description: The response objeect for GetAgentsRanked KeyValuePair_String_String_: - title: 'KeyValuePair' + title: KeyValuePair type: object properties: Key: type: string Value: type: string - description: 'KeyValuePair' + description: KeyValuePair GroupMembersResponse: title: GroupMembersResponse required: - - Version + - Version type: object properties: GroupMembers: @@ -33299,7 +25994,7 @@ components: GetGroupsResponse: title: GetGroupsResponse required: - - Version + - Version type: object properties: Groups: @@ -33370,7 +26065,7 @@ components: 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.' + 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: @@ -33390,7 +26085,7 @@ components: 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.' + 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 @@ -33432,7 +26127,7 @@ components: 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.' + description: Specifies the utc time to wait until, for completion of the current set of tasks. format: date-time Status: type: string @@ -33461,7 +26156,7 @@ components: GetGroupsTreeResponse: title: GetGroupsTreeResponse required: - - Groups + - Groups type: object properties: Groups: @@ -33501,7 +26196,7 @@ components: AddGroupResponse: title: AddGroupResponse required: - - Version + - Version type: object properties: Name: @@ -33516,7 +26211,7 @@ components: GetOverdueDevicesResponse: title: GetOverdueDevicesResponse required: - - Version + - Version type: object properties: Devices: @@ -33533,7 +26228,7 @@ components: DeleteDevicePermanentlyResponse: title: DeleteDevicePermanentlyResponse required: - - Version + - Version type: object properties: Challenge: @@ -33544,11 +26239,11 @@ components: 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.' + 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 + - Version type: object properties: DeviceFilters: @@ -33575,7 +26270,7 @@ components: TestAgentCredentialsResponse: title: TestAgentCredentialsResponse required: - - Version + - Version type: object properties: TaskId: @@ -33613,7 +26308,7 @@ components: 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.' + 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 @@ -33622,7 +26317,7 @@ components: DiscoverDevicesResponse: title: DiscoverDevicesResponse required: - - Version + - Version type: object properties: TaskId: @@ -33640,7 +26335,7 @@ components: GetEventHistoryResponse: title: GetEventHistoryResponse required: - - Version + - Version type: object properties: EventId: @@ -33678,7 +26373,7 @@ components: GetEventDeviceGroupsResponse: title: GetEventDeviceGroupsResponse required: - - Version + - Version type: object properties: GroupNames: @@ -33700,7 +26395,7 @@ components: GetInventoryResponse: title: GetInventoryResponse required: - - Version + - Version type: object properties: Items: @@ -33726,7 +26421,7 @@ components: GetAgentInventoryItemsGroupedResponse: title: GetAgentInventoryItemsGroupedResponse required: - - Version + - Version type: object properties: Items: @@ -33778,7 +26473,7 @@ components: GetAgentInventoryAgentsDetailResponse: title: GetAgentInventoryAgentsDetailResponse required: - - Version + - Version type: object properties: Items: @@ -33815,7 +26510,7 @@ components: GetVulnerabilityOverviewResponse: title: GetVulnerabilityOverviewResponse required: - - Version + - Version type: object properties: SoftwareVulnerabilityScoresV3: @@ -33839,7 +26534,7 @@ components: 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' + 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: @@ -33906,7 +26601,7 @@ components: GetVulnerabilityScanStatusResponse: title: GetVulnerabilityScanStatusResponse required: - - Version + - Version type: object properties: InventoryItemsInQueue: @@ -33927,17 +26622,17 @@ components: x-nullable: false description: The response object for GetVulnerabilityStatus Dictionary_String_Int32_: - title: 'Dictionary' + title: Dictionary type: object additionalProperties: type: integer format: int32 x-nullable: false - description: 'Dictionary' + description: Dictionary GetVulnerabilityResponse: title: GetVulnerabilityResponse required: - - Version + - Version type: object properties: CveItems: @@ -34191,7 +26886,7 @@ components: GetSoftwareVulnerabilityResponse: title: GetSoftwareVulnerabilityResponse required: - - Version + - Version type: object properties: SoftwareItems: @@ -34218,7 +26913,7 @@ components: GetSoftwareVulnerabilityDetailResponse: title: GetSoftwareVulnerabilityDetailResponse required: - - Version + - Version type: object properties: CvesList: @@ -34245,7 +26940,7 @@ components: GetDeviceVulnerabilityResponse: title: GetDeviceVulnerabilityResponse required: - - Version + - Version type: object properties: VulnerableDevices: @@ -34289,7 +26984,7 @@ components: GetDeviceVulnerabilityDetailResponse: title: GetDeviceVulnerabilityDetailResponse required: - - Version + - Version type: object properties: CvesList: @@ -34316,7 +27011,7 @@ components: GetCvesForRelatedCpesResponse: title: GetCvesForRelatedCpesResponse required: - - Version + - Version type: object properties: CvesList: @@ -34342,7 +27037,7 @@ components: GetVulnerableDeviceDetailResponse: title: GetVulnerableDeviceDetailResponse required: - - Version + - Version type: object properties: VulnerableDevices: @@ -34418,7 +27113,7 @@ components: GetLog4NetConfigItemsResponse: title: GetLog4NetConfigItemsResponse required: - - Version + - Version type: object properties: LoggerConfigs: @@ -34495,7 +27190,7 @@ components: GetReportDataResponse: title: GetReportDataResponse required: - - Version + - Version type: object properties: ReportId: @@ -34603,7 +27298,7 @@ components: GetAvailableReportsResponse: title: GetAvailableReportsResponse required: - - Version + - Version type: object properties: ReportMetadata: @@ -34742,7 +27437,7 @@ components: GetUserTwoFactorStatusResponse: title: GetUserTwoFactorStatusResponse required: - - Version + - Version type: object properties: ChangePasswordByUtc: @@ -34804,7 +27499,7 @@ components: ResetUserPasswordResponse: title: ResetUserPasswordResponse required: - - Version + - Version type: object properties: Password: @@ -34821,7 +27516,7 @@ components: PreviewResetUserPasswordResponse: title: PreviewResetUserPasswordResponse required: - - Version + - Version type: object properties: Password: @@ -34861,7 +27556,7 @@ components: GetUserRolesResponse: title: GetUserRolesResponse required: - - Version + - Version type: object properties: Roles: @@ -34885,10 +27580,10 @@ components: UserRole: title: UserRole required: - - Name - - DisplayName - - Permissions - - ReadOnly + - Name + - DisplayName + - Permissions + - ReadOnly type: object properties: Name: @@ -34907,13 +27602,13 @@ components: 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.' + description: Specifies whether the role is read only, or can be edited. x-nullable: false description: UserRole AddUserRoleResponse: title: AddUserRoleResponse required: - - Version + - Version type: object properties: Roles: @@ -34929,7 +27624,7 @@ components: UpdateUserRoleResponse: title: UpdateUserRoleResponse required: - - Version + - Version type: object properties: Roles: @@ -34945,7 +27640,7 @@ components: GetLicenseInfoResponse: title: GetLicenseInfoResponse required: - - Version + - Version type: object properties: Description: @@ -34975,7 +27670,7 @@ components: GetRolesAndPermissionsResponse: title: GetRolesAndPermissionsResponse required: - - Version + - Version type: object properties: UserName: @@ -35031,123 +27726,122 @@ components: required: true schema: enum: - - application/json + - application/json type: string securitySchemes: Bearer: - type: apiKey - name: Authorization - in: header + type: http + scheme: bearer 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 +- 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