diff --git a/.github/workflows/openapi-dedup.yml b/.github/workflows/openapi-dedup.yml deleted file mode 100644 index 30a6cfd20d..0000000000 --- a/.github/workflows/openapi-dedup.yml +++ /dev/null @@ -1,89 +0,0 @@ -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/docs/customer/portal/index.md b/docs/customer/portal/index.md index cb4bc67c5c..e804196853 100644 --- a/docs/customer/portal/index.md +++ b/docs/customer/portal/index.md @@ -8,9 +8,9 @@ description: "Register for a Netwrix Customer Portal account, access downloads, import { Company } from '@site/src/training/products'; -Follow the steps to register for a Customer Portal account. +To register for a Customer Portal account, complete the following steps: - 1. Navigate to the [Netwrix website](https://www.netwrix.com/) + 1. Navigate to the [Netwrix website](https://www.netwrix.com/). ![Netwrix Website](@site/static/images/customer-portal/website.png) @@ -23,15 +23,22 @@ Follow the steps to register for a Customer Portal account. * First Name – Enter your first name * Last Name – Enter your last name * Business Email – Enter your corporate email address - * This needs to be the same email address known to . + * This should be an email address that already has on file. * Direct Phone – Enter your corporate phone number - + * Password – Enter a password that meets the following requirements: + * At least 15 characters + * At least one number + * At least one uppercase letter + * At least one lowercase letter + * At least one special character + * Confirm Password – Renter the password 4. Check the **I'm not a robot** box. 5. Read the [Netwrix Privacy Policy](https://www.netwrix.com/en/legal/privacy-policy) and then accept it by checking the box. 6. Click **Sign Up**. ![Thank You for Signing Up Message](@site/static/images/customer-portal/thank-you.png) -7. After registering, you will receive an email to activate your account. If you do not receive this email, click the **Resend Activation** link in the browser. + +7. After registering, you will receive an email to activate your account. If you don't receive this email, click the **Resend Activation** link in the browser. :::danger[Warning] @@ -41,22 +48,20 @@ Follow the steps to register for a Customer Portal account. ![Activation Email](@site/static/images/customer-portal/activation.png) -8. Click **Verify Your Account** link in the email. +8. Open the email and click the **Verify Your Account** link. ![Customer Portal Home Page](@site/static/images/customer-portal/home.png) - 9. Your account will be activated and you will be redirected to the Ready to use page. Click the **Netwrix products** link to open the portal's Home page. You can return to the main website by clicking the logo in the upper left corner. - -10. The activation email included a temporary password. To change your password, go to My Profile and click **Change Password**. + 9. The portal activates your account and redirects you to the Ready to use page. Click the **Sign In** link and enter the email address and password you provided during sign-up to access the Customer Portal. -From the website, you can access the Customer Portal through the drop-down menu from the user icon. +From the Customer Portal, you can return to the main website by clicking the logo in the upper-left corner. Then you can access the Customer Portal through the user icon. ## Troubleshooting Issues in the Customer Portal If you have any trouble with the Customer Portal, try the following: -* Ensure you verified your email by clicking the Verify Your Account link in the email you were sent when you registered for the account -* Confirm the corporate email address you used to register for a portal account is known to by contacting your Account Manager +* Ensure you verified your email by clicking the Verify Your Account link in the email you received when you registered for the account +* Contact your Account Manager to confirm has the corporate email address you used to register on file * Clear your browser cache -If you continue to have issues with any aspect of the Customer Portal, email us at [customer.portal@netwrix.com](mailto:customer.portal@netwrix.com) for assistance. +If you continue to have issues with the Customer Portal, email [customer.portal@netwrix.com](mailto:customer.portal@netwrix.com) for assistance. diff --git a/package.json b/package.json index dd7826d5b2..ad7f9b2d32 100644 --- a/package.json +++ b/package.json @@ -5,14 +5,14 @@ "main": "docusaurus.config.js", "scripts": { "docusaurus": "npx docusaurus", - "prestart": "node scripts/copy-kb-to-versions.mjs && node scripts/deduplicate-openapi-methods.mjs && npx docusaurus gen-api-docs changetracker-hub", + "prestart": "node scripts/copy-kb-to-versions.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 && node scripts/deduplicate-openapi-methods.mjs && npx docusaurus gen-api-docs changetracker-hub", + "prebuild": "node scripts/copy-kb-to-versions.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 && node scripts/deduplicate-openapi-methods.mjs && npx docusaurus gen-api-docs changetracker-hub", + "preci": "node scripts/copy-kb-to-versions.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", + "openapi:sync": "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 deleted file mode 100644 index bd8a0e215c..0000000000 --- a/scripts/deduplicate-openapi-methods.mjs +++ /dev/null @@ -1,162 +0,0 @@ -/** - * 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/static/images/customer-portal/activation.png b/static/images/customer-portal/activation.png index 17c2d38189..0fb1c5cae8 100644 Binary files a/static/images/customer-portal/activation.png and b/static/images/customer-portal/activation.png differ diff --git a/static/images/customer-portal/home.png b/static/images/customer-portal/home.png index f0212e8cf8..7a86a9f66b 100644 Binary files a/static/images/customer-portal/home.png and b/static/images/customer-portal/home.png differ diff --git a/static/images/customer-portal/sign-up.png b/static/images/customer-portal/sign-up.png index a762f902b9..7972ba6625 100644 Binary files a/static/images/customer-portal/sign-up.png and b/static/images/customer-portal/sign-up.png differ diff --git a/static/images/customer-portal/thank-you.png b/static/images/customer-portal/thank-you.png index c130be4dd5..cc6795aa66 100644 Binary files a/static/images/customer-portal/thank-you.png and b/static/images/customer-portal/thank-you.png differ diff --git a/static/images/customer-portal/website.png b/static/images/customer-portal/website.png index efa45f5c96..92eeca82fd 100644 Binary files a/static/images/customer-portal/website.png and b/static/images/customer-portal/website.png differ diff --git a/static/openapi/changetracker-hub-8.1.yaml b/static/openapi/changetracker-hub-8.1.yaml index ad39619749..5734bcbee5 100644 --- a/static/openapi/changetracker-hub-8.1.yaml +++ b/static/openapi/changetracker-hub-8.1.yaml @@ -3,114 +3,130 @@ 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: https://localhost:5001/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: - 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: + - 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: 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 + - name: AgentId + in: query + description: 'Specifies the agent id. Note: this the agent id excluding the device id: the poll returns tasks and configuration dates for all devices registered under this agent id.' + required: true + schema: + type: string + - name: LegacyId + in: query + description: 'The legacy v6.5 RA agent id. Note: this is only present for upgrade purposes.' + schema: + type: string + - name: PollTimeUtc + in: query + description: Specifies the local agent Utc time. Used to detect system time differences between agent and hub. + required: true + schema: + type: DateTime + format: date-time + x-nullable: false + - name: AgentVersion + in: query + description: Specifies the agent version. This is optional and typically only sent on initial poll. + schema: + type: string + - name: AgentMacAddresses + in: query + description: Specifies the agent physical/MAC addresses. This is optional and typically only sent on an initial poll or when the list changes. + schema: + type: string + - name: AgentIPv4 + in: query + description: Specifies the agent IP v4 addresses. This is optional and typically only sent on initial poll or when the list changes. + schema: + type: string + - name: AgentIPv6 + in: query + description: Specifies the agent IP v6 addresses. This is optional and typically only sent on initial poll or when the list changes. + schema: + type: string + - name: MachineName + in: query + description: 'Specifies the agent machine name including custom prefix, and domain prefix, if used. This is optional and typically only sent on initial poll or when the it changes.' + schema: + type: string + - name: FullyQualifiedDomainName + in: query + description: Specifies the fully qualified domain name. This is optional and typically only sent on initial poll or when the it changes. + schema: + type: string + - name: AgentType + in: query + description: Specifies the type of agent + schema: + enum: + - Unknown + - NetDesktop + - Mono + - NetCore + - ExpressAgent + type: string + x-nullable: false + - name: Os + in: query + description: Specifies the agent operating system. This is optional and typically only sent on initial poll or when the it changes. + schema: + type: string + - name: DeviceIds + in: query + description: Specifies the deviceIds of the devices online that the agent is proxying. This is optional and typically only sent by a proxying agent. + style: form + schema: + type: array + items: + type: string + - name: ReturnXml + in: query + description: Specifies whether to return the report task template xml in the response. This is optional and defaults to true. It can be used to prevent xml download on agents that implement a local cache of report definitions. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentPoll + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentPollResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + description: 'Called by the agent, this returns a list of AgentTasks and latest tracking template definition dates for all the devices the agent manages.' + operationId: GetAgentPolltaskspollAgentId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentPoll' + x-bodyName: body responses: '200': description: The response object for GetAgentPoll @@ -119,116 +135,137 @@ 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: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: 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: + - 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 - 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: + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: 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: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTasks + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' + security: + - Bearer: [ ] + post: + tags: + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentTasks' + x-bodyName: body responses: '200': description: The response object for GetAgentTasks @@ -237,14 +274,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: @@ -261,15 +298,74 @@ 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: @@ -281,17 +377,105 @@ 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: @@ -303,1825 +487,4701 @@ 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 + - 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: [] - parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplates: - get: + - Bearer: [ ] + post: tags: - - policyTemplates - summary: Gets matching config templates - description: Gets matching config templates. - operationId: GetPolicyTemplates_Get - parameters: - - name: Name - in: query - description: Specifies a single policy name (id) to search for. - schema: - type: string - - name: NameContains - in: query - description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. - schema: - type: string - - name: Names - in: query - description: Specifies a list of policy names (ids) to search for. - style: form - schema: - type: array - items: - type: string - - name: ReturnXml - in: query - description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. - schema: - type: boolean - x-nullable: false - - name: ReturnSignatures - in: query - description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. - schema: - type: boolean - x-nullable: false - - name: IsActive - in: query - description: Get the Active version of a template - schema: - type: boolean - - name: IsLatest - in: query - description: Get the Latest version of a template - schema: - type: boolean - - name: IsSystem - in: query - description: Get System supplied templates - schema: - type: boolean - - name: HasRules - in: query - description: Get templates with Rules - schema: - type: boolean - - name: HasTrackers - in: query - description: Get templates with Trackers - schema: - type: boolean - - name: TemplateTrackerTypes - in: query - description: Specifies the template's tracker types. - style: form - schema: - type: array - items: - type: string - - name: TemplateVersion - in: query - description: Specifies the template version to get. - schema: - type: string - - name: UsageTags - in: query - description: Specifies the policy usage types to get. - style: form - schema: - type: array - items: - type: string - - name: IsTrusted - in: query - description: Policy templates which contains commands that are trusted - schema: - type: boolean - - name: NotificationRefId - in: query - description: Policy templates associated with the supplied notification ref id - schema: - type: string - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: - type: string - description: Dictionary - - name: Skip - in: query - description: The offset into the result set to start at. - schema: - type: integer - format: int32 - - name: Take - in: query - description: The limit number of rows to return. - schema: - type: integer - format: int32 - - name: GenericFilters - in: query - description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. - style: form - schema: - type: array - items: - $ref: '#/components/schemas/PagingQueryFilter' - - name: GenericFilterLogic - in: query - description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - credential + summary: Get specific credentials for requested type and key (name). + description: Get specific credentials for requested type and key (name). + operationId: GetCredentials_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCredentials' + x-bodyName: body responses: '200': - description: Response to a request for matching config templates. + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' content: application/json: schema: - $ref: '#/components/schemas/GetPolicyTemplatesResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplateVariables: + - $ref: '#/components/parameters/Accept' + /policyTemplates: get: tags: - - policyTemplateVariables - summary: A request to get a list of variable definitions from a named report to be collected by the agent - description: A request to get a list of variable definitions from a named report to be collected by the agent. - operationId: GetPolicyTemplateVariables_Get + - policyTemplates + summary: Gets matching config templates. + description: Gets matching config templates. + operationId: GetPolicyTemplates_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: [] - parameters: - - $ref: '#/components/parameters/Accept' - /deviceCredentials: - get: + - name: Name + in: query + description: Specifies a single policy name (id) to search for. + schema: + type: string + - name: NameContains + in: query + description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. + schema: + type: string + - name: Names + in: query + description: Specifies a list of policy names (ids) to search for. + style: form + schema: + type: array + items: + type: string + - name: ReturnXml + in: query + description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: ReturnSignatures + in: query + description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: IsActive + in: query + description: Get the Active version of a template + schema: + type: boolean + - name: IsLatest + in: query + description: Get the Latest version of a template + schema: + type: boolean + - name: IsSystem + in: query + description: Get System supplied templates + schema: + type: boolean + - name: HasRules + in: query + description: Get templates with Rules + schema: + type: boolean + - name: HasTrackers + in: query + description: Get templates with Trackers + schema: + type: boolean + - name: TemplateTrackerTypes + in: query + description: Specifies the template's tracker types. + style: form + schema: + type: array + items: + type: string + - name: TemplateVersion + in: query + description: Specifies the template version to get. + schema: + type: string + - name: UsageTags + in: query + description: Specifies the policy usage types to get. + style: form + schema: + type: array + items: + type: string + - name: IsTrusted + in: query + description: Policy templates which contains commands that are trusted + schema: + type: boolean + - name: NotificationRefId + in: query + description: Policy templates associated with the supplied notification ref id + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to a request for matching config templates. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplatesResponse' + security: + - Bearer: [ ] + post: tags: - - 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 + - policyTemplates + summary: Gets matching config templates. + description: Gets matching config templates. + operationId: GetPolicyTemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplates' + x-bodyName: body responses: '200': - description: Success + description: Response to a request for matching config templates. content: application/json: schema: - title: List - type: array - items: - type: string + $ref: '#/components/schemas/GetPolicyTemplatesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /deviceDbCredentials: + - $ref: '#/components/parameters/Accept' + /policyTemplateVariables: get: tags: - - deviceDbCredentials - summary: A request to get the database credentials associated with a database proxied agent - description: A request to get the database credentials associated with a database proxied agent. - operationId: GetDbCredentialForDatabaseAgentDevice_Get + - 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: 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 + - 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: Represents some credentials used to connect to a remote service (e.g SSH, database etc). + description: The list of variable definitions from a named report to be collected by the agent. content: application/json: schema: - $ref: '#/components/schemas/Credentials' + $ref: '#/components/schemas/GetPolicyTemplateVariablesResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /groupMemberships: - get: + - 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_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 + - policyTemplateVariables + summary: A request to get a list of variable definitions from a named report to be collected by the agent. + description: A request to get a list of variable definitions from a named report to be collected by the agent. + operationId: GetPolicyTemplateVariables_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplateVariables' + x-bodyName: body responses: '200': - description: Success + description: The list of variable definitions from a named report to be collected by the agent. content: application/json: schema: - title: List - type: array - items: - type: string + $ref: '#/components/schemas/GetPolicyTemplateVariablesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /agents: + - $ref: '#/components/parameters/Accept' + /deviceCredentials: get: tags: - - agents - summary: A request to return agents matching the device filter - description: A request to return agents matching the device filter. - operationId: GetAgents_Get + - 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: ExcludeTotalCount - in: query - description: Specifies a value indicating whether to calculate the total count returned in the GetAgentsResponse.Total - schema: - type: boolean - x-nullable: false - - name: DeviceFilter - in: query - description: Specifies the agents to search for by id or group membership. - schema: - $ref: '#/components/schemas/DeviceFilter' - - name: GetAgentGroupDetails - in: query - description: Specifies a value indicating whether to get agent group details. - schema: - type: boolean - x-nullable: false - - name: GetRelatedCredentials - in: query - description: Specifies a value indicating whether to get related credentials. - schema: - type: boolean - x-nullable: false - - name: GetRelatedPlannedChanges - in: query - description: Specifies a value indicating whether to get related planned changes. - schema: - type: boolean - x-nullable: false - - name: GetRelatedProxyAgents - in: query - description: Specifies a value indicating whether to get related proxy agents. - schema: - type: boolean - x-nullable: false - - name: GetRelatedTemplates - in: query - description: Specifies a value indicating whether to get templates applied to the returned agents. - schema: - type: boolean - x-nullable: false - - name: IncludeMasterInFilter - in: query - description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. - schema: - type: boolean - x-nullable: false - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: - type: string - description: Dictionary - - name: Skip - in: query - description: The offset into the result set to start at. - schema: - type: integer - format: int32 - - name: Take - in: query - description: The limit number of rows to return. - schema: - type: integer - format: int32 - - name: GenericFilters - in: query - description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. - style: form - schema: - type: array - items: - $ref: '#/components/schemas/PagingQueryFilter' - - name: GenericFilterLogic - in: query - description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - 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: The response object for GetAgents + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentsResponse' + title: List + type: array + items: + type: string security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /agents/register: + - Bearer: [ ] post: tags: - - agents - summary: Registers the details of an Agent with the system - description: Registers the details of an Agent with the system. - operationId: RegisterAgentregister_Post + - 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/RegisterAgent' + $ref: '#/components/schemas/GetCredentialsForAgentDevice' 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: Success content: application/json: schema: - $ref: '#/components/schemas/Agent' + title: List + type: array + items: + type: string security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /agents/update: + - $ref: '#/components/parameters/Accept' + /deviceDbCredentials: + get: + tags: + - deviceDbCredentials + summary: A request to get the database credentials associated with a database proxied agent. + description: A request to get the database credentials associated with a database proxied agent. + operationId: GetDbCredentialForDatabaseAgentDevice_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' + content: + application/json: + schema: + $ref: '#/components/schemas/Credentials' + security: + - Bearer: [ ] post: tags: - - agents - summary: Update an Agent's details - description: Update an Agent's details. - operationId: UpdateAgentupdate_Post + - 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/UpdateAgent' + $ref: '#/components/schemas/GetDbCredentialForDatabaseAgentDevice' x-bodyName: body responses: '200': - description: The response object for GetAgents + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' content: application/json: schema: - $ref: '#/components/schemas/GetAgentsResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /agents/search: + - $ref: '#/components/parameters/Accept' + /groupMemberships: get: tags: - - agents - summary: A request to find agents matching the device filter and search criteria - description: A request to find agents matching the device filter and search criteria. - operationId: SearchAgentssearch_Get + - 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: 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: + - name: MemberName + in: query + description: Specifies the member name to retrieve group memberships for. + schema: 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: 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: The response object for SearchAgents + description: Success content: application/json: schema: - $ref: '#/components/schemas/SearchAgentsResponse' + title: List + type: array + items: + type: string security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /agents/preRegister: + - Bearer: [ ] post: tags: - - agents - summary: Registers the details of the specified Agents with the system - description: Registers the details of the specified Agents with the system. - operationId: PreRegisterAgentspreRegister_Post + - 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/PreRegisterAgents' + $ref: '#/components/schemas/GroupMemberships' x-bodyName: body responses: '200': - description: The response object for PreRegisterAgents + description: Success content: application/json: schema: - $ref: '#/components/schemas/PreRegisterAgentsResponse' + title: List + type: array + items: + type: string security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /deviceConfig: + - $ref: '#/components/parameters/Accept' + /agents: get: tags: - - deviceConfig - summary: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in - description: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. - operationId: GetDeviceConfig_Get + - 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: 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: [] + - name: ExcludeTotalCount + in: query + description: Specifies a value indicating whether to calculate the total count returned in the GetAgentsResponse.Total + schema: + type: boolean + x-nullable: false + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: GetAgentGroupDetails + in: query + description: Specifies a value indicating whether to get agent group details. + schema: + type: boolean + x-nullable: false + - name: GetRelatedCredentials + in: query + description: Specifies a value indicating whether to get related credentials. + schema: + type: boolean + x-nullable: false + - name: GetRelatedPlannedChanges + in: query + description: Specifies a value indicating whether to get related planned changes. + schema: + type: boolean + x-nullable: false + - name: GetRelatedProxyAgents + in: query + description: Specifies a value indicating whether to get related proxy agents. + schema: + type: boolean + x-nullable: false + - name: GetRelatedTemplates + in: query + description: Specifies a value indicating whether to get templates applied to the returned agents. + schema: + type: boolean + x-nullable: false + - name: IncludeMasterInFilter + in: query + description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: A request to return agents matching the device filter. + description: A request to return agents matching the device filter. + operationId: GetAgents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgents' + x-bodyName: body + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/register: + get: + tags: + - agents + summary: Registers the details of an Agent with the system. + description: Registers the details of an Agent with the system. + operationId: RegisterAgentregister_Get + parameters: + - name: CanProxy + in: query + description: Specifies a value indicating whether the agent can proxy connections to other devices. + schema: + type: boolean + x-nullable: false + - name: CredentialKey + in: query + description: Specifies the credential key. Only allowed for proxied devices. + schema: + type: string + - name: DbConnection + in: query + description: Specifies the details for a database connection. + schema: + $ref: '#/components/schemas/DbConnection' + - name: DeviceName + in: query + description: Specifies the device name. + schema: + type: string + - name: GroupNames + in: query + description: Specifies the group names. Only allowed for proxied devices. + style: form + schema: + type: array + items: + type: string + - name: HostName + in: query + description: Specifies the host name. This is the name or IP address used for agentless access to this device by a proxy. + schema: + type: string + - name: HostType + in: query + description: Specifies the host type. + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + - name: MacAddresses + in: query + description: Specifies the mac addresses. + schema: + type: string + - name: IPv4 + in: query + description: Specifies the v4 ip address. + schema: + type: string + - name: IPv6 + in: query + description: Specifies the v6 ip address. + schema: + type: string + - name: LegacyHubId + in: query + description: Specifies the legacy hub id. + schema: + type: string + - name: DiscoveryId + in: query + description: Specifies the internal discovery-based id. + schema: + type: string + - name: DiscoveryTaskId + in: query + description: Specifies the internal discovery task id. + schema: + type: string + - name: OnlineDetection + in: query + description: Specifies the method to use when detecting if a proxed device is online + schema: + enum: + - None + - Ping + - TcpConnect + type: string + x-nullable: false + - name: Os + in: query + description: Specifies the Operating System full description as reported by the device. + schema: + type: string + - name: KnownOsName + in: query + description: Specifies the Operating System from the list of known Os names. + schema: + type: string + - name: OsUserSpecified + in: query + description: 'Specifies the operating system as entered by the user. This will override the discovered Os in the UI, if specified.' + schema: + type: string + - name: PollPeriodSeconds + in: query + description: Specifies the poll period in seconds. + schema: + type: integer + format: int32 + - name: ProxiedByAgentId + in: query + description: Specifies the agent id of the proxy agent this device will be proxied by. + schema: + type: string + - name: Registered + in: query + description: Specifies a value indicating whether registered. + schema: + type: boolean + x-nullable: false + - name: BaselineSendEnabled + in: query + description: Specifies that the agent send baseline events flag should be set according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UniqueId + in: query + description: 'Specifies a value uniquely identifying the agent independent of name or agent id from a previous registration. Used to detect a need to re-register when underlying hub store has been emptied, otherwise the autoincrementing agent id counter can result in clashes as already used ids are reissued to different agents.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents a remote NNT Agent. May be a 1.x Agent, Gen7 Agent or Express Agent or a proxied device.' + content: + application/json: + schema: + $ref: '#/components/schemas/Agent' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: Registers the details of an Agent with the system. + description: Registers the details of an Agent with the system. + operationId: RegisterAgentregister_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RegisterAgent' + x-bodyName: body + responses: + '200': + description: 'Represents a remote NNT Agent. May be a 1.x Agent, Gen7 Agent or Express Agent or a proxied device.' + content: + application/json: + schema: + $ref: '#/components/schemas/Agent' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/update: + get: + tags: + - agents + summary: Update an Agent's details. + description: Update an Agent's details. + operationId: UpdateAgentupdate_Get + parameters: + - name: Agent + in: query + description: Specifies the agent being updated + schema: + $ref: '#/components/schemas/Agent' + - name: CredentialKey + in: query + description: Specifies the credential key to associate with this agent. e.g ssh credentials. + schema: + type: string + - name: DbConnection + in: query + description: Specifies the details for a database connection. + schema: + $ref: '#/components/schemas/DbConnection' + - name: GroupNames + in: query + description: Specifies a list of group names this agent belongs to. + style: form + schema: + type: array + items: + type: string + - name: UpdateAgentDeviceName + in: query + description: Specifies that the agent device name should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateAgentHostType + in: query + description: Specifies that the agent host type should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateCredentialKey + in: query + description: Specifies that the agent credential key should be updated according to the value specified. + schema: + type: boolean + x-nullable: false + - name: UpdateDbConnectionDetails + in: query + description: Specifies that the agent database connection details should be updated according to the values specified. + schema: + type: boolean + x-nullable: false + - name: UpdateDiagnosticModeEnabled + in: query + description: Specifies that the agent diagnostic mode flag should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateEventBlockEnabled + in: query + description: Specifies that the agent events blocked flag should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateGroupNames + in: query + description: Specifies that the agent group names should be updated according to the value specified. + schema: + type: boolean + x-nullable: false + - name: UpdateHostName + in: query + description: Specifies that the agent host name should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateIPv4 + in: query + description: Specifies that the IPv4 should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateOnlineDetection + in: query + description: Specifies that the agentonline detection mode should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateOsUserSpecified + in: query + description: Specifies that the agent user specified os type should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: UpdateBaselineSendEnabled + in: query + description: Specifies that the agent send baseline events flag should be updated according to the value specified in the Agent property. + schema: + type: boolean + x-nullable: false + - name: ClearUniqueId + in: query + description: 'Specifies that the agent UniqueId should be cleared, allowing registration by another device of the same name, but different UniqueId.' + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: Update an Agent's details. + description: Update an Agent's details. + operationId: UpdateAgentupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateAgent' + x-bodyName: body + responses: + '200': + description: The response object for GetAgents + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/search: + get: + tags: + - agents + summary: A request to find agents matching the device filter and search criteria. + description: A request to find agents matching the device filter and search criteria. + operationId: SearchAgentssearch_Get + parameters: + - name: DeviceFilter + in: query + description: Limits the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: MatchText + in: query + description: Text to search for in the Agents fields. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for SearchAgents + content: + application/json: + schema: + $ref: '#/components/schemas/SearchAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: A request to find agents matching the device filter and search criteria. + description: A request to find agents matching the device filter and search criteria. + operationId: SearchAgentssearch_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SearchAgents' + x-bodyName: body + responses: + '200': + description: The response object for SearchAgents + content: + application/json: + schema: + $ref: '#/components/schemas/SearchAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agents/preRegister: + get: + tags: + - agents + summary: Registers the details of the specified Agents with the system. + description: Registers the details of the specified Agents with the system. + operationId: PreRegisterAgentspreRegister_Get + parameters: + - name: Agents + in: query + description: A list of agents to pre-register at the hub. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/RegisterAgent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for PreRegisterAgents + content: + application/json: + schema: + $ref: '#/components/schemas/PreRegisterAgentsResponse' + security: + - Bearer: [ ] + post: + tags: + - agents + summary: Registers the details of the specified Agents with the system. + description: Registers the details of the specified Agents with the system. + operationId: PreRegisterAgentspreRegister_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PreRegisterAgents' + x-bodyName: body + responses: + '200': + description: The response object for PreRegisterAgents + content: + application/json: + schema: + $ref: '#/components/schemas/PreRegisterAgentsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceConfig: + get: + tags: + - deviceConfig + summary: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + description: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + operationId: GetDeviceConfig_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent and device id. Either 'AgentDevice' or 'AgentDeviceId' can be used. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: AgentDeviceId + in: query + description: 'Specifies the combined agent and device id, for example 1,1.' + schema: + type: string + - name: ReturnDocument + in: query + description: Specifies a value indicating whether return to return a device template object in GetDeviceConfigResponse.DeviceTemplate if trueor an xml string in GetDeviceConfigResponse.Xml if false. + schema: + type: boolean + x-nullable: false + - name: ReturnDocumentAsPolicyRuleSet + in: query + description: Specifies a value indicating whether return to return a device template rule-set object in GetDeviceConfigResponse.DeviceTemplate if trueor an xml string in GetDeviceConfigResponse.Xml if false. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents the tracking configuration template from the merged result of the group configurations for the groups the device is in. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceConfigResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceConfig + summary: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + description: Get the tracking configuration template from the merged result of the group configurations for the groups the device is in. + operationId: GetDeviceConfig_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceConfig' + x-bodyName: body + responses: + '200': + description: Represents the tracking configuration template from the merged result of the group configurations for the groups the device is in. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceConfigResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceSettings: + get: + tags: + - deviceSettings + summary: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + description: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + operationId: GetDeviceSettings_Get + parameters: + - name: AgentId + in: query + description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: GroupName + in: query + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceSettingsResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceSettings + summary: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + description: 'Gets the device settings for the device or group, based on the global device settings and any group specific overrides.' + operationId: GetDeviceSettings_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceSettings' + x-bodyName: body + responses: + '200': + description: 'Represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceSettingsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /events: + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEvents_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEvents_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/start/{StartUtc}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtc_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtc_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/end/{End}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsendEnd_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/start/{StartUtc}/end/{End}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtcendEnd_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsstartStartUtcendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/skip/{Skip}/take/{Take}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsskipSkiptakeTake_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsskipSkiptakeTake_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + '/events/{EventId}': + get: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsEventId_Get + parameters: + - name: Comment + in: query + description: Gets or sets the query comment so that when slow / repeated queries are identified in the database we can trace them back to a specific query in the code more easily + schema: + type: string + - name: TimeZoneId + in: query + description: 'Gets or sets the user time zone id. Optional, if supplied the returned Events'' DateTimeLocal property is populated with a calculated equivalent local time based on the event DateTimeUtc.' + schema: + type: string + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: ' Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: StartOffsetSeconds + in: query + description: If this is supplied then the StartUtc is going to based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: EndOffsetSeconds + in: query + description: If this is supplied then the EndUtc is going to be based on a time this many seconds ago (to allow 'rolling' queries) + schema: + type: integer + format: int32 + - name: Status + in: query + description: Only get events of a certain status + schema: + type: string + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: ReturnedEventType + in: query + description: ' Gets or sets the returned event type.' + schema: + enum: + - None + - DeviceEvent + - AlertEvent + - ErrorEvent + - AuditEvent + - RuleSetResultEvent + - RuleResultEvent + - DataResultsEvent + - ScheduledPolicyResultEvent + - RuleSetScoreEvent + - CommsEvent + - BaselineEvent + - GroupReportResultEvent + type: string + x-nullable: false + - name: EventId + in: query + description: Gets or sets the specific event id. + schema: + type: string + - name: ExcludeTotalCount + in: query + description: ' Gets or sets a value indicating whether to calculate the total count returned in the GetEventsResponse.Total' + schema: + type: boolean + x-nullable: false + - name: IncludeHistory + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: boolean + x-nullable: false + - name: RulesFromBaselinePolicyName + in: query + description: Gets or sets a value indicating wether or not to return event history with the events. + schema: + type: string + - name: ReturnAllEvents + in: query + description: 'Gets or sets a value indicating whether to populate the AllEvents list ' + schema: + type: boolean + x-nullable: false + - name: CountTimeMilliseconds + in: query + description: Gets or sets a value indicating how long to spend calculating a count of results before timing out. + schema: + type: number + format: double + - name: FormatDiffs + in: query + description: 'Gets or sets a value indicating whether to format the attribute text that contains process output content differences. ' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + post: + tags: + - events + summary: Retrieves a list of events from the hub service. + description: Retrieves a list of events from the hub service. + operationId: GetEventsEventId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEvents' + x-bodyName: body + responses: + '200': + description: The Events response. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /alertEvents/add: + get: + tags: + - alertEvents + summary: Adds a list of alert events to the system. + description: Adds a list of alert events to the system. + operationId: SubmitAlertEventsadd_Get + parameters: + - name: Events + in: query + description: Specifies the list of alert events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - alertEvents + summary: Adds a list of alert events to the system. + description: Adds a list of alert events to the system. + operationId: SubmitAlertEventsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAlertEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /alertEvents/limitedAdd: + get: + tags: + - alertEvents + summary: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitAlertEventsLimitedlimitedAdd_Get + parameters: + - name: Events + in: query + description: Specifies the list of alert events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AlertEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAlertEventsLimitedResponse' + security: + - Bearer: [ ] + post: + tags: + - alertEvents + summary: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of alert events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitAlertEventsLimitedlimitedAdd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitAlertEventsLimited' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitAlertEventsLimitedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /baselineEvents/add: + get: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. + description: Adds a list of baseline events to the system. + operationId: SubmitBaselineEventsadd_Get + parameters: + - name: Events + in: query + description: Specifies the list of baseline events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. + description: Adds a list of baseline events to the system. + operationId: SubmitBaselineEventsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitBaselineEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /baselineEvents/limitedAdd: + get: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitBaselineEventsLimitedlimitedAdd_Get + parameters: + - name: Events + in: query + description: Specifies the list of baseline events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/BaselineEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitBaselineEventsLimitedResponse' + security: + - Bearer: [ ] + post: + tags: + - baselineEvents + summary: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of baseline events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitBaselineEventsLimitedlimitedAdd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitBaselineEventsLimited' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitBaselineEventsLimitedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceEvents/add: + get: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. + description: Adds a list of device change events to the system. + operationId: SubmitDeviceEventsadd_Get + parameters: + - name: Events + in: query + description: Specifies the list of device events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. + description: Adds a list of device change events to the system. + operationId: SubmitDeviceEventsadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitDeviceEvents' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceEvents/limitedAdd: + get: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitDeviceEventsLimitedlimitedAdd_Get + parameters: + - name: Events + in: query + description: Specifies the list of device events for the hub to process. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/DeviceEvent' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitDeviceEventsLimitedResponse' + security: + - Bearer: [ ] + post: + tags: + - deviceEvents + summary: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + description: Adds a list of device change events to the system. The response can indicate a rate-limiting back off time. + operationId: SubmitDeviceEventsLimitedlimitedAdd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubmitDeviceEventsLimited' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitDeviceEventsLimitedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/ready: + get: + tags: + - status + summary: Gets whether system is booted and ready for login. + description: Gets whether system is booted and ready for login. + operationId: SystemReadyready_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Indicates if system is booted and ready for login. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemReadyResponse' + post: + tags: + - status + summary: Gets whether system is booted and ready for login. + description: Gets whether system is booted and ready for login. + operationId: SystemReadyready_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SystemReady' + x-bodyName: body + responses: + '200': + description: Indicates if system is booted and ready for login. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemReadyResponse' + parameters: + - $ref: '#/components/parameters/Accept' + /status/system: + get: + tags: + - status + summary: Gets system version and config settings once logged in. + description: Gets system version and config settings once logged in. + operationId: SystemDetailssystem_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: System version and config settings. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemDetailsResponse' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Gets system version and config settings once logged in. + description: Gets system version and config settings once logged in. + operationId: SystemDetailssystem_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SystemDetails' + x-bodyName: body + responses: + '200': + description: System version and config settings. + content: + application/json: + schema: + $ref: '#/components/schemas/SystemDetailsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/backgroundtasks: + get: + tags: + - status + summary: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + description: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + operationId: GetBackgroundTaskStatusesbackgroundtasks_Get + parameters: + - name: UserName + in: query + description: 'Specifies a specific user name to retrieve tasks for (Optional, but only Admin users can retrieve tasks for other users or internal system tasks).' + schema: + type: string + - name: StartDateTimeUtc + in: query + description: Specifies the start time (in UTC) for a task to be retrieved (Optional). + schema: + type: string + format: date-time + - name: EndDateTimeUtc + in: query + description: Specifies the end time (in UTC) for a task to be retrieved (Optional). + schema: + type: string + format: date-time + - name: Statuses + in: query + description: Specifies the status of tasks to be retrieved (Optional). + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies a list of specific task ids to retrieved (Optional). + style: form + schema: + type: array + items: + type: string + - name: TaskTypes + in: query + description: Specifies a list of specific task types to be retrieved (Optional). + style: form + schema: + type: array + items: + type: string + - name: IncludeDependentTasks + in: query + description: Specifies whether to return the tasks that each task depends on in its DependentTasks property (Optional). + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' + security: + - Bearer: [ ] + post: + tags: + - status + summary: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + description: 'Retrieves a list of background, potentially long-running, tasks the hub has performed and their associated status.' + operationId: GetBackgroundTaskStatusesbackgroundtasks_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetBackgroundTaskStatuses' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/BackgroundTaskDetails' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/eventsOnIncomingQueue: + get: + tags: + - status + summary: Gets the number of events currently in the processing queue. + description: Gets the number of events currently in the processing queue. + operationId: EventsOnIncomingQueueeventsOnIncomingQueue_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: integer + format: int32 + security: + - Bearer: [ ] + post: + tags: + - status + summary: Gets the number of events currently in the processing queue. + description: Gets the number of events currently in the processing queue. + operationId: EventsOnIncomingQueueeventsOnIncomingQueue_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/EventsOnIncomingQueue' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: integer + format: int32 + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/messageStatus: + get: + tags: + - status + summary: 'Returns the number of internal event notification messages received, processed or failed.' + description: 'Returns the number of internal event notification messages received, processed or failed.' + operationId: EventMessageStatusmessageStatus_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - status + summary: 'Returns the number of internal event notification messages received, processed or failed.' + description: 'Returns the number of internal event notification messages received, processed or failed.' + operationId: EventMessageStatusmessageStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/EventMessageStatus' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/pipeline: + get: + tags: + - status + summary: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + description: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + operationId: GetPipelineStatuspipeline_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + enum: + - Unknown + - Starting + - Up + - Stopping + - Down + - Busy + - Fault + - RequiresUpgrade + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - status + summary: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + description: 'Gets the pipeline status, returning a dictionary of pipeline components and their current status.' + operationId: GetPipelineStatuspipeline_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPipelineStatus' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + enum: + - Unknown + - Starting + - Up + - Stopping + - Down + - Busy + - Fault + - RequiresUpgrade + type: string + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/pipelineMetrics: + get: + tags: + - status + summary: Gets system performance metrics. + description: Gets system performance metrics. + operationId: GetPipelineMetricspipelineMetrics_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/PerformanceSnapshot' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Gets system performance metrics. + description: Gets system performance metrics. + operationId: GetPipelineMetricspipelineMetrics_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPipelineMetrics' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/PerformanceSnapshot' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/workload: + get: + tags: + - status + summary: Returns the pipeline workload. + description: Returns the pipeline workload. + operationId: GetWorkloadStatsworkload_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: number + format: double + x-nullable: false + description: 'Dictionary' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Returns the pipeline workload. + description: Returns the pipeline workload. + operationId: GetWorkloadStatsworkload_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetWorkloadStats' + x-bodyName: body + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: number + format: double + x-nullable: false + description: 'Dictionary' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /status/cache: + get: + tags: + - status + summary: Returns the cache statistics. + description: Returns the cache statistics. + operationId: GetCacheStatscache_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The cache statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/GetCacheStatsResponse' + security: + - Bearer: [ ] + post: + tags: + - status + summary: Returns the cache statistics. + description: Returns the cache statistics. + operationId: GetCacheStatscache_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCacheStats' + x-bodyName: body + responses: + '200': + description: The cache statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/GetCacheStatsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /openapi3.yaml: + get: + tags: + - openapi3.yaml + operationId: GetOpenApi3Yaml_Get + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + parameters: + - $ref: '#/components/parameters/Accept' + /reports/availableTypes: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetAvailableReportTypesavailableTypes_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportTypesResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetAvailableReportTypesavailableTypes_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAvailableReportTypes' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportTypesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/template: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatetemplate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatetemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: String + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/templates: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatestemplates_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportTemplatesResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetReportTemplatestemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportTemplates' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportTemplatesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/scheduled: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledReportsscheduled_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledReportsscheduled_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetScheduledReports' + x-bodyName: body + responses: + '200': + description: 'The response to requests to add, query or update scheduled reports, listing the new states of the reports affected' + content: + application/json: + schema: + $ref: '#/components/schemas/GetScheduledReportsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/updatetemplate: + get: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateReportTemplateupdatetemplate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReportTemplateResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UpdateReportTemplateupdatetemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateReportTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReportTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/uploadreporttemplate: + post: + tags: + - reports + summary: Report Service + description: Report Service + operationId: UploadReportTemplateuploadreporttemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UploadReportTemplate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/deletecustomreporttemplate: + get: + tags: + - reports + summary: Deletes a report layout template of the specified type and name + description: Deletes a report layout template of the specified type and name + operationId: DeleteCustomReportTemplatedeletecustomreporttemplate_Get + parameters: + - name: ReportTemplateType + in: query + description: Gets or sets the ReportTemplateType of the report template to delete. + required: true + schema: + enum: + - None + - ErrorReport + - AggregateReportTemplate + - EventsReport + - PlannedChangeReport + - TrackingTemplateReport + - ExecutiveSummaryReport + - ComplianceReport + - DeviceReport + - ScheduledItemsReport + - VulnerabilitySummaryReport + type: string + x-nullable: false + - name: TemplateName + in: query + description: Gets or sets the name of the report template to delete. + required: true + schema: + type: string + - name: TemplateVersion + in: query + description: Gets or sets the version of the report template to delete. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - reports + summary: Deletes a report layout template of the specified type and name + description: Deletes a report layout template of the specified type and name + operationId: DeleteCustomReportTemplatedeletecustomreporttemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteCustomReportTemplate' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/devicemonitoring: + get: + tags: + - reports + summary: A request to gets the data for a device monitoring report + description: A request to gets the data for a device monitoring report + operationId: DataSpecDeviceMonitoringReportdevicemonitoring_Get + parameters: + - name: DateRange + in: query + description: Provides information about how to calculate the start and end dates when performing the query + required: true + schema: + $ref: '#/components/schemas/ReportDateRange' + - name: OnlineStatuses + in: query + description: Gets or sets the online statuses of the devices to return. Optional. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Id + in: query + description: Specifies the Id of the data query specification + schema: + type: string + - name: Type + in: query + description: The Type name of the data query specification + schema: + type: string + - name: IteratorValues + in: query + description: 'Used to specify the list of items to report on, for data query specifications that support this. If this is not supplied, SelectionQuery can be used to specify a query to be performed to find the list of ids to report on' + style: form + schema: + type: array + items: + type: string + - name: SelectionQuery + in: query + description: 'The SelectionQuery is an alternative to supplying a list of values to report on in IteratorValues. It can be used to represent a query such as ''find Planned Change Instances where the name starts with XYZ'', returning a set of Planned Change Instance ids to report on.' + schema: + $ref: '#/components/schemas/SelectionQuery' + - name: Groups + in: query + description: Specifies the Groups (and implicitly and child groups) to be reported on in the report. + style: form + schema: + type: array + items: + type: string + - name: ItemName + in: query + description: 'Specifies the descriptive name of the result item, for example ''report'', ''planned change'', ''event'' etc.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The returned data for populating a device monitoring report + content: + application/json: + schema: + $ref: '#/components/schemas/DataSpecDeviceMonitoringReportResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + summary: A request to gets the data for a device monitoring report + description: A request to gets the data for a device monitoring report + operationId: DataSpecDeviceMonitoringReportdevicemonitoring_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DataSpecDeviceMonitoringReport' + x-bodyName: body + responses: + '200': + description: The returned data for populating a device monitoring report + content: + application/json: + schema: + $ref: '#/components/schemas/DataSpecDeviceMonitoringReportResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /reports/ruleresults: + get: + tags: + - reports + operationId: GetRuleResultsruleresults_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetRuleResultsResponse' + security: + - Bearer: [ ] + post: + tags: + - reports + operationId: GetRuleResultsruleresults_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetRuleResults' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetRuleResultsResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/compliancesummarydata: + get: + tags: + - stats + operationId: GetComplianceReportSummaryDatacompliancesummarydata_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: ReportInstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ComplianceReportSummaryResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + operationId: GetComplianceReportSummaryDatacompliancesummarydata_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceReportSummaryData' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ComplianceReportSummaryResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/plannedChanges: + get: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChanges_Get + parameters: + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChanges_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChanges' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/compliancedata: + get: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedata_Get + parameters: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedata_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/getavailablecompliancedata: + get: + tags: + - stats + summary: Get a list of groups or devices that have report data available for them + description: Get a list of groups or devices that have report data available for them + operationId: GetAvailableComplianceDatagetavailablecompliancedata_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Get a list of groups or devices that have report data available for them + description: Get a list of groups or devices that have report data available for them + operationId: GetAvailableComplianceDatagetavailablecompliancedata_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAvailableComplianceData' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableComplianceDataResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/deviceActivity: + get: + tags: + - stats + summary: Gets a list of inactive devices matching the filter. + description: Gets a list of inactive devices matching the filter. + operationId: GetDeviceActivitydeviceActivity_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents the list of devices matching the request criteria that have been inactive in the specified period. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceActivityResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Gets a list of inactive devices matching the filter. + description: Gets a list of inactive devices matching the filter. + operationId: GetDeviceActivitydeviceActivity_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceActivity' + x-bodyName: body + responses: + '200': + description: Represents the list of devices matching the request criteria that have been inactive in the specified period. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceActivityResponse' + security: + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /deviceSettings: + - $ref: '#/components/parameters/Accept' + /stats/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_Get + - 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: 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: 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: '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/GetDeviceSettingsResponse' + $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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /events: + - $ref: '#/components/parameters/Accept' + /stats/noisydevices: get: tags: - - events - summary: Retrieves a list of events from the hub service - description: Retrieves a list of events from the hub service. - operationId: GetEvents_Get + - 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: 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: + - 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 - 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: 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: The Events response. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetEventsResponse' + title: String + type: string security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /events/start/{StartUtc}: + - $ref: '#/components/parameters/Accept' + /reportRenderStart: get: tags: - - events - summary: Retrieves a list of events from the hub service - description: Retrieves a list of events from the hub service. - operationId: GetEventsstartStartUtc_Get + - reportRenderStart + summary: Report Service + description: Report Service + operationId: RenderReportStart_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: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: 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: 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: The Events response. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetEventsResponse' + title: String + type: string security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /events/end/{End}: - get: + - 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_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 + - 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: The Events response. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetEventsResponse' + title: String + type: string security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /events/start/{StartUtc}/end/{End}: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered/download: 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 + - reports + summary: Gets a previously generated report output file + description: Gets a previously generated report output file + operationId: GetScheduledInstanceOutputscheduledinstancesrendereddownload_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 + - name: Version + in: query + description: 'Specifies the request 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. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetEventsResponse' + 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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /events/skip/{Skip}/take/{Take}: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/rendered/delete: 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 + - reports + summary: Deletes previously generated report output files + description: Deletes previously generated report output files + operationId: DeleteScheduledInstanceOutputsscheduledinstancesrendereddelete_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 + - name: Version + in: query + description: 'Specifies 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: - '200': - description: The Events response. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetEventsResponse' + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /events/{EventId}: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances/delete: 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 + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledInstancescheduledinstancesdelete_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: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: 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: 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: The Events response. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetEventsResponse' + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /alertEvents/add: + - 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 + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledInstancescheduledinstancesdelete_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubmitAlertEvents' + $ref: '#/components/schemas/DeleteScheduledInstance' x-bodyName: body responses: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /alertEvents/limitedAdd: + - $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: - - 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 + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledInstanceLifetimescheduledinstanceupdateLifetime_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubmitAlertEventsLimited' + $ref: '#/components/schemas/UpdateScheduledInstanceLifetime' x-bodyName: body responses: '200': @@ -2129,91 +5189,300 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SubmitAlertEventsLimitedResponse' + $ref: '#/components/schemas/GetScheduledInstancesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /baselineEvents/add: + - $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: - - baselineEvents - summary: Adds a list of baseline events to the system - description: Adds a list of baseline events to the system. - operationId: SubmitBaselineEventsadd_Post + - reports + summary: Report Service + description: Report Service + operationId: GetScheduledInstanceRenderedscheduledinstancesrendered_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubmitBaselineEvents' + $ref: '#/components/schemas/GetScheduledInstanceRendered' x-bodyName: body 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' - /baselineEvents/limitedAdd: + - $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: - - 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 + - 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/SubmitBaselineEventsLimited' + $ref: '#/components/schemas/AddScheduledReport' x-bodyName: body responses: '200': - description: Success + 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/SubmitBaselineEventsLimitedResponse' + $ref: '#/components/schemas/GetScheduledReportsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /deviceEvents/add: + - $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: - - 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 + - reports + summary: Report Service + description: Report Service + operationId: UpdateScheduledReportscheduledupdate_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubmitDeviceEvents' + $ref: '#/components/schemas/UpdateScheduledReport' 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: + 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: {} + application/json: + schema: + title: string + type: boolean security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /deviceEvents/limitedAdd: + - 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 + - reports + summary: Report Service + description: Report Service + operationId: DeleteScheduledReportsscheduleddelete_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubmitDeviceEventsLimited' + $ref: '#/components/schemas/DeleteScheduledReports' x-bodyName: body responses: '200': @@ -2221,624 +5490,654 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SubmitDeviceEventsLimitedResponse' + title: string + type: boolean security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /status/ready: + - $ref: '#/components/parameters/Accept' + /reports/scheduled/instances: 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 + - 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: 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: Indicates if system is booted and ready for login. + description: Success content: application/json: schema: - $ref: '#/components/schemas/SystemReadyResponse' - parameters: - - $ref: '#/components/parameters/Accept' - /status/system: - get: + $ref: '#/components/schemas/GetScheduledInstancesResponse' + 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_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 + - 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: System version and config settings. + description: Success content: application/json: schema: - $ref: '#/components/schemas/SystemDetailsResponse' + $ref: '#/components/schemas/GetScheduledInstancesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /status/backgroundtasks: + - $ref: '#/components/parameters/Accept' + /uploadAgentUpdate: 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 + - uploadAgentUpdate + summary: Upload an Agent Update + description: Upload an Agent Update + operationId: UploadAgentUpdate_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 + - name: Version + in: query + description: 'Specifies the request 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: - title: List - type: array - items: - $ref: '#/components/schemas/BackgroundTaskDetails' + 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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /status/eventsOnIncomingQueue: + - $ref: '#/components/parameters/Accept' + /updatehubdetails: 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 + - 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 + - name: Version + in: query + description: 'Specifies the request 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: - title: string - type: integer - format: int32 + 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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /status/messageStatus: + - $ref: '#/components/parameters/Accept' + '/downloadAgentUpdate/{VersionRequested}': 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 + - downloadAgentUpdate + summary: Download an update package for the agent. + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequested_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: 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: Dictionary + description: Success content: application/json: schema: - title: Dictionary - type: object - additionalProperties: - type: string - description: Dictionary + $ref: '#/components/schemas/Object' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /status/pipeline: - get: + - 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_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 + - 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: Dictionary + description: Success content: application/json: schema: - title: Dictionary - type: object - additionalProperties: - enum: - - Unknown - - Starting - - Up - - Stopping - - Down - - Busy - - Fault - - RequiresUpgrade - type: string - description: Dictionary + $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /status/pipelineMetrics: + - $ref: '#/components/parameters/Accept' + '/downloadAgentUpdate/{VersionRequested}/{UpdateType}': get: tags: - - status - summary: Gets system performance metrics - description: Gets system performance metrics. - operationId: GetPipelineMetricspipelineMetrics_Get + - downloadAgentUpdate + summary: Download an update package for the agent. + description: Download an update package for the agent. + operationId: DownloadUpdateVersionRequestedUpdateType_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: 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: - title: List - type: array - items: - $ref: '#/components/schemas/PerformanceSnapshot' + $ref: '#/components/schemas/Object' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /status/workload: - get: + - Bearer: [ ] + post: 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 + - 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: Dictionary + description: Success content: application/json: schema: - title: Dictionary - type: object - additionalProperties: - type: number - format: double - x-nullable: false - description: Dictionary + $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /status/cache: + - $ref: '#/components/parameters/Accept' + /agentUpdates/delete: get: tags: - - status - summary: Returns the cache statistics - description: Returns the cache statistics. - operationId: GetCacheStatscache_Get + - agentUpdates + summary: Deletes the specified Agent update. + description: Deletes the specified Agent update. + operationId: DeleteAgentUpdatedelete_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: 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: - '200': - description: The cache statistics. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetCacheStatsResponse' + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /openapi3.yaml: - get: + - Bearer: [ ] + post: tags: - - openapi3.yaml - operationId: GetOpenApi3Yaml_Get + - 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: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/Object' + application/json: { } + security: + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/availableTypes: + - $ref: '#/components/parameters/Accept' + /agentUpdates: get: tags: - - reports - summary: Report Service - description: Report Service - operationId: GetAvailableReportTypesavailableTypes_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: Version - in: query - description: 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/GetAvailableReportTypesResponse' + title: List + type: array + items: + $ref: '#/components/schemas/AgentSoftwareUpdate' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /reports/template: - get: + - Bearer: [ ] + post: 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 + - 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: String - type: string + title: List + type: array + items: + $ref: '#/components/schemas/AgentSoftwareUpdate' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/templates: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules: get: tags: - - reports - summary: Report Service - description: Report Service - operationId: GetReportTemplatestemplates_Get + - 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: Version - in: query - description: 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 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/GetReportTemplatesResponse' + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled: - get: + - Bearer: [ ] + post: 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 + - 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: The response to requests to add, query or update scheduled reports, listing the new states of the reports affected + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetScheduledReportsResponse' + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/updatetemplate: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/delete: get: tags: - - reports - summary: Report Service - description: Report Service - operationId: UpdateReportTemplateupdatetemplate_Get + - 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: Version - in: query - description: 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 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 + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/UpdateReportTemplateResponse' + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /reports/uploadreporttemplate: + - Bearer: [ ] post: tags: - - reports - summary: Report Service - description: Report Service - operationId: UploadReportTemplateuploadreporttemplate_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/UploadReportTemplate' + $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' - /reports/deletecustomreporttemplate: + - $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: - - 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 + - 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/DeleteCustomReportTemplate' + $ref: '#/components/schemas/UpdateAgentSoftwareUpdateScheduleForGroup' 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' + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/ruleresults: + - $ref: '#/components/parameters/Accept' + /agentSoftwareUpdateSchedules/add: get: tags: - - reports - operationId: GetRuleResultsruleresults_Get + - 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: Version - in: query - description: 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 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: - $ref: '#/components/schemas/GetRuleResultsResponse' + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - reports - operationId: GetRuleResultsruleresults_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/GetRuleResults' + $ref: '#/components/schemas/SetAgentSoftwareUpdateScheduleForGroup' x-bodyName: body responses: '200': @@ -2846,1112 +6145,940 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetRuleResultsResponse' + title: List + type: array + items: + $ref: '#/components/schemas/GroupAgentUpdateSchedule' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /stats/compliancesummarydata: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems: get: tags: - - stats - operationId: GetComplianceReportSummaryDatacompliancesummarydata_Get + - syncServiceConfigItems + summary: Retrieves a list of SyncService configuration items. + description: Retrieves a list of SyncService configuration items. + operationId: GetSyncServiceConfigItems_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 + - 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: Response for retrieving SyncService configuration items content: application/json: schema: - $ref: '#/components/schemas/ComplianceReportSummaryResponse' + $ref: '#/components/schemas/GetSyncServiceConfigItemsResponse' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - stats - operationId: GetComplianceReportSummaryDatacompliancesummarydata_Post + - 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/GetComplianceReportSummaryData' + $ref: '#/components/schemas/AddSyncServiceConfigItem' x-bodyName: body responses: '200': - description: Success + description: Response for adding a SyncService configuration item content: application/json: schema: - $ref: '#/components/schemas/ComplianceReportSummaryResponse' + $ref: '#/components/schemas/AddSyncServiceConfigItemResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /stats/plannedChanges: - get: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/update: + post: 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 + - 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/GetCurrentPlannedChangesResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /stats/compliancedata: - get: + - $ref: '#/components/parameters/Accept' + /syncServiceConfigItems/delete: + 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_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 + - 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: Compliance data by report, for either individual devices, or as group average. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetComplianceDataResponse' + $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /stats/getavailablecompliancedata: + - $ref: '#/components/parameters/Accept' + /configItems: 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 + - configItems + summary: Retrieves a list of hub configuration parameters. + description: Retrieves a list of hub configuration parameters. + operationId: GetConfigItems_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: 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: Success + description: Describes the hub configuration parameters. content: application/json: schema: - $ref: '#/components/schemas/GetAvailableComplianceDataResponse' + $ref: '#/components/schemas/GetConfigItemsResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /stats/deviceActivity: - get: + - 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_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 + - 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: Represents the list of devices matching the request criteria that have been inactive in the specified period. + description: Describes the hub configuration parameters. content: application/json: schema: - $ref: '#/components/schemas/GetDeviceActivityResponse' + $ref: '#/components/schemas/GetConfigItemsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /stats/events: + - $ref: '#/components/parameters/Accept' + /configItems/add: 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 + - configItems + summary: Add a list of hub configuration parameters. + description: Add a list of hub configuration parameters. + operationId: AddConfigItemsadd_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: 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: Represents a summary of event counts for the devices or groups specified by the DeviceFilter, for the specified time period. + description: 'Dictionary' content: application/json: schema: - $ref: '#/components/schemas/GetEventCountsResponse' + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/NewId' + description: 'Dictionary' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /stats/noisydevices: - get: + - 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_Get - parameters: - - name: TopN - in: query - schema: - type: integer - format: int32 - x-nullable: false + - 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: Success + description: 'Dictionary' content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/GetEventCountsResponse' + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/NewId' + description: 'Dictionary' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reportExecute: + - $ref: '#/components/parameters/Accept' + /configItems/update: get: tags: - - reportExecute - summary: Report Service - description: Report Service - operationId: ExecuteReport_Get + - configItems + summary: Update a a list of hub configuration parameters. + description: Update a a list of hub configuration parameters. + operationId: UpdateConfigItemsupdate_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 + - 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: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/ExecuteReportResponse' + application/json: { } security: - - Bearer: [] + - Bearer: [ ] post: tags: - - reportExecute - summary: Report Service - description: Report Service - operationId: ExecuteReport_Post + - 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/ExecuteReport' + $ref: '#/components/schemas/UpdateConfigItems' x-bodyName: body responses: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/ExecuteReportResponse' + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reportRenderIsCached: + - $ref: '#/components/parameters/Accept' + /configItems/delete: get: tags: - - reportRenderIsCached - summary: Report Service - description: Report Service - operationId: RenderReportIsCached_Get + - 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: 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 + - 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: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - title: string - type: boolean + 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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reportRender: + - $ref: '#/components/parameters/Accept' + /configItem/update: get: - tags: - - reportRender - summary: Report Service - description: Report Service - operationId: RenderReport_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: 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 + - 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: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - title: String - type: string + application/json: { } security: - - Bearer: [] + - Bearer: [ ] post: tags: - - reportRender - summary: Report Service - description: Report Service - operationId: RenderReport_Post + - 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/RenderReport' + $ref: '#/components/schemas/UpdateConfigItem' x-bodyName: body responses: - '200': - description: Success + '204': + description: No Content content: - application/json: - schema: - title: String - type: string + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reportRenderStart: + - $ref: '#/components/parameters/Accept' + /configItem/add: get: tags: - - reportRenderStart - summary: Report Service - description: Report Service - operationId: RenderReportStart_Get + - configItem + summary: Add a hub configuration parameter by Key. + description: Add a hub configuration parameter by Key. + operationId: AddConfigItemadd_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 + - 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: Success + description: The response delivered after adding a new config key / value. content: application/json: schema: - title: String - type: string + $ref: '#/components/schemas/AddConfigItemResponse' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - reportRenderStart - summary: Report Service - description: Report Service - operationId: RenderReportStart_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/RenderReportStart' + $ref: '#/components/schemas/AddConfigItem' x-bodyName: body responses: '200': - description: Success + description: The response delivered after adding a new config key / value. content: application/json: schema: - title: String - type: string + $ref: '#/components/schemas/AddConfigItemResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled/instances/rendered/download: + - $ref: '#/components/parameters/Accept' + /misc/dateTransmissionTest: get: tags: - - reports - summary: Gets a previously generated report output file - description: Gets a previously generated report output file - operationId: GetScheduledInstanceOutputscheduledinstancesrendereddownload_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: Version - in: query - description: 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: Success content: application/json: schema: - title: String + title: string type: string + format: date-time security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled/instances/rendered/delete: + - Bearer: [ ] post: tags: - - reports - summary: Deletes previously generated report output files - description: Deletes previously generated report output files - operationId: DeleteScheduledInstanceOutputsscheduledinstancesrendereddelete_Post + - 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/DeleteScheduledInstanceOutputs' + $ref: '#/components/schemas/DateTransmissionTest' 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: [] - 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' + title: string + type: string + format: date-time security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled/instances/rendered: + - $ref: '#/components/parameters/Accept' + /credentials/add: get: tags: - - reports - summary: Report Service - description: Report Service - operationId: GetScheduledInstanceRenderedscheduledinstancesrendered_Get + - credentials + summary: Add credentials for specified type and key. + description: Add credentials for specified type and key. + operationId: AddCredentialsadd_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 + - 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: Success + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' content: application/json: schema: - $ref: '#/components/schemas/GetScheduledInstanceRenderedResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled/add: + - 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 + - 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/AddScheduledReport' + $ref: '#/components/schemas/AddCredentials' 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 + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' content: application/json: schema: - $ref: '#/components/schemas/GetScheduledReportsResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled/delete: + - $ref: '#/components/parameters/Accept' + /credentials/update: get: tags: - - reports - summary: Report Service - description: Report Service - operationId: DeleteScheduledReportsscheduleddelete_Get + - credentials + summary: Update credentials for specified type and key. + description: Update credentials for specified type and key. + operationId: UpdateCredentialsupdate_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: 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: Success + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' content: application/json: schema: - title: string - type: boolean + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /reports/scheduled/instances: - get: + - Bearer: [ ] + post: 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 + - 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: Success + description: 'Represents some credentials used to connect to a remote service (e.g SSH, database etc).' content: application/json: schema: - $ref: '#/components/schemas/GetScheduledInstancesResponse' + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /uploadAgentUpdate: - post: + - $ref: '#/components/parameters/Accept' + /credentials/delete: + get: 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 + - 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: {} + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /updatehubdetails: + - 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 + - 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/UpdateHubDetails' + $ref: '#/components/schemas/RemoveCredentials' x-bodyName: body responses: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /downloadAgentUpdate/{VersionRequested}: + - $ref: '#/components/parameters/Accept' + /credentialsKeyedByType: get: tags: - - downloadAgentUpdate - summary: Download an update package for the agent - description: Download an update package for the agent. - operationId: DownloadUpdateVersionRequested_Get + - 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: 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 + - name: Version + in: query + description: 'Specifies the request 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/Object' + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - downloadAgentUpdate - summary: Download an update package for the agent - description: Download an update package for the agent. - operationId: DownloadUpdateVersionRequested_Post + - 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/DownloadUpdate' + $ref: '#/components/schemas/GetCredentialsKeyedByType' x-bodyName: body responses: '200': - description: Success + description: 'Dictionary>' content: application/json: schema: - $ref: '#/components/schemas/Object' + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /downloadAgentUpdate/{VersionRequested}/{UpdateType}: + - $ref: '#/components/parameters/Accept' + /credentials: get: tags: - - downloadAgentUpdate - summary: Download an update package for the agent - description: Download an update package for the agent. - operationId: DownloadUpdateVersionRequestedUpdateType_Get + - 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: 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 + - 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/Object' + title: List + type: array + items: + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - downloadAgentUpdate - summary: Download an update package for the agent - description: Download an update package for the agent. - operationId: DownloadUpdateVersionRequestedUpdateType_Post + - credentials + summary: Gets a list of all credentials of the specified type. + description: Gets a list of all credentials of the specified type. + operationId: GetCredentialsList_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DownloadUpdate' + $ref: '#/components/schemas/GetCredentialsList' x-bodyName: body responses: '200': @@ -3959,2130 +7086,2308 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Object' + title: List + type: array + items: + $ref: '#/components/schemas/Credentials' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /agentUpdates/delete: + - $ref: '#/components/parameters/Accept' + /command/tasks/status: + get: + tags: + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatus_Get + parameters: + - name: Ids + in: query + description: Specifies the task ids. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id. + schema: + type: integer + format: int32 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetAgentTaskStatuses + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + security: + - Bearer: [ ] post: tags: - - agentUpdates - summary: Deletes the specified Agent update - description: Deletes the specified Agent update. - operationId: DeleteAgentUpdatedelete_Post + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatus_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DeleteAgentUpdate' + $ref: '#/components/schemas/GetAgentTaskStatuses' 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 + description: The response object for GetAgentTaskStatuses content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/AgentSoftwareUpdate' + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /agentSoftwareUpdateSchedules: + - $ref: '#/components/parameters/Accept' + '/command/tasks/status/ids/{Ids}': 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 + - 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: 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 + - name: Ids + in: query + description: Specifies the task ids. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id. + schema: + type: integer + format: int32 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: Success + description: The response object for GetAgentTaskStatuses content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/GroupAgentUpdateSchedule' + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /agentSoftwareUpdateSchedules/delete: + - 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 + - command + summary: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + description: 'Requests information about the given tasks'' status. If a PolicyRunId is supplied, the tasks associated with it are returned.' + operationId: GetAgentTaskStatusestasksstatusidsIds_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DeleteAgentSoftwareUpdateScheduleFromGroup' + $ref: '#/components/schemas/GetAgentTaskStatuses' x-bodyName: body responses: - '204': - description: No Content + '200': + description: The response object for GetAgentTaskStatuses content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/GetAgentTaskStatusesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /agentSoftwareUpdateSchedules/update: - post: + - $ref: '#/components/parameters/Accept' + '/command/tasks/add/agent/{AgentId}': + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/UpdateAgentSoftwareUpdateScheduleForGroup' - x-bodyName: body + - command + summary: Adds a list of tasks for the given agent. + description: Adds a list of tasks for the given agent. + operationId: SubmitAgentTaskstasksaddagentAgentId_Get + parameters: + - name: Tasks + in: query + description: Specifies the list of tasks that will be submitted. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/AgentTask' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: - '204': - description: No Content + '200': + description: The response object for SubmitAgentTasks. content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/SubmitAgentTasksResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /agentSoftwareUpdateSchedules/add: + - 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 + - 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/SetAgentSoftwareUpdateScheduleForGroup' + $ref: '#/components/schemas/SubmitAgentTasks' x-bodyName: body responses: '200': - description: Success + description: The response object for SubmitAgentTasks. content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/GroupAgentUpdateSchedule' + $ref: '#/components/schemas/SubmitAgentTasksResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /syncServiceConfigItems: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/legacy/{LegacyId}': get: tags: - - syncServiceConfigItems - summary: Retrieves a list of SyncService configuration items - description: Retrieves a list of SyncService configuration items. - operationId: GetSyncServiceConfigItems_Get + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyId_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: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: 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: 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: Response for retrieving SyncService configuration items + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/GetSyncServiceConfigItemsResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /syncServiceConfigItems/add: + - Bearer: [ ] post: tags: - - syncServiceConfigItems - summary: Adds a new SyncService configuration item - description: Adds a new SyncService configuration item. - operationId: AddSyncServiceConfigItemadd_Post + - 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/AddSyncServiceConfigItem' + $ref: '#/components/schemas/GetAgentTasks' x-bodyName: body responses: '200': - description: Response for adding a SyncService configuration item + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/AddSyncServiceConfigItemResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /syncServiceConfigItems/update: - post: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/{AgentId}/all/{AllTasks}': + get: 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 + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdallAllTasks_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /syncServiceConfigItems/delete: + - Bearer: [ ] post: tags: - - syncServiceConfigItems - summary: Deletes a SyncService configuration item - description: Deletes a SyncService configuration item. - operationId: DeleteSyncServiceConfigItemdelete_Post + - 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/DeleteSyncServiceConfigItem' + $ref: '#/components/schemas/GetAgentTasks' x-bodyName: body responses: '200': - description: Success + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/Object' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /configItems: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/{AgentId}/single/{TaskId}': get: tags: - - configItems - summary: Retrieves a list of hub configuration parameters - description: Retrieves a list of hub configuration parameters. - operationId: GetConfigItems_Get + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentAgentIdsingleTaskId_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: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: 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: + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: 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: 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: Describes the hub configuration parameters. + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/GetConfigItemsResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /configItems/add: + - Bearer: [ ] post: tags: - - configItems - summary: Add a list of hub configuration parameters - description: Add a list of hub configuration parameters. - operationId: AddConfigItemsadd_Post + - 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/AddConfigItems' + $ref: '#/components/schemas/GetAgentTasks' x-bodyName: body responses: '200': - description: Dictionary + description: The response object for GetAgentTasks content: application/json: schema: - title: Dictionary - type: object - additionalProperties: - $ref: '#/components/schemas/NewId' - description: Dictionary + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /configItems/update: - post: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/legacy/{LegacyId}/all/{AllTasks}': + get: 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 + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdallAllTasks_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: - '204': - description: No Content + '200': + description: The response object for GetAgentTasks content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /configItems/delete: + - 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 + - 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/DeleteConfigItem' + $ref: '#/components/schemas/GetAgentTasks' x-bodyName: body responses: - '204': - description: No Content + '200': + description: The response object for GetAgentTasks content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /configItem/update: - post: + - $ref: '#/components/parameters/Accept' + '/command/tasks/agent/legacy/{LegacyId}/single/{TaskId}': + 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_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/UpdateConfigItem' - x-bodyName: body + - command + summary: Requests information about tasks for the given agent. + description: Requests information about tasks for the given agent. + operationId: GetAgentTaskstasksagentlegacyLegacyIdsingleTaskId_Get + parameters: + - name: AgentId + in: query + description: Specifies the agent's AgentId. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the agent's DeviceId. + schema: + type: string + - name: TaskStatuses + in: query + description: Specifies a value indicating the task statuses to filter by. + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: TaskIds + in: query + description: Specifies value indicating the task ids to look for. + style: form + schema: + type: array + items: + type: integer + format: int32 + x-nullable: false + - name: PolicyRunId + in: query + description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. + schema: + type: integer + format: int32 + - name: TaskType + in: query + description: Specifies the specific task type to retrieve details for + schema: + type: string + - name: Concise + in: query + description: Return a concise view of the tasks? i.e not the Text and ResultData properties + schema: + type: boolean + x-nullable: false + - name: IgnoreActiveDates + in: query + description: 'By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates.' + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: - '204': - description: No Content + '200': + description: The response object for GetAgentTasks content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /configItem/add: + - Bearer: [ ] post: tags: - - configItem - summary: Add a hub configuration parameter by Key - description: Add a hub configuration parameter by Key. - operationId: AddConfigItemadd_Post + - 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/AddConfigItem' + $ref: '#/components/schemas/GetAgentTasks' x-bodyName: body responses: '200': - description: The response delivered after adding a new config key / value. + description: The response object for GetAgentTasks content: application/json: schema: - $ref: '#/components/schemas/AddConfigItemResponse' + $ref: '#/components/schemas/GetAgentTasksResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /misc/dateTransmissionTest: + - $ref: '#/components/parameters/Accept' + '/downloadFileHash/{HostType}/{OperatingSystem}/{Variant}': 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 + - downloadFileHash + summary: Download the filehasing utility app for remote monitoring. + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_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 + - name: ReturnUrl + in: query + description: Specifies a flag that indicates wether or not to return a URL or the file directly + schema: + type: boolean + x-nullable: false + - name: HostType + in: query + description: 'Specifies the host type the file hash binary is required for (e.g Unix, Windows etc)' + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + - name: OperatingSystem + in: query + description: Specifies the operating system naame (as defined in KnownOsNames). Optional + schema: + type: string + - name: Variant + in: query + description: 'Specifies the operating system / host variant. e.g x64, 10 SPARC etc' + schema: + type: string + - name: FileId + in: query + description: Specifies the specific file id + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': description: Success content: application/json: schema: - title: string - type: string - format: date-time + $ref: '#/components/schemas/Object' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /credentials/add: + - Bearer: [ ] post: tags: - - credentials - summary: Add credentials for specified type and key - description: Add credentials for specified type and key. - operationId: AddCredentialsadd_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/AddCredentials' + $ref: '#/components/schemas/DownloadFileHashBinary' x-bodyName: body responses: '200': - description: Represents some credentials used to connect to a remote service (e.g SSH, database etc). + description: Success content: application/json: schema: - $ref: '#/components/schemas/Credentials' + $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /credentials/update: - post: + - $ref: '#/components/parameters/Accept' + '/downloadFileHashById/{FileId}': + get: 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 + - downloadFileHashById + summary: Download the filehasing utility app for remote monitoring. + description: Download the filehasing utility app for remote monitoring. + operationId: DownloadFileHashBinaryFileId_Get + parameters: + - name: ReturnUrl + in: query + description: Specifies a flag that indicates wether or not to return a URL or the file directly + schema: + type: boolean + x-nullable: false + - name: HostType + in: query + description: 'Specifies the host type the file hash binary is required for (e.g Unix, Windows etc)' + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + - name: OperatingSystem + in: query + description: Specifies the operating system naame (as defined in KnownOsNames). Optional + schema: + type: string + - name: Variant + in: query + description: 'Specifies the operating system / host variant. e.g x64, 10 SPARC etc' + schema: + type: string + - name: FileId + in: query + description: Specifies the specific file id + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: Represents some credentials used to connect to a remote service (e.g SSH, database etc). + description: Success content: application/json: schema: - $ref: '#/components/schemas/Credentials' + $ref: '#/components/schemas/Object' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /credentials/delete: + - Bearer: [ ] post: tags: - - credentials - summary: Remove credentials for specified type and key - description: Remove credentials for specified type and key. - operationId: RemoveCredentialsdelete_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/RemoveCredentials' + $ref: '#/components/schemas/DownloadFileHashBinary' 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> + description: Success content: application/json: schema: - title: Dictionary> - type: object - additionalProperties: - type: array - items: - type: string - description: Dictionary> + $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /credentials: + - $ref: '#/components/parameters/Accept' + /getFileHashBinaries: 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 + - 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: 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 + - name: Version + in: query + description: 'Specifies the request 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 + title: List type: array items: - $ref: '#/components/schemas/Credentials' + $ref: '#/components/schemas/FileHashBinary' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/status: - get: + - Bearer: [ ] + post: tags: - - command - summary: Requests information about the given tasks' status. If a PolicyRunId is supplied, the tasks associated with it are returned. - description: Requests information about the given tasks' status. If a PolicyRunId is supplied, the tasks associated with it are returned. - operationId: GetAgentTaskStatusestasksstatus_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 + - getFileHashBinaries + summary: Retrieves the list of file hash binaries available to download from the hub. + description: Retrieves the list of file hash binaries available to download from the hub. + operationId: GetFileHashBinaries_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetFileHashBinaries' + x-bodyName: body responses: '200': - description: The response object for GetAgentTaskStatuses + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + title: List + type: array + items: + $ref: '#/components/schemas/FileHashBinary' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/status/ids/{Ids}: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/members: 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 + - 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: Ids - in: query - description: Specifies the task ids. - style: form - schema: - type: array - items: + - 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: 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 + x-nullable: false responses: '200': - description: The response object for GetAgentTaskStatuses + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetAgentTaskStatusesResponse' + $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/add/agent/{AgentId}: + - Bearer: [ ] post: tags: - - command - summary: Adds a list of tasks for the given agent - description: Adds a list of tasks for the given agent. - operationId: SubmitAgentTaskstasksaddagentAgentId_Post + - plannedChangeInstances + summary: Gets the group and device members of the specified planned change instance. + description: Gets the group and device members of the specified planned change instance. + operationId: GetPlannedChangeInstanceMembersmembers_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SubmitAgentTasks' + $ref: '#/components/schemas/GetPlannedChangeInstanceMembers' x-bodyName: body responses: '200': - description: The response object for SubmitAgentTasks. + description: Success content: application/json: schema: - $ref: '#/components/schemas/SubmitAgentTasksResponse' + $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/agent/legacy/{LegacyId}: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/delete: get: tags: - - command - summary: Requests information about tasks for the given agent - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentlegacyLegacyId_Get + - plannedChangeInstances + summary: Deletes an instance of a planned change from the system. + description: Deletes an instance of a planned change from the system. + operationId: DeletePlannedChangeInstancedelete_Get parameters: - - name: 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: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: 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: + - 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 - - 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 + x-nullable: false responses: - '200': - description: The response object for GetAgentTasks - content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentTasksResponse' - security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/agent/{AgentId}/all/{AllTasks}: - get: - tags: - - command - summary: Requests information about tasks for the given agent - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentAgentIdallAllTasks_Get - parameters: - - name: AgentId - in: query - description: Specifies the agent's AgentId. - schema: - type: string - - name: DeviceId - in: query - description: Specifies the agent's DeviceId. - schema: - type: string - - name: TaskStatuses - in: query - description: Specifies a value indicating the task statuses to filter by. - style: form - schema: - type: array - items: - type: string - x-nullable: false - - name: TaskIds - in: query - description: Specifies value indicating the task ids to look for. - style: form - schema: - type: array - items: - type: integer - format: int32 - x-nullable: false - - name: PolicyRunId - in: query - description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. - schema: - type: integer - format: int32 - - name: TaskType - in: query - description: Specifies the specific task type to retrieve details for - schema: - type: string - - name: Concise - in: query - description: Return a concise view of the tasks? i.e not the Text and ResultData properties - schema: - type: boolean - x-nullable: false - - name: IgnoreActiveDates - in: query - description: By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates. - schema: - type: boolean - x-nullable: false - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: - type: string - description: Dictionary - - name: Skip - in: query - description: The offset into the result set to start at. - schema: - type: integer - format: int32 - - name: Take - in: query - description: The limit number of rows to return. - schema: - type: integer - format: int32 - - name: GenericFilters - in: query - description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. - style: form - schema: - type: array - items: - $ref: '#/components/schemas/PagingQueryFilter' - - name: GenericFilterLogic - in: query - description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Deletes an instance of a planned change from the system. + description: Deletes an instance of a planned change from the system. + operationId: DeletePlannedChangeInstancedelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePlannedChangeInstance' + x-bodyName: body responses: - '200': - description: The response object for GetAgentTasks + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/agent/{AgentId}/single/{TaskId}: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/deleteMember: get: tags: - - command - summary: Requests information about tasks for the given agent - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentAgentIdsingleTaskId_Get + - plannedChangeInstances + summary: Removes a group or device from a planned change + description: Removes a group or device from a planned change + operationId: DeletePlannedChangeInstanceMemberdeleteMember_Get parameters: - - name: 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: + - name: GroupName + in: query + description: Specifies the group to remove from the planned change. + schema: 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: + - name: AgentDeviceId + in: query + description: Specifies individual device remove from the planned change. + schema: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: type: integer format: int32 - x-nullable: false - - 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 + x-nullable: false responses: - '200': - description: The response object for GetAgentTasks + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - plannedChangeInstances + summary: Removes a group or device from a planned change + description: Removes a group or device from a planned change + operationId: DeletePlannedChangeInstanceMemberdeleteMember_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeletePlannedChangeInstanceMember' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/agent/legacy/{LegacyId}/all/{AllTasks}: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/add: get: tags: - - command - summary: Requests information about tasks for the given agent - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentlegacyLegacyIdallAllTasks_Get + - plannedChangeInstances + summary: Add a planned change instance. + description: Add a planned change instance. + operationId: AddPlannedChangeInstanceadd_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: + - 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 - x-nullable: false - - name: TaskIds - in: query - description: Specifies value indicating the task ids to look for. - style: form - schema: - type: array - items: + - name: DisplayName + in: query + description: Specifies the DisplayName. Required. + schema: + type: string + - name: Description + in: query + description: Specifies the description. Required. + schema: + type: string + - name: AssignedTo + in: query + description: Specifies the Assigned To Name. + schema: + type: string + - name: Origin + in: query + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when created by sync service.' + schema: + type: string + - name: MemberGroups + in: query + description: Specifies the groups that are members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the devices that are explicit members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: StartTimeUtc + in: query + description: Specifies the UTC start time of the instance. Optional. + schema: + type: string + format: date-time + - name: EndTimeUtc + in: query + description: Specifies the UTC end time of the instance. Optional. + schema: + type: string + format: date-time + - name: PeriodicityCount + in: query + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: type: integer format: int32 - x-nullable: false - - name: 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 + x-nullable: false + - name: PeriodicityUnit + in: query + description: Specifies a value indicating the periodicity unit. + schema: + enum: + - None + - Second + - Minute + - Hour + - Day + - Week + type: string + x-nullable: false + - name: PeriodDurationCount + in: query + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + x-nullable: false + - name: PeriodDurationUnit + in: query + description: Specifies a value indicating the period duration unit. + schema: + enum: + - None + - Second + - Minute + - Hour + - Day + - Week + type: string + x-nullable: false + - name: Disabled + in: query + description: Specifies a value indicating whether to create the planned change instance in a disabled state. + schema: + type: boolean + x-nullable: false + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + schema: + type: boolean + x-nullable: false + - name: UseAttributeRules + in: query + description: 'TODO: How do we deal with this? TEMP used to trigger the new file hash based attribute rule generation. Eventually this will be the norm and this property can be removed.' + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: The response object for GetAgentTasks + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /command/tasks/agent/legacy/{LegacyId}/single/{TaskId}: - get: + - Bearer: [ ] + post: tags: - - command - summary: Requests information about tasks for the given agent - description: Requests information about tasks for the given agent. - operationId: GetAgentTaskstasksagentlegacyLegacyIdsingleTaskId_Get - parameters: - - name: AgentId - in: query - description: Specifies the agent's AgentId. - schema: - type: string - - name: DeviceId - in: query - description: Specifies the agent's DeviceId. - schema: - type: string - - name: TaskStatuses - in: query - description: Specifies a value indicating the task statuses to filter by. - style: form - schema: - type: array - items: - type: string - x-nullable: false - - name: TaskIds - in: query - description: Specifies value indicating the task ids to look for. - style: form - schema: - type: array - items: - type: integer - format: int32 - x-nullable: false - - name: PolicyRunId - in: query - description: Specifies the policy run id associated with the last run of the report etc. use this to find tasks started by a given scheduled policy. - schema: - type: integer - format: int32 - - name: TaskType - in: query - description: Specifies the specific task type to retrieve details for - schema: - type: string - - name: Concise - in: query - description: Return a concise view of the tasks? i.e not the Text and ResultData properties - schema: - type: boolean - x-nullable: false - - name: IgnoreActiveDates - in: query - description: By default only AgentTasks that are currently between their StartDate and EndDate values are returned, this flag returns tasks irrespective of dates. - schema: - type: boolean - x-nullable: false - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: - type: string - description: Dictionary - - name: Skip - in: query - description: The offset into the result set to start at. - schema: - type: integer - format: int32 - - name: Take - in: query - description: The limit number of rows to return. - schema: - type: integer - format: int32 - - name: GenericFilters - in: query - description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. - style: form - schema: - type: array - items: - $ref: '#/components/schemas/PagingQueryFilter' - - name: GenericFilterLogic - in: query - description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - plannedChangeInstances + summary: Add a planned change instance. + description: Add a planned change instance. + operationId: AddPlannedChangeInstanceadd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AddPlannedChangeInstance' + x-bodyName: body responses: '200': - description: The response object for GetAgentTasks + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: application/json: schema: - $ref: '#/components/schemas/GetAgentTasksResponse' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /downloadFileHash/{HostType}/{OperatingSystem}/{Variant}: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/update: get: tags: - - downloadFileHash - summary: Download the filehasing utility app for remote monitoring - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_Get + - plannedChangeInstances + summary: Update a planned change instance + description: Update a planned change instance + operationId: UpdatePlannedChangeInstanceupdate_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: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Description + in: query + description: Specifies the description. Optional. + schema: + type: string + - name: PlannedChangeName + in: query + description: Specifies the id (Name) of the ruleset used by this planned change. Optional. + schema: + type: string + - name: AssignedTo + in: query + description: Specifies the Assigned To Name. + schema: + type: string + - name: MemberGroups + in: query + description: Specifies the groups that are members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: StartTimeUtc + in: query + description: Specifies the UTC start time of the instance. Optional. + schema: + type: string + format: date-time + - name: EndTimeUtc + in: query + description: Specifies the UTC end time of the instance. Optional. + schema: + type: string + format: date-time + - name: Started + in: query + description: Specifies a value indicating whether the planned change has been started. Optional. + schema: + type: boolean + - name: Ended + in: query + description: Specifies a value indicating whether the planned change has been ended. Optional. + schema: + type: boolean + - name: Disabled + in: query + description: Specifies a value indicating whether the planned change instance is disabled. Optional. + schema: + type: boolean + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events. Optional.' + schema: + type: boolean + - name: PeriodicityCount + in: query + description: Specifies a value indicating the periodicity of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + - name: PeriodicityUnit + in: query + description: Specifies a value indicating the periodicity unit. + schema: + type: string + - name: PeriodDurationCount + in: query + description: Specifies a value indicating the period duration of the planned change. When PeriodicityCount is greater then zero the planned change is active every PeriodicityCount PeriodicityUnits for PeriodDurationCount PeriodDurationUnits starting from StartTimeUtc. + schema: + type: integer + format: int32 + - name: PeriodDurationUnit + in: query + description: Specifies a value indicating the period duration unit. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the Display Name. + schema: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the devices that are explicit members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: 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: [ ] post: tags: - - downloadFileHash - summary: Download the filehasing utility app for remote monitoring - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryHostTypeOperatingSystemVariant_Post + - 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/DownloadFileHashBinary' + $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' - /downloadFileHashById/{FileId}: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/clone: get: tags: - - downloadFileHashById - summary: Download the filehasing utility app for remote monitoring - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryFileId_Get + - plannedChangeInstances + summary: Clone a planned change instance. + description: Clone a planned change instance. + operationId: ClonePlannedChangeInstanceclone_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: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: CloneDefinition + in: query + description: Specifies the whether to clone the associated PlannedChangeDefinition + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: 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: [ ] post: tags: - - downloadFileHashById - summary: Download the filehasing utility app for remote monitoring - description: Download the filehasing utility app for remote monitoring. - operationId: DownloadFileHashBinaryFileId_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/DownloadFileHashBinary' + $ref: '#/components/schemas/ClonePlannedChangeInstance' x-bodyName: body responses: '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Object' - security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /getFileHashBinaries: - get: - tags: - - getFileHashBinaries - summary: Retrieves the list of file hash binaries available to download from the hub - description: Retrieves the list of file hash binaries available to download from the hub. - operationId: GetFileHashBinaries_Get - parameters: - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false - responses: - '200': - description: Success + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: application/json: schema: - title: List - type: array - items: - $ref: '#/components/schemas/FileHashBinary' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/members: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/nameValue: 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 + - 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: 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: 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: Success + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangeInstanceMembersResponse' + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/delete: + - 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 + - plannedChangeInstances + summary: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + description: 'Gets planned change instances name and id, filtering by name, id or groups that are members.' + operationId: GetPlannedChangeInstancesNameValuenameValue_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DeletePlannedChangeInstance' + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValue' x-bodyName: body responses: - '204': - description: No Content + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/deleteMember: - post: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/addMembers: + 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 + - plannedChangeInstances + summary: Add a list of groups to a planned change + description: Add a list of groups to a planned change + operationId: AddPlannedChangeInstanceMemberaddMembers_Get + parameters: + - name: MemberGroups + in: query + description: Specifies names of groups of devices to add to the planned change. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies individual device ids to add to the planned change. + style: form + schema: + type: array + items: + type: string + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/add: + - Bearer: [ ] post: tags: - - plannedChangeInstances - summary: Add a planned change instance - description: Add a planned change instance. - operationId: AddPlannedChangeInstanceadd_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/AddPlannedChangeInstance' + $ref: '#/components/schemas/AddPlannedChangeInstanceMember' x-bodyName: body responses: - '200': - description: Describes planned change instances, filtered by name, id or groups that are members. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/update: - post: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/addOrUpdateFromEvents: + get: tags: - - plannedChangeInstances - summary: Update a planned change instance - description: Update a planned change instance - operationId: UpdatePlannedChangeInstanceupdate_Post - requestBody: - content: - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/UpdatePlannedChangeInstance' - x-bodyName: body + - plannedChangeInstances + summary: A request to add a new planned change and planned change instance based on the given events. + description: A request to add a new planned change and planned change instance based on the given events. + operationId: AddOrUpdatePlannedChangeInstanceFromEventsaddOrUpdateFromEvents_Get + parameters: + - name: AllEventsSelected + in: query + description: Indicates that the All Events option has been selected. + schema: + type: boolean + x-nullable: false + - name: EventsQuery + in: query + description: Specifies the events query criteria which is a requirement when AllEventsSelected is true. + schema: + $ref: '#/components/schemas/GetEvents' + - name: Name + in: query + description: Specifies the name of the 'PlannedChangeDefinition' to create. + schema: + type: string + - name: UpdateExisting + in: query + description: Specifies the flag indicating whether or not we're updating an existing planned change + schema: + type: boolean + x-nullable: false + - name: UseMinimumRules + in: query + description: Specifies a value indicating whether to use the minimum possible number rules to match the items. + schema: + type: boolean + x-nullable: false + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: + type: string + - name: MemberGroups + in: query + description: Specifies the groups that are members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the devices that are explicit members of the planned change. Optional. + style: form + schema: + type: array + items: + type: string + - name: ReconsiderEventsFromUtc + in: query + description: Specifies the UTC time to reconsider matching events from. If null no events are reprocessed. + schema: + type: string + format: date-time + - name: RuleBuilderItems + in: query + description: Specifies the events that make up the initial filter rules of the new 'PlannedChangeInstance'. The matching 'PlannedChangeFilterRuleInferenceOptions' provide details about how the event filter rule is to be constructed. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/RuleBuilderItem' + - name: PreviewOnly + in: query + description: Specifies a value indicating whether to preview the settings for the resulting 'PlannedChangeInstance' or to really created it + schema: + type: boolean + x-nullable: false + - name: EndDateUtc + in: query + description: Specifies the UTC end date for the new PlannedChangeInstance. If this is null the PlannedChangeInstance is open-ended. + schema: + type: string + format: date-time + - name: Origin + in: query + description: 'Specifies the origin of the planned change. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when creates by sync service.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: 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/AddOrUpdatePlannedChangeInstanceFromEventsResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/clone: + - Bearer: [ ] post: tags: - - plannedChangeInstances - summary: Clone a planned change instance - description: Clone a planned change instance. - operationId: ClonePlannedChangeInstanceclone_Post + - 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/ClonePlannedChangeInstance' + $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEvents' 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/AddOrUpdatePlannedChangeInstanceFromEventsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/nameValue: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances/reevaluateEvents: 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 + - plannedChangeInstances + summary: A request to re-evaluate the events associated with the specified planned change. + description: A request to re-evaluate the events associated with the specified planned change. + operationId: AddReEvaluationOfPlannedChangeInstanceEventsreevaluateEvents_Get parameters: - - name: 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: + - name: InstanceId + in: query + description: Specifies the id for a specific ScheduledInstance of a ScheduledReportItem report. + required: true + schema: type: string - - name: MemberAgentDeviceIds - in: query - description: Specifies the ids of member devices. - style: form - schema: - type: array - items: + - 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 - - 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: + 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 - 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 + format: date-time + - name: PlannedChangeManual + in: query + description: Indicates whether to further restrict the event query to events that were either added to the planned change manually or not (i.e. were added by a rule) + schema: + type: boolean + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: - '200': - description: Describes planned change instances, filtered by name, id or groups that are members. + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/GetPlannedChangeInstancesNameValueResponse' + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/addMembers: + - Bearer: [ ] post: tags: - - plannedChangeInstances - summary: Add a list of groups to a planned change - description: Add a list of groups to a planned change - operationId: AddPlannedChangeInstanceMemberaddMembers_Post + - 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/AddPlannedChangeInstanceMember' + $ref: '#/components/schemas/AddReEvaluationOfPlannedChangeInstanceEvents' x-bodyName: body responses: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/addOrUpdateFromEvents: - post: + - $ref: '#/components/parameters/Accept' + /plannedChangeInstances: + 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 + - plannedChangeInstances + summary: 'Gets planned change instances, filtering by name, id or groups that are members.' + description: 'Gets planned change instances, filtering by name, id or groups that are members.' + operationId: GetPlannedChangeInstances_Get + parameters: + - name: InstanceIds + in: query + description: Specifies the instance id. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberGroups + in: query + description: Specifies the member groups to filter by. This is a list of groups that are members of the planned changes instances returned. Optional. + style: form + schema: + type: array + items: + type: string + - name: MemberAgentDeviceIds + in: query + description: Specifies the ids of member devices. + style: form + schema: + type: array + items: + type: string + - name: Description + in: query + description: Specifies the planned change instance description to find. Optional. + schema: + type: string + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name to find instances of. Optional. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the planned change display name to find instances of. Optional. + schema: + type: string + - name: DisplayNameContains + in: query + description: Specifies the planned change instance name fragment to find. Optional. + schema: + type: string + - name: ExcludeDisabled + in: query + description: 'Specifies a value indicating whether to exclude disabled instances from the list. Optional, defaults to false.' + schema: + type: boolean + x-nullable: false + - name: ExcludeOutOfSchedule + in: query + description: 'Specifies a value indicating whether to exclude instances whose schedule is not currently active from the list. Optional, defaults to false.' + schema: + type: boolean + x-nullable: false + - name: DisallowRules + in: query + description: Specifies an optional value indicating whether the planned change instances returned are allowed to have rules. + schema: + type: boolean + - name: OmitPlannedChangeDefinitions + in: query + description: 'Specifies an optional value indicating whether to omit returning the PlannedChangeDefinition on the returned PlannedChangeInstance, useful if you only want a list of instances without the potentially large definitions embedded.' + schema: + type: boolean + x-nullable: false + - name: StartDateUtc + in: query + description: Gets or sets the Date/Time of the start date UTC of the Planned Changes to be returned. + schema: + type: string + format: date-time + - name: EndDateUtc + in: query + description: Gets or sets the Date/Time of the end date UTC of the Planned Changes to be returned. + schema: + type: string + format: date-time + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: Success + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: application/json: schema: - $ref: '#/components/schemas/AddOrUpdatePlannedChangeInstanceFromEventsResponse' + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances/reevaluateEvents: + - Bearer: [ ] post: tags: - - plannedChangeInstances - summary: A request to re-evaluate the events associated with the specified planned change - description: A request to re-evaluate the events associated with the specified planned change. - operationId: AddReEvaluationOfPlannedChangeInstanceEventsreevaluateEvents_Post + - 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/AddReEvaluationOfPlannedChangeInstanceEvents' + $ref: '#/components/schemas/GetPlannedChangeInstances' x-bodyName: body responses: - '204': - description: No Content + '200': + description: 'Describes planned change instances, filtered by name, id or groups that are members.' content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /plannedChangeInstances: + - $ref: '#/components/parameters/Accept' + /plannedChanges/add: 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 + - plannedChanges + summary: Add a planned change definition. + description: Add a planned change definition. + operationId: AddPlannedChangeadd_Get parameters: - - name: InstanceIds - in: query - description: Specifies the instance id. Optional. - style: form - schema: - type: array - items: + - name: Version + in: query + description: '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: 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: + - name: DisplayName + in: query + description: Specifies the display name. + schema: type: string - - name: MemberAgentDeviceIds - in: query - description: Specifies the ids of member devices. - style: form - schema: - type: array - items: + - name: Description + in: query + description: Specifies the description text. + schema: 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: + - 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 - 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: CreationDateUtc + in: query + description: Specifies the UTC creation date of the planned change. + schema: + type: string + format: date-time + x-nullable: false + - name: LastModifiedDateUtc + in: query + description: Specifies the UTC last modified date of the planned change. + schema: + type: string + format: date-time + x-nullable: false + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + schema: + type: boolean + x-nullable: false + - name: Rules + in: query + description: Specifies the dictionary of 'PlannedChangeRule.Id' to 'PlannedChangeRule' rules. + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + - name: RuleCombinationOperator + in: query + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the'Rules'. + schema: + enum: + - And + - Or + - LogicExpression + type: string + x-nullable: false responses: '200': - description: Describes planned change instances, filtered by name, id or groups that are members. + description: Specifies returned a planned change definitions. content: application/json: schema: - $ref: '#/components/schemas/GetPlannedChangesInstancesResponse' + $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/add: + - Bearer: [ ] post: tags: - - plannedChanges - summary: Add a planned change definition + - plannedChanges + summary: Add a planned change definition. description: Add a planned change definition. operationId: AddPlannedChangeadd_Post requestBody: @@ -6099,13 +9404,13 @@ paths: schema: $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/upload: post: tags: - - plannedChanges + - plannedChanges summary: Upload a planned change ruleset json file description: Upload a planned change ruleset json file operationId: UploadPlannedChangeupload_Post @@ -6119,43 +9424,43 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/download: get: tags: - - plannedChanges + - plannedChanges summary: Download a planned change ruleset json file description: Download a planned change ruleset json file operationId: DownloadPlannedChangedownload_Get parameters: - - name: Id - in: query - description: Specifies the planned change rule set id - schema: - type: string - - name: IncludeAttributeRuleList - in: query - description: Specifies whether to return the List property for attribute list rules. Defaults to false. - schema: - type: boolean - x-nullable: false - - name: IncludeAttributeRuleText - in: query - description: Specifies whether to return the list in the MatchText property for attribute list rules. Defaults to true. - schema: - type: boolean - x-nullable: false - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: Id + in: query + description: Specifies the planned change rule set id + schema: + type: string + - name: IncludeAttributeRuleList + in: query + description: Specifies whether to return the List property for attribute list rules. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: IncludeAttributeRuleText + in: query + description: Specifies whether to return the list in the MatchText property for attribute list rules. Defaults to true. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': description: Success @@ -6164,10 +9469,10 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - plannedChanges + - plannedChanges summary: Download a planned change ruleset json file description: Download a planned change ruleset json file operationId: DownloadPlannedChangedownload_Post @@ -6185,13 +9490,75 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/update: + get: + tags: + - plannedChanges + summary: Update a planned change definition + description: Update a planned change definition + operationId: UpdatePlannedChangeupdate_Get + parameters: + - name: Name + in: query + description: Specifies the internal Name identifying the planned change. This cannot be updated. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name. + schema: + type: string + - name: Description + in: query + description: Specifies the description text. + schema: + type: string + - name: RuleCombinationOperator + in: query + description: Specifies the rule combination operator. If this is And it means an event must satisfy all the 'PlannedChangeDefinition.Rules'. + schema: + type: string + - name: DisallowRules + in: query + description: 'Specifies a value indicating whether the planned change is allowed to have rules, or is a just container for manually added events.' + schema: + type: boolean + - name: Rules + in: query + description: Specifies the dictionary of 'PlannedChangeRule.Id' to 'PlannedChangeRule' rules. + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + - name: Origin + in: query + description: 'Specifies the origin of the planned change update. Optional, this can be ''Interactive'' for UI created, or the name of an ITSM instance when updated by sync service.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] post: tags: - - plannedChanges + - plannedChanges summary: Update a planned change definition description: Update a planned change definition operationId: UpdatePlannedChangeupdate_Post @@ -6209,14 +9576,42 @@ paths: schema: $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/clone: + get: + tags: + - plannedChanges + summary: Clone a planned change definition. + description: Clone a planned change definition. + operationId: ClonePlannedChangeclone_Get + parameters: + - name: Name + in: query + description: Specifies the internal Name identifying the planned change to clone. This cannot be updated. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] post: tags: - - plannedChanges - summary: Clone a planned change definition + - plannedChanges + summary: Clone a planned change definition. description: Clone a planned change definition. operationId: ClonePlannedChangeclone_Post requestBody: @@ -6233,15 +9628,51 @@ paths: schema: $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/analyze: + get: + tags: + - plannedChanges + summary: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + description: 'Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change.' + operationId: AnalyzePlannedChangeanalyze_Get + parameters: + - name: Name + in: query + description: Specifies the planned change Name. This cannot be updated. + schema: + type: string + - name: ReduceRuleIds + in: query + description: Specifies the list of rule ids to be automatically reduced to the minimum set to catch at least the same events. For example two exact name matches of files in the same directory will be reduced to one rule that matches any file in the directory. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyzePlannedChangeResponse' + security: + - Bearer: [ ] post: tags: - - plannedChanges - summary: Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change. - description: Create rule reduction plans, which can be used to simplify rulesets associated with the specified planned change. + - 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: @@ -6257,15 +9688,54 @@ paths: schema: $ref: '#/components/schemas/AnalyzePlannedChangeResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/applyPlan: + get: + tags: + - plannedChanges + summary: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + description: 'Apply rule reduction plans to the specified planned change, simplifying the associated rulesets.' + operationId: ApplyPlannedChangePlanapplyPlan_Get + parameters: + - name: Name + in: query + description: Specifies the planned change Name. This cannot be updated. + schema: + type: string + - name: RuleIdsToRemove + in: query + description: Specifies the rule ids to remove. + style: form + schema: + type: array + items: + type: string + - name: RuleReductionPlan + in: query + description: Specifies the rule reduction plan. + schema: + $ref: '#/components/schemas/RuleReductionPlan2' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - plannedChanges - summary: Apply rule reduction plans to the specified planned change, simplifying the associated rulesets. - description: Apply rule reduction plans to the specified planned change, simplifying the associated rulesets. + - 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: @@ -6277,15 +9747,36 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/updateRule: + get: + tags: + - plannedChanges + summary: Updates a rule in a planned change + description: Updates a rule in a planned change + operationId: UpdatePlannedChangeRuleupdateRule_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - plannedChanges + - plannedChanges summary: Updates a rule in a planned change description: Updates a rule in a planned change operationId: UpdatePlannedChangeRuleupdateRule_Post @@ -6299,15 +9790,53 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/updateRules: + get: + tags: + - plannedChanges + summary: Updates the entire rule set in a planned change + description: Updates the entire rule set in a planned change + operationId: UpdatePlannedChangeRulesupdateRules_Get + parameters: + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name. + schema: + type: string + - name: Rules + in: query + description: Specifies the dictionary of 'PlannedChangeRule.Id' to 'PlannedChangeRule' rules. + schema: + title: 'Dictionary' + type: object + additionalProperties: + $ref: '#/components/schemas/PlannedChangeRule' + description: 'Dictionary' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: A named Planned Change definition. + content: + application/json: + schema: + $ref: '#/components/schemas/PlannedChangeDefinition' + deprecated: true + security: + - Bearer: [ ] post: tags: - - plannedChanges + - plannedChanges summary: Updates the entire rule set in a planned change description: Updates the entire rule set in a planned change operationId: UpdatePlannedChangeRulesupdateRules_Post @@ -6318,21 +9847,52 @@ paths: $ref: '#/components/schemas/UpdatePlannedChangeRules' x-bodyName: body responses: - '200': - description: A named Planned Change definition. + '200': + description: A named Planned Change definition. + content: + application/json: + schema: + $ref: '#/components/schemas/PlannedChangeDefinition' + deprecated: true + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /plannedChanges/deleteRule: + get: + tags: + - plannedChanges + summary: Removes a rule from a planned change + description: Removes a rule from a planned change + operationId: DeletePlannedChangeRuledeleteRule_Get + parameters: + - name: PlannedChangeName + in: query + description: Specifies the planned change definition name. + schema: + type: string + - name: Id + in: query + description: Specifies the rule id. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/PlannedChangeDefinition' - deprecated: true + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /plannedChanges/deleteRule: + - Bearer: [ ] post: tags: - - plannedChanges + - plannedChanges summary: Removes a rule from a planned change description: Removes a rule from a planned change operationId: DeletePlannedChangeRuledeleteRule_Post @@ -6346,16 +9906,42 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges/delete: + get: + tags: + - plannedChanges + summary: Delete a planned change ruleset definition from the system. + description: Delete a planned change ruleset definition from the system. + operationId: DeletePlannedChangedelete_Get + parameters: + - name: Name + in: query + description: Specifies the planned change ruleset definition name to remove. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - plannedChanges - summary: Delete a planned change ruleset definition from the system + - 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: @@ -6368,15 +9954,48 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChangeRule/add: + get: + tags: + - plannedChangeRule + summary: Add a rule to a planned change + description: Add a rule to a planned change + operationId: AddPlannedChangeRuleadd_Get + parameters: + - name: PlannedChangeName + in: query + description: Specifies the name of the planned change to which the new rule will be added. + schema: + type: string + - name: Rule + in: query + description: Specifies the new rule being added. + schema: + $ref: '#/components/schemas/PlannedChangeRule' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The id of the new item created. + content: + application/json: + schema: + $ref: '#/components/schemas/NewId' + security: + - Bearer: [ ] post: tags: - - plannedChangeRule + - plannedChangeRule summary: Add a rule to a planned change description: Add a rule to a planned change operationId: AddPlannedChangeRuleadd_Post @@ -6394,84 +10013,105 @@ paths: schema: $ref: '#/components/schemas/NewId' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /plannedChanges: get: tags: - - plannedChanges - summary: Gets a list of planned change ruleset definitions, filtered by name or id. - description: Gets a list of planned change ruleset definitions, filtered by name or id. + - plannedChanges + summary: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + description: 'Gets a list of planned change ruleset definitions, filtered by name or id.' operationId: GetPlannedChanges_Get parameters: - - name: Name - in: query - description: Specifies the planned change definition name to find. - schema: - type: string - - name: DisplayName - in: query - description: Specifies the planned change display name to find. - schema: - type: string - - name: DisplayNameContains - in: query - description: Specifies the partial planned change display name to find. - schema: - type: string - - name: DisallowRules - in: query - description: Specifies an optional value indicating whether the planned changes returned are allowed to have rules. - schema: - type: boolean - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - name: Name + in: query + description: Specifies the planned change definition name to find. + schema: 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: DisplayName + in: query + description: Specifies the planned change display name to find. + schema: + type: string + - name: DisplayNameContains + in: query + description: Specifies the partial planned change display name to find. + schema: + type: string + - name: DisallowRules + in: query + description: Specifies an optional value indicating whether the planned changes returned are allowed to have rules. + schema: + type: boolean + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Specifies returned a planned change definitions. + content: + application/json: + schema: + $ref: '#/components/schemas/GetPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - plannedChanges + summary: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + description: 'Gets a list of planned change ruleset definitions, filtered by name or id.' + operationId: GetPlannedChanges_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPlannedChanges' + x-bodyName: body responses: '200': description: Specifies returned a planned change definitions. @@ -6480,15 +10120,46 @@ paths: schema: $ref: '#/components/schemas/GetPlannedChangesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/parse: + get: + tags: + - commandParser + summary: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + description: 'Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure.' + operationId: ParseCommandsparse_Get + parameters: + - name: CommandLines + in: query + description: Specifies the command line + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ParseCommandResponse' + security: + - Bearer: [ ] post: tags: - - commandParser - summary: Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure. - description: Attempts to parse the supplied commandline, returning a list of disallowed command fragments on failure. + - 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: @@ -6504,24 +10175,24 @@ paths: schema: $ref: '#/components/schemas/ParseCommandResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/whitelist: get: tags: - - commandParser - summary: Gets the whitelisted command component + - 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 + - name: Version + in: query + description: 'Specifies the request 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. @@ -6530,11 +10201,11 @@ paths: schema: $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - commandParser - summary: Attempts to whitelist the supplied command component + - commandParser + summary: Attempts to whitelist the supplied command component. description: Attempts to whitelist the supplied command component. operationId: CreateWhitelistedCommandComponentwhitelist_Post requestBody: @@ -6551,64 +10222,64 @@ paths: schema: $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/whitelist/all: get: tags: - - commandParser - summary: Attempts to get all the whitelisted command components + - commandParser + summary: Attempts to get all the whitelisted command components. description: Attempts to get all the whitelisted command components. operationId: GetAllWhitelistedCommandComponentswhitelistall_Get parameters: - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - 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 - 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. @@ -6617,14 +10288,14 @@ paths: schema: $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/whitelist/update: post: tags: - - commandParser - summary: Attempts to update the supplied command component by id + - 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: @@ -6641,14 +10312,14 @@ paths: schema: $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/whitelist/updateMany: post: tags: - - commandParser - summary: Attempts to bulk update the whitelisted command component with the supplied ids + - 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: @@ -6665,14 +10336,14 @@ paths: schema: $ref: '#/components/schemas/WhitelistCommandComponentResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/commandComponent/addTemplates: post: tags: - - commandParser - summary: Adds the given template(s) to a command component + - 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: @@ -6689,14 +10360,14 @@ paths: schema: $ref: '#/components/schemas/CommandComponentTemplateResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/commandComponent/removeTemplates: post: tags: - - commandParser - summary: Attempts to remove the given template(s) from a command component + - 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: @@ -6713,64 +10384,64 @@ paths: schema: $ref: '#/components/schemas/CommandComponentTemplateResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/commandComponent/templates: get: tags: - - commandParser - summary: Gets all templates of a command component + - 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: + - 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 - 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. @@ -6779,12 +10450,12 @@ paths: schema: $ref: '#/components/schemas/GetAllCommandComponentTemplatesResponse' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - commandParser - summary: Attempts to set the given template(s) to a command component, clearing old templates if they exist. - description: Attempts to set the given template(s) to a command component, clearing old templates if they exist. + - 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: @@ -6800,14 +10471,14 @@ paths: schema: $ref: '#/components/schemas/CommandComponentTemplateResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /commandParser/commandComponentMany/templates: post: tags: - - commandParser - summary: Gets all templates of multiple command components + - commandParser + summary: Gets all templates of multiple command components. description: Gets all templates of multiple command components. operationId: GetAllCommandComponentsTemplatescommandComponentManytemplates_Post requestBody: @@ -6824,40 +10495,40 @@ paths: schema: $ref: '#/components/schemas/GetAllCommandComponentsTemplatesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /cloudTemplate/status: get: tags: - - cloudTemplate - summary: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run + - cloudTemplate + summary: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. description: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run. operationId: GetCloudTemplateCreationStatusstatus_Get parameters: - - name: ProspectiveName - in: query - description: Specifies the prospective name of a Cloud System so that a check can be made to determine if any of the components already exist - schema: - type: string - - name: ReportSpecId - in: query - description: Specifies the id of the ReportSpecification representing this scheduled cloud report - schema: - type: string - - name: IncludeIfHidden - in: query - description: Whether or not the report associated with the ReportSpecification id will get found if it's in a hidden state - schema: - type: boolean - x-nullable: false - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: ProspectiveName + in: query + description: Specifies the prospective name of a Cloud System so that a check can be made to determine if any of the components already exist + schema: + type: string + - name: ReportSpecId + in: query + description: Specifies the id of the ReportSpecification representing this scheduled cloud report + schema: + type: string + - name: IncludeIfHidden + in: query + description: Whether or not the report associated with the ReportSpecification id will get found if it's in a hidden state + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': description: Success @@ -6866,18 +10537,122 @@ paths: schema: $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' security: - - Bearer: [] + - Bearer: [ ] post: tags: - - cloudTemplate - summary: Provide a ProspectiveName for the Cloud System or a ReportSpecId to identify the associated cloud report but never both. Gets the state of progress in the creation of a new cloud report policy. For example it may be only partially configured and require the addition of credentials before it can be run + - 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' + $ref: '#/components/schemas/GetCloudTemplateCreationStatus' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/setup: + get: + tags: + - policyTemplate + summary: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + description: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + operationId: SetupPolicyTemplatesetup_Get + parameters: + - name: PolicyTemplateName + in: query + description: Specifies the policy template name + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SetupPolicyTemplateResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplate + summary: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + description: Ensures that the specified baseline template has the required source and members groups and related scheduled compliance report configured. + operationId: SetupPolicyTemplatesetup_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SetupPolicyTemplate' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SetupPolicyTemplateResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /policyTemplate/status: + get: + tags: + - policyTemplate + summary: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + description: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + operationId: GetPolicyTemplateCreationStatusstatus_Get + parameters: + - name: PolicyTemplateName + in: query + description: Specifies the policy template name to query + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' + security: + - Bearer: [ ] + post: + tags: + - policyTemplate + summary: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + description: Gets the state of progress in the creation of a new policy. For example it may be only partially configured and require the addition of rules before it can be applied to devices. + operationId: GetPolicyTemplateCreationStatusstatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplateCreationStatus' x-bodyName: body responses: '200': @@ -6885,106 +10660,193 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetCloudTemplateCreationStatusResponse' + $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/setup: + - $ref: '#/components/parameters/Accept' + /policyTemplate/add: 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 + - policyTemplate + summary: Adds a device config template. + description: Adds a device config template. + operationId: AddPolicyTemplateadd_Get parameters: - - name: PolicyTemplateName - in: query - description: Specifies the policy template name - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: Template + in: query + description: Specifies the template. + schema: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + - name: UsageTags + in: query + description: 'Specifies the policy usages type to store on the Template e.g. Baseline, Tracking etc...' + style: form + schema: + type: array + items: + type: string + - name: ChangeComment + in: query + description: Specifies a short description of the change for auditing purposes. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': - description: Success + description: Response to a request for matching config templates. content: application/json: schema: - $ref: '#/components/schemas/SetupPolicyTemplateResponse' + $ref: '#/components/schemas/GetPolicyTemplatesResponse' security: - - Bearer: [] + - 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 + - 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/SetupPolicyTemplate' + $ref: '#/components/schemas/AddPolicyTemplate' x-bodyName: body responses: '200': - description: Success + description: Response to a request for matching config templates. content: application/json: schema: - $ref: '#/components/schemas/SetupPolicyTemplateResponse' + $ref: '#/components/schemas/GetPolicyTemplatesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/status: + - $ref: '#/components/parameters/Accept' + /policyRecent: 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 + - 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: 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 + - 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: Success + description: Response to a request for matching config templates. content: application/json: schema: - $ref: '#/components/schemas/GetPolicyTemplateCreationStatusResponse' + $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/add: + - Bearer: [ ] post: tags: - - policyTemplate - summary: Adds a device config template - description: Adds a device config template. - operationId: AddPolicyTemplateadd_Post + - policyRecent + summary: Gets the most recent policy run results for each matching policy in the time range. + description: Gets the most recent policy run results for each matching policy in the time range. + operationId: GetMostRecentPolicyResults_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/AddPolicyTemplate' + $ref: '#/components/schemas/GetMostRecentPolicyResults' x-bodyName: body responses: '200': @@ -6992,123 +10854,74 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetPolicyTemplatesResponse' + $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /policyRecent: + - $ref: '#/components/parameters/Accept' + /policyTemplate/add/rules: 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 + - policyTemplate + summary: Add a rules to a baseline policy based on events + description: Add a rules to a baseline policy based on events + operationId: AddPolicyTemplateRulesaddrules_Get parameters: - - name: 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: + - name: Name + in: query + description: Specifies the policy template name to add rules to + schema: 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: 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: Response to a request for matching config templates. + description: Success content: application/json: schema: - $ref: '#/components/schemas/GetMostRecentPolicyResultsResponse' + $ref: '#/components/schemas/AddPolicyTemplateRulesResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /policyTemplate/add/rules: + - Bearer: [ ] post: tags: - - policyTemplate + - 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 @@ -7126,14 +10939,102 @@ paths: schema: $ref: '#/components/schemas/AddPolicyTemplateRulesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /devicePolicyTemplate/add: + get: + tags: + - devicePolicyTemplate + summary: Adds a device policy template to the system. The specified template should be supplied as Xml. + description: Adds a device policy template to the system. The specified template should be supplied as Xml. + operationId: AddPolicyTemplateXmladd_Get + parameters: + - name: Name + in: query + description: Specifies the name. + schema: + type: string + - name: Xml + in: query + description: Specifies the xml. + schema: + type: string + - name: PassMark + in: query + description: Specifies the pass mark. Only relevant for 'TemplateType' of 'PolicyTemplateType.ComplianceReport'. + schema: + type: number + format: double + x-nullable: false + - name: AsCopyOf + in: query + description: Specifies as a copy of an existing template named this + schema: + type: string + - name: CopyTemplateValues + in: query + description: 'Specifies a copy of an existing template should only copy the tracking information, not the values' + schema: + type: boolean + x-nullable: false + - name: AsCopyOfVersion + in: query + description: Specifies version to copy when using AsCopyOf + schema: + type: string + - name: AdditionalUsageTags + in: query + description: 'Specifies extra UsageTagsApplicable to record against the template, in addition to those specified in the Xml' + style: form + schema: + type: array + items: + type: string + x-nullable: false + - name: OverwriteIfExists + in: query + description: Specifies a flag to indicate whether or not not overwrite the report / config if it already exists + schema: + type: boolean + x-nullable: false + - name: ExternalDataFileId + in: query + description: Specifies an external file id if the XML is not provided 'in line' + schema: + type: string + - name: IsSystem + in: query + description: Specifies a flag to indicate whether or not the template is part of the standard system set or a customized version + schema: + type: boolean + x-nullable: false + - name: IsUiUpload + in: query + description: Specifies a flag to indicate whether or not the template is has been uploaded from the UI + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to adding a device policy template to the system. + content: + application/json: + schema: + $ref: '#/components/schemas/AddPolicyTemplateResponse' + security: + - Bearer: [ ] post: tags: - - devicePolicyTemplate - summary: Adds a device policy template to the system. The specified template should be supplied as Xml + - 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: @@ -7150,14 +11051,45 @@ paths: schema: $ref: '#/components/schemas/AddPolicyTemplateResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /devicePolicyTemplate/delete: + get: + tags: + - devicePolicyTemplate + summary: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + description: Deletes a device policy template from the system. The specified template can be either config or a compliance report template. + operationId: DeletePolicyTemplatedelete_Get + parameters: + - name: Name + in: query + description: Specifies the policy template name to delete + schema: + type: string + - name: TemplateVersion + in: query + description: 'Specifies the policy template version to delete. Optional, if not supplied all versions of the template are removed.' + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - devicePolicyTemplate - summary: Deletes a device policy template from the system. The specified template can be either config or a compliance report template + - 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: @@ -7170,15 +11102,15 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /uploadPolicyTemplate: post: tags: - - uploadPolicyTemplate + - uploadPolicyTemplate summary: Upload a policy template file description: Upload a policy template file operationId: UploadPolicyTemplate_Post @@ -7196,34 +11128,55 @@ paths: schema: $ref: '#/components/schemas/UploadPolicyTemplateResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /policyTemplateAsFile: get: tags: - - policyTemplateAsFile - summary: Returns a policy template as an xml file in the Http Response stream + - 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 + - name: Name + in: query + description: Specifies the templatem name to retrieve. + schema: + type: string + - name: AgentDeviceId + in: query + description: Specifies the agent device id to get the current combined template for. Note either this or the 'Name' should be specified. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] + post: + tags: + - policyTemplateAsFile + summary: Returns a policy template as an xml file in the Http Response stream. + description: Returns a policy template as an xml file in the Http Response stream. + operationId: GetPolicyTemplateAsFile_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPolicyTemplateAsFile' + x-bodyName: body responses: '200': description: Success @@ -7232,29 +11185,50 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /agentProcesses: get: tags: - - agentProcesses - summary: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config + - agentProcesses + summary: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. description: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. operationId: GetAgentProcesses_Get parameters: - - name: AgentDevice - in: query - description: Specifies the agent/device to get the processes from - schema: - $ref: '#/components/schemas/AgentDevice' - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: AgentDevice + in: query + description: Specifies the agent/device to get the processes from + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the list of running processes on a device. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentProcessesResponse' + security: + - Bearer: [ ] + post: + tags: + - agentProcesses + summary: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + description: Get the list of running processes from a specified agent / device.Used to enable 'white-listing' if existing processes from a running agent when building device config. + operationId: GetAgentProcesses_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentProcesses' + x-bodyName: body responses: '200': description: Describes the list of running processes on a device. @@ -7263,14 +11237,52 @@ paths: schema: $ref: '#/components/schemas/GetAgentProcessesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /startAgentTracker: + get: + tags: + - startAgentTracker + summary: Ask an agent to start a specified tracker. + description: Ask an agent to start a specified tracker. + operationId: StartAgentTracker_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent the tracker will be started on. Alternative to AgentDeviceId. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: AgentDeviceId + in: query + description: Specifies the agent id the tracker will be started on. Alternative to AgentDevice. + schema: + type: string + - name: TrackerName + in: query + description: Specifies the tracker to be started + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/StartAgentTrackerResponse' + security: + - Bearer: [ ] post: tags: - - startAgentTracker - summary: Ask an agent to start a specified tracker + - startAgentTracker + summary: Ask an agent to start a specified tracker. description: Ask an agent to start a specified tracker. operationId: StartAgentTracker_Post requestBody: @@ -7287,29 +11299,50 @@ paths: schema: $ref: '#/components/schemas/StartAgentTrackerResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /agentServices: get: tags: - - agentServices - summary: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config + - agentServices + summary: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. description: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. operationId: GetAgentServices_Get parameters: - - name: AgentDevice - in: query - description: Specifies the agent/device to get the Services from - schema: - $ref: '#/components/schemas/AgentDevice' - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: AgentDevice + in: query + description: Specifies the agent/device to get the Services from + schema: + $ref: '#/components/schemas/AgentDevice' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the list of running services on a device. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentServicesResponse' + security: + - Bearer: [ ] + post: + tags: + - agentServices + summary: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + description: Get the list of running Services from a specified agent/device. Used to enable 'white - listing' if existing Service from a running agent when building device config. + operationId: GetAgentServices_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentServices' + x-bodyName: body responses: '200': description: Describes the list of running services on a device. @@ -7318,14 +11351,45 @@ paths: schema: $ref: '#/components/schemas/GetAgentServicesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /policyTemplates/activeVersion: + get: + tags: + - policyTemplates + summary: Sets a specific version of a named policy template as the active one. + description: Sets a specific version of a named policy template as the active one. + operationId: SetActivePolicyTemplateactiveVersion_Get + parameters: + - name: TemplateName + in: query + description: Specifies the template name. + schema: + type: string + - name: ActiveVersion + in: query + description: Specifies the version of the template to make active. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - policyTemplates - summary: Sets a specific version of a named policy template as the active one + - 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: @@ -7338,16 +11402,140 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /policyTemplates/update: + get: + tags: + - policyTemplates + summary: Update matching config templates. + description: Update matching config templates. + operationId: UpdatePolicyTemplatesupdate_Get + parameters: + - name: Name + in: query + description: Specifies the name (id) to search for. + schema: + type: string + - name: NameContains + in: query + description: Specifies the text the name contains. Used to search for partial match if 'Name' not specified. + schema: + type: string + - name: ReturnXml + in: query + description: Specifies a value indicating whether to return the template xml in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: ReturnSignatures + in: query + description: Specifies a value indicating whether to calculate and return the template signatures in the response. Defaults to false. + schema: + type: boolean + x-nullable: false + - name: IsActive + in: query + description: Get the Active version of a template + schema: + type: boolean + - name: IsLatest + in: query + description: Get the Latest version of a template + schema: + type: boolean + - name: HasRules + in: query + description: Get templates with Rules + schema: + type: boolean + - name: HasTrackers + in: query + description: Get templates with Trackers + schema: + type: boolean + - name: TemplateTrackerTypes + in: query + description: Specifies the template's tracker types. + style: form + schema: + type: array + items: + type: string + - name: TemplateVersion + in: query + description: Specifies the template version to get. + schema: + type: string + - name: UsageTags + in: query + description: Specifies the policy usage types to get. + style: form + schema: + type: array + items: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - policyTemplates - summary: Update matching config templates + - policyTemplates + summary: Update matching config templates. description: Update matching config templates. operationId: UpdatePolicyTemplatesupdate_Post requestBody: @@ -7360,37 +11548,58 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceConfigTemplate: get: tags: - - deviceConfigTemplate - summary: Gets a named device config template + - 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 + - name: Name + in: query + description: Specifies the template name. + schema: + type: string + - name: IncludeSystemFilters + in: query + description: Specifies a value indicating whether to include system defined filters and path match definitions. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents a named policy tracking configuration and rule-set template. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyTemplateRuleSet' + security: + - Bearer: [ ] + post: + tags: + - deviceConfigTemplate + summary: Gets a named device config template. + description: Gets a named device config template. + operationId: GetDeviceConfigTemplate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceConfigTemplate' + x-bodyName: body responses: '200': description: Represents a named policy tracking configuration and rule-set template. @@ -7399,40 +11608,64 @@ paths: schema: $ref: '#/components/schemas/PolicyTemplateRuleSet' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceConfigTemplateNames: get: tags: - - deviceConfigTemplateNames - summary: Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker). - description: Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker). + - 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 + - name: TrackersContained + in: query + description: Specifies the trackers contained. Optional. If specified this filters the returned list of template names to include only those containing the named trackers (eg 'processtracker'). + style: form + schema: + type: array + items: + type: string + - name: AgentDeviceIds + in: query + description: 'Specifies the agent devices. Optional. If specified this filters the returned list of template names to include only those currently applied to ALL the listed devices due to their group memberships, i.e. an intersection of group membership sets.' + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - deviceConfigTemplateNames + summary: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + description: 'Gets a list of device tracking template names, optionally filtering by trackers contained (e.g. find templates with a process tracker).' + operationId: GetDeviceConfigTemplateNames_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceConfigTemplateNames' + x-bodyName: body responses: '200': description: Success @@ -7444,14 +11677,48 @@ paths: items: type: string security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /addDeviceConfigProcessRules: + get: + tags: + - addDeviceConfigProcessRules + summary: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + description: Adds white/grey/black listing to process rules in the specified device tracking configuration template. + operationId: AddDeviceConfigProcessRules_Get + parameters: + - name: DeviceTemplateName + in: query + description: The name of the device tracking configuration template + schema: + type: string + - name: Rules + in: query + description: A list of all the Rules + style: form + schema: + type: array + items: + $ref: '#/components/schemas/Process' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - addDeviceConfigProcessRules - summary: Adds white/grey/black listing to process rules in the specified device tracking configuration template + - 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: @@ -7464,84 +11731,105 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupPolicy: get: tags: - - groupPolicy - summary: Get the configured config policy template for the specified group or by individual template name + - 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: + - name: GroupName + in: query + description: Specifies the group name. Optional. + schema: 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: + - 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 - 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: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to the request for configured policy templates on the group. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupPolicyResponse' + security: + - Bearer: [ ] + post: + tags: + - groupPolicy + summary: Get the configured config policy template for the specified group or by individual template name. + description: Get the configured config policy template for the specified group or by individual template name. + operationId: GetGroupPolicy_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroupPolicy' + x-bodyName: body responses: '200': description: The response to the request for configured policy templates on the group. @@ -7550,54 +11838,129 @@ paths: schema: $ref: '#/components/schemas/GetGroupPolicyResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupPolicyNames: get: tags: - - groupPolicyNames - summary: Get the configured config policy template names for the specified groups + - 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: GroupNames + in: query + description: Specifies the list of group names to get the config for + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary>' + content: + application/json: + schema: + title: 'Dictionary>' + type: object + additionalProperties: + type: array + items: + type: string + description: 'Dictionary>' + security: + - Bearer: [ ] + post: + tags: + - groupPolicyNames + summary: Get the configured config policy template names for the specified groups. + description: Get the configured config policy template names for the specified groups. + operationId: GetGroupPolicyConfigNames_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroupPolicyConfigNames' + x-bodyName: body responses: '200': - description: Dictionary> + description: 'Dictionary>' content: application/json: schema: - title: Dictionary> + title: 'Dictionary>' type: object additionalProperties: type: array items: type: string - description: Dictionary> + description: 'Dictionary>' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupPolicy/add: + get: + tags: + - groupPolicy + summary: Adds a config template to a group. + description: Adds a config template to a group. + operationId: AddGroupPolicyadd_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: GroupDisplayName + in: query + description: Specifies the group display name. + schema: + type: string + - name: PolicyTemplateName + in: query + description: Specifies the policy template name. + schema: + type: string + - name: PolicyTemplateDisplayName + in: query + description: Specifies the policy template display name. + schema: + type: string + - name: IsTrusted + in: query + description: Specifies if policy template contains trusted commands. + schema: + type: boolean + responses: + '200': + description: The response to the request to add a configured policy template to the group. + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupPolicyResponse' + security: + - Bearer: [ ] post: tags: - - groupPolicy - summary: Adds a config template to a group + - groupPolicy + summary: Adds a config template to a group. description: Adds a config template to a group. operationId: AddGroupPolicyadd_Post requestBody: @@ -7607,21 +11970,52 @@ paths: $ref: '#/components/schemas/AddGroupPolicy' x-bodyName: body responses: - '200': - description: The response to the request to add a configured policy template to the group. + '200': + description: The response to the request to add a configured policy template to the group. + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupPolicyResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groupPolicy/delete: + get: + tags: + - groupPolicy + summary: Removes a config template from a group. + description: Removes a config template from a group. + operationId: DeleteGroupPolicydelete_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name to delete the policy from. + schema: + type: string + - name: PolicyTemplateName + in: query + description: Specifies the policy template name to remove from the group. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/AddGroupPolicyResponse' + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /groupPolicy/delete: + - Bearer: [ ] post: tags: - - groupPolicy - summary: Removes a config template from a group + - groupPolicy + summary: Removes a config template from a group. description: Removes a config template from a group. operationId: DeleteGroupPolicydelete_Post requestBody: @@ -7634,16 +12028,62 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /reParentDevices: + get: + tags: + - reParentDevices + summary: Re-parents the given devices to the specified Agent. + description: Re-parents the given devices to the specified Agent. + operationId: ReParentDevices_Get + parameters: + - name: Devices + in: query + description: A list of agent device IDs to be re-parented. + style: form + schema: + type: array + items: + type: string + - name: AgentDeviceId + in: query + description: The agent device id to re-parent the devices to. + schema: + type: string + - name: MigrateEvents + in: query + description: A boolean that controls wether to migrate any 'old' events to the new agent device id combination. + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Dictionary' + content: + application/json: + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + security: + - Bearer: [ ] post: tags: - - reParentDevices - summary: Re-parents the given devices to the specified Agent + - 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: @@ -7654,24 +12094,76 @@ paths: x-bodyName: body responses: '200': - description: Dictionary + description: 'Dictionary' content: application/json: schema: - title: Dictionary + title: 'Dictionary' type: object additionalProperties: type: string - description: Dictionary + description: 'Dictionary' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /exportAgents: + get: + tags: + - exportAgents + summary: Export a list of agent details. + description: Export a list of agent details. + operationId: ExportAgents_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the device filter used to control the list of agents + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: ExportFormat + in: query + description: Specifies the export format + schema: + enum: + - Default + - Excel + - PDF + - HTML + - CSV + - JSON + - CSVXlsx + type: string + x-nullable: false + - name: ReportTitle + in: query + description: Specifies the title for the report + schema: + type: string + - name: TimeZoneId + in: query + description: Specifies the timezone id to do the export in + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] post: tags: - - exportAgents - summary: Export a list of agent details + - exportAgents + summary: Export a list of agent details. description: Export a list of agent details. operationId: ExportAgents_Post requestBody: @@ -7688,99 +12180,120 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /agentsRanked: get: tags: - - agentsRanked - summary: A request to return agents matching the device filter + - agentsRanked + summary: A request to return agents matching the device filter. description: A request to return agents matching the device filter. operationId: GetAgentsRanked_Get parameters: - - name: DeviceFilter - in: query - description: Specifies the agents to search for by id or group membership. - schema: - $ref: '#/components/schemas/DeviceFilter' - - name: GetAgentGroupDetails - in: query - description: Specifies a value indicating whether to get agent group details. - schema: - type: boolean - x-nullable: false - - name: GetRelatedCredentials - in: query - description: Specifies a value indicating whether to get related credentials. - schema: - type: boolean - x-nullable: false - - name: GetRelatedPlannedChanges - in: query - description: Specifies a value indicating whether to get related planned changes. - schema: - type: boolean - x-nullable: false - - name: GetRelatedTemplates - in: query - description: Specifies a value indicating whether to get templates applied to the returned agents. - schema: - type: boolean - x-nullable: false - - name: IncludeMasterInFilter - in: query - description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. - schema: - type: boolean - x-nullable: false - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: GetAgentGroupDetails + in: query + description: Specifies a value indicating whether to get agent group details. + schema: + type: boolean + x-nullable: false + - name: GetRelatedCredentials + in: query + description: Specifies a value indicating whether to get related credentials. + schema: + type: boolean + x-nullable: false + - name: GetRelatedPlannedChanges + in: query + description: Specifies a value indicating whether to get related planned changes. + schema: + type: boolean + x-nullable: false + - name: GetRelatedTemplates + in: query + description: Specifies a value indicating whether to get templates applied to the returned agents. + schema: + type: boolean + x-nullable: false + - name: IncludeMasterInFilter + in: query + description: Specifies a value indicating whether to include proxy master devices in filters that match a child proxied device but would not otherwise return the proxying master. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: type: string - 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 objeect for GetAgentsRanked + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentsRankedResponse' + security: + - Bearer: [ ] + post: + tags: + - agentsRanked + summary: A request to return agents matching the device filter. + description: A request to return agents matching the device filter. + operationId: GetAgentsRanked_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentsRanked' + x-bodyName: body responses: '200': description: The response objeect for GetAgentsRanked @@ -7789,79 +12302,100 @@ paths: schema: $ref: '#/components/schemas/GetAgentsRankedResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupMembers: get: tags: - - groupMembers - summary: A request to return group members matching the criteria + - 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: + - name: GroupName + in: query + description: The name of the group to query. + schema: 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: MemberType + in: query + description: Specifies the member type to return (AgentDevice or Group). + schema: + enum: + - None + - AgentDevice + - Group + type: string + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to group members request. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupMembersResponse' + security: + - Bearer: [ ] + post: + tags: + - groupMembers + summary: A request to return group members matching the criteria. + description: A request to return group members matching the criteria. + operationId: GroupMembers_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GroupMembers' + x-bodyName: body responses: '200': description: The response to group members request. @@ -7870,98 +12404,119 @@ paths: schema: $ref: '#/components/schemas/GroupMembersResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groups: get: tags: - - groups - summary: A request to return groups matching the criteria + - 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: + - name: Name + in: query + description: The internal name of the group to find. + schema: 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: + - name: DisplayName + in: query + description: The display name of the group to find. + schema: 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: DisplayNameContains + in: query + description: A fragment of the display name in the groups to find. + schema: + type: string + - name: UserName + in: query + description: The alternative user name to retrieve groups for. Note that the returned list will also be filtered by the visibility of groups the authenticated user has. + schema: + type: string + - name: MemberOf + in: query + description: 'The groups of which the returned groups must be a member. If null, members of any group can be returned, if an empty list only groups which are members of no groups (i.e. have no parent) are returned.' + style: form + schema: + type: array + items: + type: string + - name: OnlyGroupsWithUpdate + in: query + description: Gets or sets the a flag indicating whether to only return groups with an agent update scheduled. + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get groups request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsResponse' + security: + - Bearer: [ ] + post: + tags: + - groups + summary: A request to return groups matching the criteria. + description: A request to return groups matching the criteria. + operationId: GetGroups_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroups' + x-bodyName: body responses: '200': description: The response to a get groups request. @@ -7970,14 +12525,14 @@ paths: schema: $ref: '#/components/schemas/GetGroupsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupsTree: get: tags: - - groupsTree - summary: Gets a tree structure representing the groups hierarchy + - groupsTree + summary: Gets a tree structure representing the groups hierarchy. description: Gets a tree structure representing the groups hierarchy. operationId: GetGroupsTree_Get responses: @@ -7988,14 +12543,61 @@ paths: schema: $ref: '#/components/schemas/GetGroupsTreeResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /groups/delete: + - Bearer: [ ] + post: + tags: + - groupsTree + summary: Gets a tree structure representing the groups hierarchy. + description: Gets a tree structure representing the groups hierarchy. + operationId: GetGroupsTree_Post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsTree' + x-bodyName: body + responses: + '200': + description: A returned tree structure representing the groups hierarchy. + content: + application/json: + schema: + $ref: '#/components/schemas/GetGroupsTreeResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /groups/delete: + get: + tags: + - groups + summary: Represents a request to delete a group matching the criteria. + description: Represents a request to delete a group matching the criteria. + operationId: DeleteGroupdelete_Get + parameters: + - name: Name + in: query + description: Gets or sets the Group Matching Name. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - groups - summary: Represents a request to delete a group matching the criteria + - 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: @@ -8008,16 +12610,88 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groups/add: + get: + tags: + - groups + summary: Adds a new Group definition. + description: Adds a new Group definition. + operationId: AddGroupadd_Get + parameters: + - name: ParentGroupName + in: query + description: Optionally specifies a parent group for the new group. If this is not supplied the group is automatically added as a child of the root 'All Devices' group unless NoParent is set + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name of the new group + schema: + type: string + - name: GroupType + in: query + description: Specifies the type of members allowed in the new group. Can be a combination of the allowed values + required: true + schema: + enum: + - None + - UserContainer + - DeviceContainer + - GroupContainer + type: int + x-nullable: false + - name: IsSystem + in: query + description: Specifies a flag indicating if this is a 'system' group or not + schema: + type: boolean + x-nullable: false + - name: Members + in: query + description: Specifies the list of ids of 'child group' members of the new group + style: form + schema: + type: array + items: + type: string + - name: RiskScore + in: query + description: Specifies the risk score of the group. + schema: + enum: + - Undefined + - Low + - MediumLow + - Medium + - MediumHigh + - High + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents a response to adding a new group + content: + application/json: + schema: + $ref: '#/components/schemas/AddGroupResponse' + security: + - Bearer: [ ] post: tags: - - groups - summary: Adds a new Group definition + - groups + summary: Adds a new Group definition. description: Adds a new Group definition. operationId: AddGroupadd_Post requestBody: @@ -8034,14 +12708,59 @@ paths: schema: $ref: '#/components/schemas/AddGroupResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groups/update: + get: + tags: + - groups + summary: Updates a Group definition. + description: Updates a Group definition. + operationId: UpdateGroupupdate_Get + parameters: + - name: Name + in: query + description: Specifies the name of the group to update + required: true + schema: + type: string + - name: DisplayName + in: query + description: Specifies the new display name of the group + schema: + type: string + - name: Members + in: query + description: Specifies the list of 'child group' members + style: form + schema: + type: array + items: + type: string + - name: RiskScore + in: query + description: Specifies the risk score of the group + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - groups - summary: Updates a Group definition + - groups + summary: Updates a Group definition. description: Updates a Group definition. operationId: UpdateGroupupdate_Post requestBody: @@ -8054,16 +12773,45 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /devices/delete: + get: + tags: + - devices + summary: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + description: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count. + operationId: DeleteDevicesdelete_Get + parameters: + - name: AgentDeviceIds + in: query + description: 'The agent device ids to delete from their current groups, moving them to the Deleted group.' + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - devices - summary: Represents a request to delete devices matching the criteria. Note that when a device is deleted it is moved to the Deleted group and is no longer included in the licensed device count + - 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: @@ -8076,50 +12824,71 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /devices/overdue: get: tags: - - devices - summary: Gets devices that have not polled in for the specified amount of time + - devices + summary: Gets devices that have not polled in for the specified amount of time. description: Gets devices that have not polled in for the specified amount of time. operationId: GetOverdueDevicesoverdue_Get parameters: - - name: OfflineSeconds - in: query - description: Specifies the number of seconds the offline device must have been offline for. - required: true - schema: - type: integer - format: int32 - x-nullable: false - - name: MemberOfGroups - in: query - description: Specifies optional list of groups the devices must be a member of. - style: form - schema: - type: array - items: - type: string - - name: NotMemberOfGroups - in: query - description: Specifies optional list of groups the devices must not be a member of. - style: form - schema: - type: array - items: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: OfflineSeconds + in: query + description: Specifies the number of seconds the offline device must have been offline for. + required: true + schema: + type: integer + format: int32 + x-nullable: false + - name: MemberOfGroups + in: query + description: Specifies optional list of groups the devices must be a member of. + style: form + schema: + type: array + items: + type: string + - name: NotMemberOfGroups + in: query + description: Specifies optional list of groups the devices must not be a member of. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Lists devices that have not polled in for the specified amount of time. + content: + application/json: + schema: + $ref: '#/components/schemas/GetOverdueDevicesResponse' + security: + - Bearer: [ ] + post: + tags: + - devices + summary: Gets devices that have not polled in for the specified amount of time. + description: Gets devices that have not polled in for the specified amount of time. + operationId: GetOverdueDevicesoverdue_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetOverdueDevices' + x-bodyName: body responses: '200': description: Lists devices that have not polled in for the specified amount of time. @@ -8128,15 +12897,58 @@ paths: schema: $ref: '#/components/schemas/GetOverdueDevicesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /device/deletePermanently: + get: + tags: + - device + summary: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + description: 'Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + operationId: DeleteDevicePermanentlydeletePermanently_Get + parameters: + - name: AgentId + in: query + description: Specifies the id of the agent. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. + schema: + type: string + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: Response + in: query + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + security: + - Bearer: [ ] post: tags: - - device - summary: Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code. - description: Delete the specified Agent from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code. + - 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: @@ -8146,20 +12958,49 @@ paths: 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: '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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /device/reRegister: + get: + tags: + - device + summary: Represents a request to re-register a list of previously deleted devices matching the criteria. + description: Represents a request to re-register a list of previously deleted devices matching the criteria. + operationId: ReRegisterDevicereRegister_Get + parameters: + - name: AgentDeviceIds + in: query + description: Specifies the list of combined agent and device ids. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - device - summary: Represents a request to re-register a list of previously deleted devices matching the criteria + - 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: @@ -8172,17 +13013,50 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /group/deleteMembersPermanently: + get: + tags: + - group + summary: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + description: 'Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + operationId: DeleteGroupMembersPermanentlydeleteMembersPermanently_Get + parameters: + - name: GroupName + in: query + description: Specifies the group name. + schema: + type: string + - name: Response + in: query + description: The response to a previously issued challenge for this request. Without this the call will return a challenge for which the response must be supplied on a subsequently call. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The response to a request to delete a specified Agent from the system. On first call the system will issue a challenge which must be responded to and supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDevicePermanentlyResponse' + security: + - Bearer: [ ] post: tags: - - group - summary: Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code. - description: Delete all the specified group members from the system. On first call the system will issue a challenge which must be answered and the response supplied on a repetition of the initial request. Contact NNT Support, supplying the text of the challenge, in order be be issued with an authorising response code. + - 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: @@ -8192,20 +13066,48 @@ paths: 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: '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: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceFilter/add: + get: + tags: + - deviceFilter + summary: Represents a request to add a DeviceFilter. + description: Represents a request to add a DeviceFilter. + operationId: AddDeviceFilteradd_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the device filter to add. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] post: tags: - - deviceFilter - summary: Represents a request to add a DeviceFilter + - deviceFilter + summary: Represents a request to add a DeviceFilter. description: Represents a request to add a DeviceFilter. operationId: AddDeviceFilteradd_Post requestBody: @@ -8222,14 +13124,47 @@ paths: schema: $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceFilter/update: + get: + tags: + - deviceFilter + summary: Represents a request to update a DeviceFilter matching the given id. + description: Represents a request to update a DeviceFilter matching the given id. + operationId: UpdateDeviceFilterupdate_Get + parameters: + - name: Name + in: query + description: Specifies the name of the device filter to update. + schema: + type: string + - name: DeviceFilter + in: query + description: Specifies the new device filter. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] post: tags: - - deviceFilter - summary: Represents a request to update a DeviceFilter matching the given id + - 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: @@ -8246,15 +13181,43 @@ paths: schema: $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceFilter/promote: + get: + tags: + - deviceFilter + summary: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + description: 'Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn''t exist.' + operationId: PromoteDeviceFilterpromote_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the device filter. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] post: tags: - - deviceFilter - summary: Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn't exist. - description: Represents a request to bring the named filter to the head of the list, or to create it at the head of the list if it doesn't exist. + - 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: @@ -8270,112 +13233,209 @@ paths: schema: $ref: '#/components/schemas/GetDeviceFiltersResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /deviceFilter/delete: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilter/delete: + get: + tags: + - deviceFilter + summary: Represents a request to delete a DeviceFilter matching the criteria. + description: Represents a request to delete a DeviceFilter matching the criteria. + operationId: DeleteDeviceFilterdelete_Get + parameters: + - name: Name + in: query + description: Specifies the name of the device filter to delete. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + post: + tags: + - deviceFilter + summary: Represents a request to delete a DeviceFilter matching the criteria. + description: Represents a request to delete a DeviceFilter matching the criteria. + operationId: DeleteDeviceFilterdelete_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeleteDeviceFilter' + x-bodyName: body + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /deviceFilters: + get: + tags: + - deviceFilters + summary: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + description: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + operationId: GetDeviceFilters_Get + parameters: + - name: NameContains + in: query + description: Specifies text to search for in the filter Name + schema: + type: string + - name: Name + in: query + description: Specifies an exact filter Name to search for + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a get defvice filters request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceFiltersResponse' + security: + - Bearer: [ ] post: tags: - - 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 + - deviceFilters + summary: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + description: Returns a paged list of DeviceFilter definitions matching the optional name criteria. + operationId: GetDeviceFilters_Post requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DeleteDeviceFilter' + $ref: '#/components/schemas/GetDeviceFilters' x-bodyName: body 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' - /deviceFilters: + - $ref: '#/components/parameters/Accept' + /groupMembers/add: 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 + - 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: 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: + - name: GroupName + in: query + description: The internal name/id of the group to add to. + schema: 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: 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: - '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: [] - parameters: - - $ref: '#/components/parameters/Accept' - /groupMembers/add: + - Bearer: [ ] post: tags: - - groupMembers - summary: A request to add the specified Groups and Agents group members to the named group + - 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: @@ -8388,16 +13448,58 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /groupMembers/delete: + get: + tags: + - groupMembers + summary: A request to remove group or device members from the named group. + description: A request to remove group or device members from the named group. + operationId: DeleteGroupMembersdelete_Get + parameters: + - name: GroupName + in: query + description: The name of the parent group to remove from. + schema: + type: string + - name: Groups + in: query + description: The names of groups to remove from the parent. + style: form + schema: + type: array + items: + type: string + - name: AgentDeviceIds + in: query + description: The agent device ids to remove from the parent. + style: form + schema: + type: array + items: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - groupMembers - summary: A request to remove group or device members from the named group + - 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: @@ -8410,36 +13512,58 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceOnlineStatus: get: tags: - - deviceOnlineStatus + - deviceOnlineStatus summary: Gets an indication of the device's online/offline status description: Gets an indication of the device's online/offline status operationId: GetDeviceOnlineStatus_Get parameters: - - name: AgentId - in: query - description: Specifies the id of the agent. - schema: - type: string - - name: DeviceId - in: query - description: Specifies the id of the device. - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: AgentId + in: query + description: Specifies the id of the agent. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: string + security: + - Bearer: [ ] + post: + tags: + - deviceOnlineStatus + summary: Gets an indication of the device's online/offline status + description: Gets an indication of the device's online/offline status + operationId: GetDeviceOnlineStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceOnlineStatus' + x-bodyName: body responses: '200': description: Success @@ -8449,60 +13573,112 @@ paths: title: string type: string security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceSettings/update: get: tags: - - deviceSettings - summary: Gets the device settings for the device, based on the global device settings and any device specific overrides. - description: Gets the device settings for the device, based on the global device settings and any device specific overrides. + - deviceSettings + summary: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + description: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' operationId: UpdateDeviceSettingsupdate_Get parameters: - - name: AgentId - in: query - description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. - schema: - type: string - - name: DeviceId - in: query - description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. - schema: - type: string - - name: FileLiveTrackingRequiresBaselineCompletion - in: query - description: Specifies whether a full baseline must be completed before live file tracking can be started. Optional - schema: - type: boolean - - name: GroupName - in: query - description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. - schema: - type: string - - name: Version - in: query - description: Specifies the request version. If specified, this indicates the service model version the request complies with. - schema: - type: integer - format: int32 - x-nullable: false + - name: AgentId + in: query + description: Specifies the id of the agent. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: DeviceId + in: query + description: Specifies the id of the device. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: FileLiveTrackingRequiresBaselineCompletion + in: query + description: Specifies whether a full baseline must be completed before live file tracking can be started. Optional + schema: + type: boolean + - name: GroupName + in: query + description: Specifies the group name. Either AgentId and DeviceId or GroupName must be supplied. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'The device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceSettings' + security: + - Bearer: [ ] + post: + tags: + - deviceSettings + summary: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + description: 'Gets the device settings for the device, based on the global device settings and any device specific overrides.' + operationId: UpdateDeviceSettingsupdate_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UpdateDeviceSettings' + x-bodyName: body responses: '200': - description: The device settings represents the device specific options such as customised local ui password details, and tracker performance settings. + description: 'The device settings represents the device specific options such as customised local ui password details, and tracker performance settings.' content: application/json: schema: $ref: '#/components/schemas/DeviceSettings' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceCredentials/add: + get: + tags: + - deviceCredentials + summary: A request to associate named credentials with an agent. + description: A request to associate named credentials with an agent. + operationId: AddCredentialsToAgentDeviceadd_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: CredentialsKey + in: query + description: Specifies the credentials key. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - deviceCredentials - summary: A request to associate named credentials with an agent + - 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: @@ -8515,16 +13691,47 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceCredentials/delete: + get: + tags: + - deviceCredentials + summary: A request to remove named credentials from an agent. + description: A request to remove named credentials from an agent. + operationId: RemoveCredentialsFromAgentDevicedelete_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: CredentialKey + in: query + description: Specifies the credential key. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - deviceCredentials - summary: A request to remove named credentials from an agent + - 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: @@ -8537,16 +13744,47 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceName/update: + get: + tags: + - deviceName + summary: A request to update the display name of an agent. + description: A request to update the display name of an agent. + operationId: SetAgentDeviceNameupdate_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: DeviceName + in: query + description: Specifies the device name. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - deviceName - summary: A request to update the display name of an agent + - 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: @@ -8559,16 +13797,50 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /deviceHostType/update: + get: + tags: + - deviceHostType + summary: A request to update the host type of an agent. + description: A request to update the host type of an agent. + operationId: SetAgentHostTypeupdate_Get + parameters: + - name: AgentDevice + in: query + description: Specifies the agent device. + schema: + $ref: '#/components/schemas/AgentDevice' + - name: HostType + in: query + description: Specifies the device type. + schema: + enum: + - Unknown + - Unix + - Windows + - Network + - Database + - Cloud + - ESX + - Splunk + type: string + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - deviceHostType - summary: A request to update the host type of an agent + - 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: @@ -8581,16 +13853,44 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /testAgentCredentials: + get: + tags: + - testAgentCredentials + summary: Ask an agent to test the credentials for a device it is proxying. + description: Ask an agent to test the credentials for a device it is proxying. + operationId: TestAgentCredentials_Get + parameters: + - name: AgentDeviceId + in: query + description: Specifies the agent device id whose credentials are to be tested. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TestAgentCredentialsResponse' + security: + - Bearer: [ ] post: tags: - - testAgentCredentials - summary: Ask an agent to test the credentials for a device it is proxying + - 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: @@ -8607,24 +13907,48 @@ paths: schema: $ref: '#/components/schemas/TestAgentCredentialsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /ipBlocking: get: tags: - - ipBlocking - summary: Gets details of ip addresses that have been blocked + - 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] + post: + tags: + - ipBlocking + summary: Gets details of ip addresses that have been blocked. + description: Gets details of ip addresses that have been blocked. + operationId: GetIpBlocking_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetIpBlocking' + x-bodyName: body responses: '200': description: Success @@ -8636,14 +13960,52 @@ paths: items: $ref: '#/components/schemas/IpAddressBlockingStatus' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /ipBlocking/add: + get: + tags: + - ipBlocking + summary: Adds manual blocking of a specified ip address until a specified time. + description: Adds manual blocking of a specified ip address until a specified time. + operationId: AddIpBlockingadd_Get + parameters: + - name: IpAddress + in: query + description: Gets or sets the ip address. + schema: + type: string + - name: ExpiresUtc + in: query + description: Gets or sets the expiry date time in UTC. + schema: + type: string + format: date-time + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] post: tags: - - ipBlocking - summary: Adds manual blocking of a specified ip address until a specified time + - 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: @@ -8663,14 +14025,45 @@ paths: items: $ref: '#/components/schemas/IpAddressBlockingStatus' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /ipBlocking/delete: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /ipBlocking/delete: + get: + tags: + - ipBlocking + summary: Removes blocking of a specified ip address. + description: Removes blocking of a specified ip address. + operationId: DeleteIpBlockingdelete_Get + parameters: + - name: IpAddress + in: query + description: Gets or sets the ip address to remove blocking from. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/IpAddressBlockingStatus' + security: + - Bearer: [ ] post: tags: - - ipBlocking - summary: Removes blocking of a specified ip address + - ipBlocking + summary: Removes blocking of a specified ip address. description: Removes blocking of a specified ip address. operationId: DeleteIpBlockingdelete_Post requestBody: @@ -8690,14 +14083,37 @@ paths: items: $ref: '#/components/schemas/IpAddressBlockingStatus' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /discoverDevices: + get: + tags: + - discoverDevices + summary: Discovers devices to be added as proxied devices to a master device. + description: Discovers devices to be added as proxied devices to a master device. + operationId: DiscoverDevices_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoverDevicesResponse' + security: + - Bearer: [ ] post: tags: - - discoverDevices - summary: Discovers devices to be added as proxied devices to a master device + - 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: @@ -8714,14 +14130,35 @@ paths: schema: $ref: '#/components/schemas/DiscoverDevicesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /discoveredDevices: + get: + tags: + - discoveredDevices + summary: Submits discovered devices as a response to a DiscoverDevices request. + description: Submits discovered devices as a response to a DiscoverDevices request. + operationId: SubmitDiscoveredDevices_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - discoveredDevices - summary: Submits discovered devices as a response to a DiscoverDevices request + - 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: @@ -8734,16 +14171,90 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /acknowledgeEvents: + get: + tags: + - acknowledgeEvents + summary: Acknowledge a list of events as 'planned'. + description: Acknowledge a list of events as 'planned'. + operationId: AcknowledgeEvents_Get + parameters: + - name: EventIds + in: query + description: Specifies the event ids to update. + style: form + schema: + type: array + items: + type: string + - name: PlannedChangeId + in: query + description: Specifies the planned change instance id to acknowledge these events under. + schema: + type: string + - name: NewStatus + in: query + description: Specifies the new status for the alert events. + schema: + enum: + - Unknown + - NotRelevant + - Planned + - Unplanned + - UnderInvestigation + - Acknowledged + type: string + x-nullable: false + - name: DeviceFilter + in: query + description: 'Gets or sets the device selection, null implies all devices.' + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: EventFilter + in: query + description: 'Gets or sets the event selection, null implies all events.' + schema: + $ref: '#/components/schemas/EventFilter' + - name: StartUtc + in: query + description: 'Gets or sets the start of the period to return events for, null implies all.' + schema: + type: string + format: date-time + - name: EndUtc + in: query + description: 'Gets or sets the end of the period to return events for, null implies up to current time.' + schema: + type: string + format: date-time + - name: TextSearch + in: query + description: Gets or sets the text search value. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - acknowledgeEvents - summary: Acknowledge a list of events as 'planned' + - acknowledgeEvents + summary: Acknowledge a list of events as 'planned'. description: Acknowledge a list of events as 'planned'. operationId: AcknowledgeEvents_Post requestBody: @@ -8756,15 +14267,41 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /resubmitEvents: + get: + tags: + - resubmitEvents + summary: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + description: 'Re-submit the specified events (i.e for re-consideration by the pipeline re: planned changes).' + operationId: ResubmitEvents_Get + parameters: + - name: GetEvents + in: query + description: Gets or sets the event IDs to re-submit + schema: + $ref: '#/components/schemas/GetEvents' + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - resubmitEvents + - 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 @@ -8778,31 +14315,52 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /event/history/{EventId}: + - $ref: '#/components/parameters/Accept' + '/event/history/{EventId}': get: tags: - - event - summary: Get the event history for one specific event + - 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 + - name: EventId + in: query + description: Specifies the specific event id to retrieve history for. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes an event's history. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventHistoryResponse' + security: + - Bearer: [ ] + post: + tags: + - event + summary: Get the event history for one specific event. + description: Get the event history for one specific event. + operationId: GetEventHistoryhistoryEventId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEventHistory' + x-bodyName: body responses: '200': description: Describes an event's history. @@ -8811,74 +14369,95 @@ paths: schema: $ref: '#/components/schemas/GetEventHistoryResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /eventDeviceGroups: get: tags: - - eventDeviceGroups - summary: Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it. - description: Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it. + - eventDeviceGroups + summary: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + description: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' operationId: GetEventDeviceGroups_Get parameters: - - name: EventIds - in: query - description: ' Gets or sets the event ids.' - style: form - schema: - type: array - items: + - 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: 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: GroupFindMode + in: query + description: Gets or sets how the returned group list is built. + schema: + enum: + - GroupFindFromAgents + - GroupFindFromEvents + type: string + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Represents the list of groups that the devices associated with the given events are members of. + content: + application/json: + schema: + $ref: '#/components/schemas/GetEventDeviceGroupsResponse' + security: + - Bearer: [ ] + post: + tags: + - eventDeviceGroups + summary: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + description: 'Gets the list of groups that the devices associated with the given events are members of. If Intersection is true, only the groups of which all devices are a member are returned. This function is used to determine the possible groups to associate a new planned change with, such that the events will be covered by it.' + operationId: GetEventDeviceGroups_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetEventDeviceGroups' + x-bodyName: body responses: '200': description: Represents the list of groups that the devices associated with the given events are members of. @@ -8887,13 +14466,44 @@ paths: schema: $ref: '#/components/schemas/GetEventDeviceGroupsResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /setCommentsForEvents: + get: + tags: + - setCommentsForEvents + summary: Set comments for events + description: Set comments for events + operationId: SetCommentForEvents_Get + parameters: + - name: GetEvents + in: query + description: Event filter to specify the events to set the comment for + schema: + $ref: '#/components/schemas/GetEvents' + - name: Comment + in: query + description: The comment + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - setCommentsForEvents + - setCommentsForEvents summary: Set comments for events description: Set comments for events operationId: SetCommentForEvents_Post @@ -8907,66 +14517,87 @@ paths: '204': description: No Content content: - application/json: {} + application/json: { } security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory: get: tags: - - inventory - summary: Retrieves a list of inventory items from the hub service + - 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: + - 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 - 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. + content: + application/json: + schema: + $ref: '#/components/schemas/GetInventoryResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: Retrieves a list of inventory items from the hub service. + description: Retrieves a list of inventory items from the hub service. + operationId: GetInventory_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetInventory' + x-bodyName: body responses: '200': description: The paging response base. @@ -8975,140 +14606,182 @@ paths: schema: $ref: '#/components/schemas/GetInventoryResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /agentInventoryGrouped: get: tags: - - agentInventoryGrouped - summary: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service + - 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: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + security: + - Bearer: [ ] + post: + tags: + - agentInventoryGrouped + summary: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + description: Retrieves a list of agent inventory items grouped by their inventory item ids from the hub service. + operationId: GetAgentInventoryItemsGrouped_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentInventoryItemsGrouped' + x-bodyName: body + responses: + '200': + description: The paging response base. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /agentInventoryAgentsDetail: + get: + tags: + - agentInventoryAgentsDetail + summary: Retrieves a list of agents with a specific inventory item id from the hub service. + description: Retrieves a list of agents with a specific inventory item id from the hub service. + operationId: GetAgentInventoryAgentsDetail_Get + parameters: + - name: DeviceFilter + in: query + description: Specifies the agents to search for by id or group membership. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: type: string - 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. content: application/json: schema: - $ref: '#/components/schemas/GetAgentInventoryItemsGroupedResponse' + $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /agentInventoryAgentsDetail: - get: + - Bearer: [ ] + post: tags: - - agentInventoryAgentsDetail - summary: Retrieves a list of agents with a specific inventory item id from the hub service + - 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 + operationId: GetAgentInventoryAgentsDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAgentInventoryAgentsDetail' + x-bodyName: body responses: '200': description: The paging response base. @@ -9117,88 +14790,109 @@ paths: schema: $ref: '#/components/schemas/GetAgentInventoryAgentsDetailResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/vulnerabilityOverview: get: tags: - - inventory - summary: A request to return the vulnerability overview matching the device filter + - 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: + - 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 - 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 + format: date-time + x-nullable: false + - name: ShowIgnored + in: query + description: Specifies whether to include excluded/suppressed Cves in the overview statistics. + schema: + type: boolean + x-nullable: false + - name: GetStatus + in: query + description: Get the vulnerability scanner status as well + schema: + type: boolean + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetVulnerabilityOverview + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityOverviewResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the vulnerability overview matching the device filter. + description: A request to return the vulnerability overview matching the device filter. + operationId: GetVulnerabilityOverviewvulnerabilityOverview_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerabilityOverview' + x-bodyName: body responses: '200': description: The response object for GetVulnerabilityOverview @@ -9207,69 +14901,90 @@ paths: schema: $ref: '#/components/schemas/GetVulnerabilityOverviewResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/vulnerabilities: get: tags: - - inventory - summary: A request to return the vulnerabilities in an estate matching the device and vulnerability filters + - 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: + - 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 - 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 GetVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + description: A request to return the vulnerabilities in an estate matching the device and vulnerability filters. + operationId: GetVulnerabilityvulnerabilities_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerability' + x-bodyName: body responses: '200': description: The response object for GetVulnerability @@ -9278,76 +14993,97 @@ paths: schema: $ref: '#/components/schemas/GetVulnerabilityResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/softwareVulnerability: get: tags: - - inventory - summary: A request to return the software vulnerability matching the device filter + - 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: + - 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 - 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 + format: date-time + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetSoftwareVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the software vulnerability matching the device filter. + description: A request to return the software vulnerability matching the device filter. + operationId: GetSoftwareVulnerabilitysoftwareVulnerability_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerability' + x-bodyName: body responses: '200': description: The response object for GetSoftwareVulnerability @@ -9356,14 +15092,37 @@ paths: schema: $ref: '#/components/schemas/GetSoftwareVulnerabilityResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/update: + get: + tags: + - inventory + summary: Marks an inventory item a requiring an update / refresh. + description: Marks an inventory item a requiring an update / refresh. + operationId: MarkInventoryItemsRequiringUpdateupdate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] post: tags: - - inventory - summary: Marks an inventory item a requiring an update / refresh + - 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: @@ -9380,74 +15139,95 @@ paths: schema: $ref: '#/components/schemas/Object' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/softwareVulnerabilityDetail: get: tags: - - inventory - summary: A request to return the software vulnerability matching the device filter + - inventory + summary: A request to return the software vulnerability matching the device filter. description: A request to return the software vulnerability matching the device filter. operationId: GetSoftwareVulnerabilityDetailsoftwareVulnerabilityDetail_Get parameters: - - name: SoftwareId - in: query - description: Specifies the software item to search for. - schema: - type: string - - name: CpeName - in: query - description: Specifies the CPE Name to search for. - schema: - type: string - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - name: SoftwareId + in: query + description: Specifies the software item to search for. + schema: 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: CpeName + in: query + description: Specifies the CPE Name to search for. + schema: + type: string + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetSoftwareVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the software vulnerability matching the device filter. + description: A request to return the software vulnerability matching the device filter. + operationId: GetSoftwareVulnerabilityDetailsoftwareVulnerabilityDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetSoftwareVulnerabilityDetail' + x-bodyName: body responses: '200': description: The response object for GetSoftwareVulnerabilityDetail @@ -9456,76 +15236,97 @@ paths: schema: $ref: '#/components/schemas/GetSoftwareVulnerabilityDetailResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/deviceVulnerability: get: tags: - - inventory - summary: A request to return the device vulnerability matching the device filter + - inventory + summary: A request to return the device vulnerability matching the device filter. description: A request to return the device vulnerability matching the device filter. operationId: GetDeviceVulnerabilitydeviceVulnerability_Get parameters: - - name: DeviceFilter - in: query - description: Specifies the agents to search for by id or group membership. - schema: - $ref: '#/components/schemas/DeviceFilter' - - name: StartDateUtc - in: query - description: Specifies the Utc start date from which the vulnerability changes are retrieved. - schema: - type: string - format: date-time - x-nullable: false - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - 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 - 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 + format: date-time + x-nullable: false + - name: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetDeviceVulnerability + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the device vulnerability matching the device filter. + description: A request to return the device vulnerability matching the device filter. + operationId: GetDeviceVulnerabilitydeviceVulnerability_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceVulnerability' + x-bodyName: body responses: '200': description: The response object for GetDeviceVulnerability @@ -9534,69 +15335,90 @@ paths: schema: $ref: '#/components/schemas/GetDeviceVulnerabilityResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/deviceVulnerabilityDetail: get: tags: - - inventory - summary: A request to return the device vulnerability matching the device filter + - inventory + summary: A request to return the device vulnerability matching the device filter. description: A request to return the device vulnerability matching the device filter. operationId: GetDeviceVulnerabilityDetaildeviceVulnerabilityDetail_Get parameters: - - name: AgentDeviceId - in: query - description: Specifies the agents to search for by id or group membership. - schema: - type: string - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - name: AgentDeviceId + in: query + description: Specifies the agents to search for by id or group membership. + schema: 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: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetDeviceVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the device vulnerability matching the device filter. + description: A request to return the device vulnerability matching the device filter. + operationId: GetDeviceVulnerabilityDetaildeviceVulnerabilityDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDeviceVulnerabilityDetail' + x-bodyName: body responses: '200': description: The response object for GetDeviceVulnerabilityDetail @@ -9605,40 +15427,85 @@ paths: schema: $ref: '#/components/schemas/GetDeviceVulnerabilityDetailResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/relatedSoftwareVulnerabilityDetail: get: tags: - - inventory + - 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 + - name: CpeName + in: query + schema: + type: string + - name: InventoryItemId + in: query + schema: + type: string + - name: MaxItemsToReturn + in: query + schema: + type: integer + format: int32 + x-nullable: false + - name: ReturnFullCveData + in: query + schema: + type: boolean + x-nullable: false + - name: VulnerabilityFilter + in: query + schema: + type: string + responses: + '200': + description: The response object for GetCvesForRelatedCpes + content: + application/json: + schema: + $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + description: Get a list of CVEs that are related to the specified CPE but not directly (e.g previous versions etc) + operationId: GetCvesForRelatedCpesrelatedSoftwareVulnerabilityDetail_Post + parameters: + - name: CpeName + in: query + schema: + type: string + - name: InventoryItemId + in: query + schema: + type: string + - name: MaxItemsToReturn + in: query + schema: + type: integer + format: int32 + x-nullable: false + - name: ReturnFullCveData + in: query + schema: + type: boolean + x-nullable: false + - name: VulnerabilityFilter + in: query + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetCvesForRelatedCpes' + x-bodyName: body responses: '200': description: The response object for GetCvesForRelatedCpes @@ -9647,69 +15514,90 @@ paths: schema: $ref: '#/components/schemas/GetCvesForRelatedCpesResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/vulnerableDeviceDetail: get: tags: - - inventory - summary: A request to return the vulnerable devices matching the CVE + - inventory + summary: A request to return the vulnerable devices matching the CVE. description: A request to return the vulnerable devices matching the CVE. operationId: GetVulnerableDeviceDetailvulnerableDeviceDetail_Get parameters: - - name: CveId - in: query - description: Specifies the cve to search for vulnerable devices. - schema: - type: string - - name: CountOnly - in: query - description: A value indicating whether to return a count of results only. - schema: - type: boolean - x-nullable: false - - name: Sort - in: query - description: The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC". - schema: - title: Dictionary - type: object - additionalProperties: + - name: CveId + in: query + description: Specifies the cve to search for vulnerable devices. + schema: 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: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response object for GetDeviceVulnerabilityDetail + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerableDeviceDetailResponse' + security: + - Bearer: [ ] + post: + tags: + - inventory + summary: A request to return the vulnerable devices matching the CVE. + description: A request to return the vulnerable devices matching the CVE. + operationId: GetVulnerableDeviceDetailvulnerableDeviceDetail_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerableDeviceDetail' + x-bodyName: body responses: '200': description: The response object for GetDeviceVulnerabilityDetail @@ -9718,14 +15606,37 @@ paths: schema: $ref: '#/components/schemas/GetVulnerableDeviceDetailResponse' security: - - Bearer: [] + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' /inventory/ignoreCves: + get: + tags: + - inventory + summary: A request to ignore one or more Cves until a given data. + description: A request to ignore one or more Cves until a given data. + operationId: IgnoreCveItemignoreCves_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + security: + - Bearer: [ ] post: tags: - - inventory - summary: A request to ignore one or more Cves until a given data + - 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: @@ -9742,64 +15653,85 @@ 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: + - 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 - 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 GetVulnerabilityStatus + content: + application/json: + schema: + $ref: '#/components/schemas/GetVulnerabilityScanStatusResponse' + security: + - Bearer: [ ] + post: + tags: + - vulnerabilityscanstatus + summary: A request to return the software vulnerability scan status. + description: A request to return the software vulnerability scan status. + operationId: GetVulnerabilityScanStatus_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetVulnerabilityScanStatus' + x-bodyName: body responses: '200': description: The response object for GetVulnerabilityStatus @@ -9808,13 +15740,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 @@ -9826,23 +15758,44 @@ paths: schema: $ref: '#/components/schemas/GetAllLog4NetConfigItemsResponse' security: - - Bearer: [] + - Bearer: [ ] + post: + tags: + - log4netConfigs + summary: Retrieves a list of log4net logger configurations + description: Retrieves a list of log4net logger configurations + operationId: GetAllLog4NetConfigItemsall_Post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllLog4NetConfigItems' + x-bodyName: body + responses: + '200': + description: Response for getting log4net configuration items + content: + application/json: + schema: + $ref: '#/components/schemas/GetAllLog4NetConfigItemsResponse' + security: + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' + - $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: @@ -9857,27 +15810,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 + - 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: @@ -9892,19 +15845,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: @@ -9919,64 +15872,85 @@ 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: + - 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 - 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: Response for getting log4net configuration items with pagination support + content: + application/json: + schema: + $ref: '#/components/schemas/GetLog4NetConfigItemsResponse' + security: + - Bearer: [ ] + post: + tags: + - log4netConfigs + summary: Retrieves a list of log4net logger configurations with pagination support. + description: Retrieves a list of log4net logger configurations with pagination support. + operationId: GetLog4NetConfigItems_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetLog4NetConfigItems' + x-bodyName: body responses: '200': description: Response for getting log4net configuration items with pagination support @@ -9985,24 +15959,45 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseStatus' + security: + - Bearer: [ ] + post: + tags: + - reportDescription + summary: Returns a description for the specified report. + description: Returns a description for the specified report. + operationId: GetReportDescription_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportDescription' + x-bodyName: body responses: '200': description: Success @@ -10011,24 +16006,48 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/ReportChangeDetail' + security: + - Bearer: [ ] + post: + tags: + - reportDifferences + summary: Get a list of differences between two reports runs. + description: Get a list of differences between two reports runs. + operationId: GetReportChangeDetails_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportChangeDetails' + x-bodyName: body responses: '200': description: Success @@ -10040,64 +16059,85 @@ 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: + - 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 - 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: A returned list of report results for displaying in a grid. + content: + application/json: + schema: + $ref: '#/components/schemas/GetReportDataResponse' + security: + - Bearer: [ ] + post: + tags: + - reportData + summary: 'Gets report results for the specified agent, device or task id.' + description: 'Gets report results for the specified agent, device or task id.' + operationId: GetReportDatareportId_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetReportData' + x-bodyName: body responses: '200': description: A returned list of report results for displaying in a grid. @@ -10106,41 +16146,62 @@ 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 + - name: DeviceFilter + in: query + description: Specifies the devices for which to retrieve the available reports. + schema: + $ref: '#/components/schemas/DeviceFilter' + - name: StartDateUtc + in: query + description: Specifies a start date to search from. + schema: + type: string + format: date-time + - name: EndDateUtc + in: query + description: Specifies a start date to search up to. + schema: + type: string + format: date-time + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Describes the available reports for the specified devices. + content: + application/json: + schema: + $ref: '#/components/schemas/GetAvailableReportsResponse' + security: + - Bearer: [ ] + post: + tags: + - availableReports + summary: ' Gets a list of available reports for a specified group or agent.' + description: ' Gets a list of available reports for a specified group or agent.' + operationId: GetAvailableReports_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetAvailableReports' + x-bodyName: body responses: '200': description: Describes the available reports for the specified devices. @@ -10149,29 +16210,50 @@ 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 + - name: Id + in: query + description: The identifier of the dashboard to get. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Details of a specific dashboard layout. + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardLayout' + security: + - Bearer: [ ] + post: + tags: + - userDashboard + summary: Gets the user dashboard widget layout. + description: Gets the user dashboard widget layout. + operationId: GetUserDashboard_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserDashboard' + x-bodyName: body responses: '200': description: Details of a specific dashboard layout. @@ -10180,29 +16262,50 @@ 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 + - name: Name + in: query + description: The name of the dashboard to get. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Details of a specific dashboard layout. + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardLayout' + security: + - Bearer: [ ] + post: + tags: + - userDashboard + summary: Gets the user dashboard widget layout by name. + description: Gets the user dashboard widget layout by name. + operationId: GetUserDashboardByNamenamed_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserDashboardByName' + x-bodyName: body responses: '200': description: Details of a specific dashboard layout. @@ -10211,14 +16314,55 @@ 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: @@ -10228,21 +16372,47 @@ paths: $ref: '#/components/schemas/SaveUserDashboard' x-bodyName: body responses: - '200': - description: Response to the SaveUserDashboard request. + '200': + description: Response to the SaveUserDashboard request. + content: + application/json: + schema: + $ref: '#/components/schemas/SaveUserDashboardResponse' + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userDashboard/delete: + get: + tags: + - userDashboard + summary: Deletes the user dashboard widget layout. + description: Deletes the user dashboard widget layout. + operationId: DeleteUserDashboarddelete_Get + parameters: + - name: Id + in: query + description: The identifier of the dashboard to delete. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content content: - application/json: - schema: - $ref: '#/components/schemas/SaveUserDashboardResponse' + application/json: { } security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /userDashboard/delete: + - Bearer: [ ] 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: @@ -10255,26 +16425,47 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to the GetUserSettings request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserSettingsResponse' + security: + - Bearer: [ ] + post: + tags: + - userSettings + summary: Gets the user settings and selections. + description: Gets the user settings and selections. + operationId: GetUserSettings_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserSettings' + x-bodyName: body responses: '200': description: Response to the GetUserSettings request. @@ -10283,14 +16474,52 @@ 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: @@ -10307,24 +16536,45 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Response to the GetDashboardWidgets request. + content: + application/json: + schema: + $ref: '#/components/schemas/GetDashboardWidgetsResponse' + security: + - Bearer: [ ] + post: + tags: + - dashboard + summary: Gets the dashboard widgets. + description: Gets the dashboard widgets. + operationId: GetDashboardWidgetswidgetTemplates_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetDashboardWidgets' + x-bodyName: body responses: '200': description: Response to the GetDashboardWidgets request. @@ -10333,64 +16583,85 @@ 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: + - 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 - 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: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChangesResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: Stats Service + description: Stats Service + operationId: GetCurrentPlannedChangesplannedChangeshoursPeriodHours_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetCurrentPlannedChanges' + x-bodyName: body responses: '200': description: Success @@ -10399,230 +16670,314 @@ 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: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: 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: 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. + description: 'Compliance data by report, for either individual devices, or as group average.' content: application/json: schema: $ref: '#/components/schemas/GetComplianceDataResponse' security: - - Bearer: [] + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedatastartStart_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] parameters: - - $ref: '#/components/parameters/Accept' - /stats/compliancedata/end/{End}: + - $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: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: 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: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedataendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body responses: '200': - description: Compliance data by report, for either individual devices, or as group average. + 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: + - name: ReportItemId + in: query + description: Specifies the scheduled report item id. + required: true + schema: 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: CountOnly + in: query + description: A value indicating whether to return a count of results only. + schema: + type: boolean + x-nullable: false + - name: Sort + in: query + description: 'The dictionary of sort fields and sort directions for the query. For example a key value pair might be "ColumnName", "ASC".' + schema: + title: 'Dictionary' + type: object + additionalProperties: + type: string + description: 'Dictionary' + - name: Skip + in: query + description: The offset into the result set to start at. + schema: + type: integer + format: int32 + - name: Take + in: query + description: The limit number of rows to return. + schema: + type: integer + format: int32 + - name: GenericFilters + in: query + description: The list of generic filtering options. These are typically sent from a UI control such as Kendo Grid. + style: form + schema: + type: array + items: + $ref: '#/components/schemas/PagingQueryFilter' + - name: GenericFilterLogic + in: query + description: The generic filter logic. This indicates how filters specified in GenericFilters are to be combined. + schema: + type: string + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: 'Compliance data by report, for either individual devices, or as group average.' + content: + application/json: + schema: + $ref: '#/components/schemas/GetComplianceDataResponse' + security: + - Bearer: [ ] + post: + tags: + - stats + summary: 'Get report summaries by report, for either individual devices, or as group average.' + description: 'Get report summaries by report, for either individual devices, or as group average.' + operationId: GetComplianceDatacompliancedatastartStartendEnd_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetComplianceData' + x-bodyName: body responses: '200': - description: Compliance data by report, for either individual devices, or as group average. + 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: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /stats/events/invalidate: + get: + tags: + - stats + summary: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + description: Represents a request to invalidate the eventcount stats for a group for a specific set of periods. + operationId: InvalidateEventCountseventsinvalidate_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '204': + description: No Content + content: + application/json: { } + security: + - Bearer: [ ] post: tags: - - stats - summary: Represents a request to invalidate the eventcount stats for a group for a specific set of periods + - 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: @@ -10635,16 +16990,39 @@ 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: @@ -10661,14 +17039,37 @@ 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: @@ -10685,14 +17086,37 @@ 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: @@ -10709,14 +17133,37 @@ 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: @@ -10733,14 +17180,37 @@ 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: @@ -10757,14 +17227,37 @@ 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: @@ -10781,24 +17274,48 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - pipelineNodes + summary: Gets a list of pipeline node names. + description: Gets a list of pipeline node names. + operationId: GetPipelineNodeList_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPipelineNodeList' + x-bodyName: body responses: '200': description: Success @@ -10810,14 +17327,37 @@ 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: @@ -10834,14 +17374,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: @@ -10858,12 +17398,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: @@ -10880,14 +17420,33 @@ 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: @@ -10900,14 +17459,35 @@ 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: @@ -10920,26 +17500,47 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + post: + tags: + - users + summary: Get a user's details. + description: Get a user's details. + operationId: GetUserUserName_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUser' + x-bodyName: body responses: '200': description: Success @@ -10948,14 +17549,35 @@ 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: @@ -10968,16 +17590,37 @@ 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: @@ -10990,16 +17633,37 @@ 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: @@ -11012,16 +17676,39 @@ 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: @@ -11038,14 +17725,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: @@ -11062,14 +17749,35 @@ 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: @@ -11082,15 +17790,38 @@ 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 @@ -11108,24 +17839,48 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/TimeZoneDetail' + security: + - Bearer: [ ] + post: + tags: + - timezones + summary: Gets a list of possible time zone names. + description: Gets a list of possible time zone names. + operationId: GetTimeZoneIds_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetTimeZoneIds' + x-bodyName: body responses: '200': description: Success @@ -11137,24 +17892,46 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - userHasChangedPassword + summary: Has the current user changed their password from any system assigned one? + description: Has the current user changed their password from any system assigned one? + operationId: UserHasChangedPassword_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserHasChangedPassword' + x-bodyName: body responses: '200': description: Success @@ -11164,14 +17941,37 @@ 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: @@ -11188,13 +17988,44 @@ 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 @@ -11208,15 +18039,36 @@ 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 @@ -11230,26 +18082,50 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/GroupAlert' + security: + - Bearer: [ ] + post: + tags: + - groupAlerts + summary: Get the configured notifications for the specified group. + description: Get the configured notifications for the specified group. + operationId: GetGroupAlertsForGroup_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetGroupAlertsForGroup' + x-bodyName: body responses: '200': description: Success @@ -11261,24 +18137,48 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + $ref: '#/components/schemas/UserDetails' + security: + - Bearer: [ ] + post: + tags: + - users + summary: Get a list of user names. + description: Get a list of user names. + operationId: GetUserList_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserList' + x-bodyName: body responses: '200': description: Success @@ -11290,15 +18190,36 @@ 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: @@ -11314,13 +18235,34 @@ paths: schema: $ref: '#/components/schemas/Object' parameters: - - $ref: '#/components/parameters/Accept' - /resetAdminPassword/{AdminName}: + - $ref: '#/components/parameters/Accept' + '/resetAdminPassword/{AdminName}': + get: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPasswordAdminName_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' post: tags: - - resetAdminPassword - summary: Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console. - description: Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console. + - 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: @@ -11336,13 +18278,34 @@ paths: schema: $ref: '#/components/schemas/Object' parameters: - - $ref: '#/components/parameters/Accept' - /resetAdminPassword/{OrganizationId}/{AdminName}: + - $ref: '#/components/parameters/Accept' + '/resetAdminPassword/{OrganizationId}/{AdminName}': + get: + tags: + - resetAdminPassword + summary: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + description: 'Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console.' + operationId: ResetAdminPasswordOrganizationIdAdminName_Get + parameters: + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Object' post: tags: - - resetAdminPassword - summary: Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console. - description: Resets the admin (or named account) password, returning a new temporary password in the response. Can only be called from the local hub console. + - 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: @@ -11358,22 +18321,43 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetUserRolesResponse' + security: + - Bearer: [ ] + post: + tags: + - userRoles + summary: Get a list of user roles defined in the system. + description: Get a list of user roles defined in the system. + operationId: GetUserRoles_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetUserRoles' + x-bodyName: body responses: '200': description: Success @@ -11382,42 +18366,120 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + post: + tags: + - permissions + summary: Gets a list of permissions names defined in the system. + description: Gets a list of permissions names defined in the system. + operationId: GetPermissions_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetPermissions' + x-bodyName: body + responses: + '200': + description: Success + content: + application/json: + schema: + title: List + type: array + items: + type: string + security: + - Bearer: [ ] + parameters: + - $ref: '#/components/parameters/Accept' + /userRoles/add: + get: + tags: + - userRoles + summary: Adds a custom user role + description: Adds a custom user role + operationId: AddUserRoleadd_Get + parameters: + - name: Name + in: query + description: Specifies the unique internal name for the role. If this is not supplied the DisplayName is used. + schema: + type: string + - name: DisplayName + in: query + description: Specifies the display name for the role. + required: true + schema: + type: string + - name: ExternalName + in: query + description: Specifies the role name in an external identity provider that corresponds to this role. + schema: + type: string + - name: Permissions + in: query + description: Specifies the list of names of permissions associated with the role. + style: form + schema: + type: array + items: + type: string + - name: ReadOnly + in: query + description: 'Specifies whether the role is read only, or can be edited.' + required: true + schema: + type: boolean + x-nullable: false + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false responses: '200': description: Success content: application/json: schema: - title: List - type: array - items: - type: string + $ref: '#/components/schemas/AddUserRoleResponse' security: - - Bearer: [] - parameters: - - $ref: '#/components/parameters/Accept' - /userRoles/add: + - Bearer: [ ] post: tags: - - userRoles + - userRoles summary: Adds a custom user role description: Adds a custom user role operationId: AddUserRoleadd_Post @@ -11435,13 +18497,62 @@ 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 @@ -11459,14 +18570,37 @@ 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: @@ -11483,14 +18617,41 @@ 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: @@ -11503,26 +18664,47 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The response to a request to get an Organization's license info. + content: + application/json: + schema: + $ref: '#/components/schemas/GetLicenseInfoResponse' + security: + - Bearer: [ ] + post: + tags: + - licenseInfo + summary: Represents a request to get an Organization's license info. + description: Represents a request to get an Organization's license info. + operationId: GetLicenseInfo_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetLicenseInfo' + x-bodyName: body responses: '200': description: The response to a request to get an Organization's license info. @@ -11531,15 +18713,47 @@ 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: @@ -11551,26 +18765,48 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - userRolesPermisions + summary: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + operationId: HasRoleOrPermissioncheck_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/HasRoleOrPermission' + x-bodyName: body responses: '200': description: Success @@ -11580,24 +18816,46 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: Success + content: + application/json: + schema: + title: string + type: boolean + security: + - Bearer: [ ] + post: + tags: + - userRolesPermissions + summary: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + description: 'Checks whether the caller, or the named user if supplied, has the specified roles and permissions.' + operationId: HasRoleOrPermissioncheck2_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/HasRoleOrPermission' + x-bodyName: body responses: '200': description: Success @@ -11607,24 +18865,45 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The roles and permissions for the user. + content: + application/json: + schema: + $ref: '#/components/schemas/GetRolesAndPermissionsResponse' + security: + - Bearer: [ ] + post: + tags: + - userRolesPermisions + summary: 'Gets roles and permissions for the caller, or the named user if supplied.' + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + operationId: GetRolesAndPermissions_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetRolesAndPermissions' + x-bodyName: body responses: '200': description: The roles and permissions for the user. @@ -11633,24 +18912,45 @@ 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 + - name: Version + in: query + description: 'Specifies the request version. If specified, this indicates the service model version the request complies with.' + schema: + type: integer + format: int32 + x-nullable: false + responses: + '200': + description: The roles and permissions for the user. + content: + application/json: + schema: + $ref: '#/components/schemas/GetRolesAndPermissionsResponse' + security: + - Bearer: [ ] + post: + tags: + - userRolesPermissions + summary: 'Gets roles and permissions for the caller, or the named user if supplied.' + description: 'Gets roles and permissions for the caller, or the named user if supplied.' + operationId: GetRolesAndPermissions2_Post + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GetRolesAndPermissions' + x-bodyName: body responses: '200': description: The roles and permissions for the user. @@ -11659,54 +18959,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 @@ -11716,48 +19016,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: @@ -11772,51 +19072,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 @@ -11826,47 +19126,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: @@ -11881,21 +19181,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 @@ -11905,17 +19205,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: @@ -11931,17 +19231,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: @@ -11957,17 +19257,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 @@ -11976,7 +19276,7 @@ paths: schema: $ref: '#/components/schemas/GetAccessTokenResponse' parameters: - - $ref: '#/components/parameters/Accept' + - $ref: '#/components/parameters/Accept' components: schemas: Object: @@ -11985,9 +19285,9 @@ components: GetAgentPoll: title: GetAgentPoll required: - - UniqueId - - AgentId - - PollTimeUtc + - UniqueId + - AgentId + - PollTimeUtc type: object properties: UniqueId: @@ -12018,7 +19318,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. @@ -12049,16 +19349,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 @@ -12115,7 +19415,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 @@ -12145,7 +19445,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. @@ -12170,9 +19470,9 @@ components: SubmitAgentTaskResultStream: title: SubmitAgentTaskResultStream required: - - AgentId - - DeviceId - - TaskId + - AgentId + - DeviceId + - TaskId type: object properties: RequestStream: @@ -12190,7 +19490,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. @@ -12204,7 +19504,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.' @@ -12220,13 +19520,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 @@ -12287,17 +19587,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: @@ -12318,23 +19618,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 @@ -12446,13 +19746,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 @@ -12465,7 +19765,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). @@ -12550,7 +19850,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. @@ -12563,11 +19863,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. @@ -12579,7 +19879,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. @@ -12593,7 +19893,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 @@ -12602,7 +19902,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. @@ -12618,14 +19918,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 @@ -12684,7 +19984,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. @@ -12698,7 +19998,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. @@ -12744,7 +20044,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 @@ -12754,7 +20054,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 @@ -12765,7 +20065,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 @@ -12826,7 +20126,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. @@ -12844,10 +20144,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. @@ -12938,11 +20238,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. @@ -12973,13 +20273,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. @@ -13057,7 +20357,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: @@ -13073,13 +20373,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 @@ -13095,7 +20395,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 @@ -13129,7 +20429,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. @@ -13144,7 +20444,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. @@ -13156,7 +20456,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. @@ -13167,7 +20467,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. @@ -13186,10 +20486,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 @@ -13199,7 +20499,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: @@ -13210,7 +20510,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 @@ -13279,7 +20579,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. @@ -13417,13 +20717,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 @@ -13450,7 +20750,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. @@ -13476,7 +20776,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. @@ -13509,12 +20809,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: @@ -13532,7 +20832,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. @@ -13563,12 +20863,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 @@ -13596,7 +20896,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. @@ -13611,7 +20911,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. @@ -13627,7 +20927,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. @@ -13637,7 +20937,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: @@ -13647,7 +20947,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. @@ -13701,12 +21001,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: @@ -13724,7 +21024,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. @@ -13755,12 +21055,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 @@ -13773,7 +21073,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. @@ -13788,7 +21088,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. @@ -13798,7 +21098,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.' @@ -13808,12 +21108,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: @@ -13823,7 +21123,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. @@ -13846,12 +21146,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. @@ -13884,12 +21184,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: @@ -13907,7 +21207,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. @@ -13938,12 +21238,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 @@ -13965,7 +21265,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. @@ -13975,7 +21275,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. @@ -13985,7 +21285,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. @@ -13995,7 +21295,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). @@ -14026,17 +21326,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. @@ -14046,20 +21346,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 @@ -14076,7 +21376,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. @@ -14086,7 +21386,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. @@ -14096,7 +21396,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. @@ -14110,7 +21410,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 @@ -14126,7 +21426,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 @@ -14138,7 +21438,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 @@ -14163,7 +21463,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 @@ -14183,7 +21483,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 @@ -14203,16 +21503,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: @@ -14226,14 +21526,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: @@ -14268,7 +21568,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: @@ -14278,10 +21578,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 @@ -14331,15 +21631,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: @@ -14353,7 +21653,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 @@ -14391,14 +21691,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: @@ -14459,10 +21759,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 @@ -14480,7 +21780,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 @@ -14502,7 +21802,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. @@ -14577,10 +21877,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 @@ -14589,11 +21889,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: @@ -14601,7 +21901,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 @@ -14619,14 +21919,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 @@ -14737,8 +22037,8 @@ components: RenderReport: title: RenderReport required: - - ReportItemId - - InstanceId + - ReportItemId + - InstanceId type: object properties: RendererType: @@ -14758,18 +22058,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: @@ -14786,10 +22086,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 @@ -14804,7 +22104,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 @@ -14818,15 +22118,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: @@ -14837,15 +22137,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: @@ -14860,7 +22160,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 @@ -14873,26 +22173,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 @@ -14903,7 +22203,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 @@ -14925,17 +22225,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: @@ -14960,7 +22260,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 @@ -15001,7 +22301,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: @@ -15011,10 +22311,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 @@ -15135,15 +22435,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: @@ -15158,7 +22458,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 @@ -15168,7 +22468,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 @@ -15198,7 +22498,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 @@ -15208,13 +22508,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. @@ -15227,7 +22527,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. @@ -15243,13 +22543,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 @@ -15259,7 +22559,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. @@ -15272,7 +22572,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. @@ -15287,7 +22587,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. @@ -15333,7 +22633,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. @@ -15365,15 +22665,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: @@ -15388,15 +22688,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: @@ -15411,14 +22711,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: @@ -15426,7 +22726,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. @@ -15447,7 +22747,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 @@ -15473,7 +22773,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. @@ -15485,7 +22785,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. @@ -15500,7 +22800,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. @@ -15522,7 +22822,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. @@ -15538,7 +22838,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. @@ -15558,7 +22858,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. @@ -15573,7 +22873,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. @@ -15585,7 +22885,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. @@ -15640,7 +22940,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 @@ -15655,7 +22955,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. @@ -15671,7 +22971,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. @@ -15681,10 +22981,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 @@ -15696,7 +22996,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. @@ -15717,10 +23017,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 @@ -15732,7 +23032,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. @@ -15779,10 +23079,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. @@ -15833,19 +23133,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. @@ -15855,14 +23155,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: @@ -15870,14 +23170,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: @@ -15889,14 +23189,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: @@ -15910,7 +23210,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 @@ -15920,7 +23220,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. @@ -15932,7 +23232,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: @@ -15973,7 +23273,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 @@ -15981,14 +23281,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: @@ -16027,7 +23327,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. @@ -16052,14 +23352,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: @@ -16071,7 +23371,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. @@ -16108,11 +23408,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 @@ -16149,14 +23449,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: @@ -16174,14 +23474,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: @@ -16233,10 +23533,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. @@ -16289,7 +23589,7 @@ components: AddReEvaluationOfPlannedChangeInstanceEvents: title: AddReEvaluationOfPlannedChangeInstanceEvents required: - - InstanceId + - InstanceId type: object properties: InstanceId: @@ -16308,7 +23608,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. @@ -16345,18 +23645,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 @@ -16393,17 +23693,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: @@ -16417,7 +23717,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. @@ -16430,7 +23730,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_' @@ -16483,7 +23783,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. @@ -16491,14 +23791,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 @@ -16509,7 +23809,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 @@ -16530,7 +23830,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 @@ -16552,15 +23852,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 @@ -16573,7 +23873,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. @@ -16591,10 +23891,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 @@ -16611,10 +23911,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 @@ -16640,7 +23940,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 @@ -16655,7 +23955,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 @@ -16671,7 +23971,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 @@ -16684,7 +23984,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. @@ -16699,7 +23999,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 @@ -16743,10 +24043,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 @@ -16767,10 +24067,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 @@ -16788,7 +24088,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. @@ -16804,7 +24104,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. @@ -16857,7 +24157,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. @@ -16879,7 +24179,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. @@ -16896,7 +24196,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. @@ -16916,7 +24216,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. @@ -16932,7 +24232,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. @@ -16966,7 +24266,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. @@ -17000,7 +24300,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. @@ -17016,10 +24316,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 @@ -17036,7 +24336,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. @@ -17049,7 +24349,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. @@ -17062,7 +24362,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. @@ -17076,13 +24376,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. @@ -17474,7 +24774,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 @@ -17500,7 +24800,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: @@ -17509,7 +24809,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: @@ -17545,7 +24845,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: @@ -17576,7 +24876,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: @@ -17627,7 +24927,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 @@ -17639,7 +24939,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 @@ -17701,7 +25001,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. @@ -17713,7 +25013,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: @@ -17745,7 +25045,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: @@ -17928,13 +25228,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: @@ -17966,7 +25266,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: @@ -18136,7 +25436,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. @@ -18200,7 +25500,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: @@ -18435,7 +25735,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. @@ -18463,7 +25763,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 @@ -18475,7 +25775,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 @@ -18504,7 +25804,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 @@ -18594,7 +25894,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 @@ -18604,7 +25904,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 @@ -18622,7 +25922,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. @@ -18635,10 +25935,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. @@ -18660,7 +25960,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 @@ -18676,7 +25976,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. @@ -18688,7 +25988,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. @@ -18706,7 +26006,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. @@ -18718,7 +26018,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. @@ -18734,7 +26034,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. @@ -18805,7 +26105,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. @@ -18822,7 +26122,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. @@ -18839,13 +26139,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 @@ -18860,7 +26160,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. @@ -18903,7 +26203,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. @@ -18918,7 +26218,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. @@ -18928,7 +26228,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: @@ -18961,7 +26261,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. @@ -18983,7 +26283,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. @@ -19004,7 +26304,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. @@ -19062,7 +26362,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. @@ -19100,7 +26400,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. @@ -19124,7 +26424,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. @@ -19153,7 +26453,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. @@ -19170,14 +26470,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: @@ -19188,10 +26488,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 @@ -19209,14 +26509,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: @@ -19235,7 +26535,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. @@ -19247,17 +26547,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: @@ -19277,7 +26577,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. @@ -19299,10 +26599,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 @@ -19314,7 +26614,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. @@ -19330,10 +26630,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 @@ -19342,7 +26642,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. @@ -19357,7 +26657,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. @@ -19369,10 +26669,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 @@ -19382,7 +26682,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. @@ -19420,7 +26720,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. @@ -19448,7 +26748,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. @@ -19471,7 +26771,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. @@ -19487,7 +26787,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 @@ -19509,10 +26809,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 @@ -19524,7 +26824,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. @@ -19539,7 +26839,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. @@ -19554,7 +26854,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. @@ -19577,7 +26877,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. @@ -19587,7 +26887,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. @@ -19605,7 +26905,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. @@ -19618,7 +26918,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. @@ -19650,7 +26950,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. @@ -19677,7 +26977,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. @@ -19727,18 +27027,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'. @@ -19750,7 +27050,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).' @@ -19763,7 +27063,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. @@ -19786,11 +27086,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 @@ -19800,10 +27100,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 @@ -19815,7 +27115,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 @@ -19870,7 +27170,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. @@ -19970,7 +27270,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. @@ -20006,7 +27306,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. @@ -20056,7 +27356,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. @@ -20095,7 +27395,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. @@ -20142,7 +27442,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. @@ -20167,7 +27467,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. @@ -20352,7 +27652,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. @@ -20396,7 +27696,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. @@ -20433,7 +27733,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. @@ -20486,7 +27786,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. @@ -20508,7 +27808,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. @@ -20540,7 +27840,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. @@ -20603,7 +27903,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. @@ -20618,7 +27918,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. @@ -20638,7 +27938,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. @@ -20672,10 +27972,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 @@ -20692,7 +27992,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.' @@ -20705,7 +28005,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. @@ -20718,7 +28018,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. @@ -20728,7 +28028,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. @@ -20739,7 +28039,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. @@ -20802,7 +28102,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: @@ -20829,7 +28129,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. @@ -20839,7 +28139,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. @@ -20858,7 +28158,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. @@ -20868,7 +28168,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. @@ -20886,7 +28186,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. @@ -20918,7 +28218,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. @@ -20928,7 +28228,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. @@ -20938,7 +28238,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. @@ -20962,7 +28262,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. @@ -20987,7 +28287,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. @@ -21014,7 +28314,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. @@ -21030,7 +28330,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. @@ -21047,7 +28347,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. @@ -21121,11 +28421,11 @@ components: UserDateFormats: title: UserDateFormats required: - - Name - - LongDateTimeFormatNet - - ShortDateTimeFormatNet - - LongDateTimeFormatJs - - ShortDateTimeFormatJs + - Name + - LongDateTimeFormatNet + - ShortDateTimeFormatNet + - LongDateTimeFormatJs + - ShortDateTimeFormatJs type: object properties: Name: @@ -21178,7 +28478,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. @@ -21190,7 +28490,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. @@ -21206,7 +28506,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. @@ -21218,7 +28518,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. @@ -21230,7 +28530,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. @@ -21242,7 +28542,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. @@ -21258,7 +28558,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. @@ -21270,7 +28570,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. @@ -21286,7 +28586,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. @@ -21298,7 +28598,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. @@ -21310,7 +28610,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. @@ -21326,7 +28626,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 @@ -21336,7 +28636,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. @@ -21346,7 +28646,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? @@ -21367,7 +28667,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. @@ -21383,7 +28683,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 @@ -21406,7 +28706,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 @@ -21418,7 +28718,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. @@ -21430,7 +28730,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. @@ -21446,10 +28746,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 @@ -21458,7 +28758,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. @@ -21468,15 +28768,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: @@ -21495,20 +28795,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: @@ -21527,7 +28827,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 @@ -21541,14 +28841,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: @@ -21556,7 +28856,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. @@ -21566,7 +28866,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. @@ -21583,10 +28883,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 @@ -21603,10 +28903,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 @@ -21615,17 +28915,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: @@ -21655,7 +28955,7 @@ components: GetAgentPollResponse: title: GetAgentPollResponse required: - - Version + - Version type: object properties: AgentId: @@ -21678,7 +28978,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' @@ -21689,12 +28989,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 @@ -21712,7 +29012,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 @@ -21734,7 +29034,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: @@ -21752,7 +29052,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: @@ -21788,11 +29088,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: @@ -21819,8 +29119,8 @@ components: SubmitAgentTaskResultStreamResponse: title: SubmitAgentTaskResultStreamResponse required: - - StoredId - - Version + - StoredId + - Version type: object properties: StoredId: @@ -21835,7 +29135,7 @@ components: GetPolicyTemplatesResponse: title: GetPolicyTemplatesResponse required: - - Version + - Version type: object properties: Templates: @@ -21926,7 +29226,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. @@ -21943,11 +29243,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: @@ -21999,7 +29299,7 @@ components: GetAgentsResponse: title: GetAgentsResponse required: - - Version + - Version type: object properties: AgentCredentials: @@ -22031,7 +29331,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. @@ -22066,7 +29366,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. @@ -22120,7 +29420,7 @@ components: SearchAgentsResponse: title: SearchAgentsResponse required: - - Version + - Version type: object properties: Agents: @@ -22157,7 +29457,7 @@ components: GetDeviceConfigResponse: title: GetDeviceConfigResponse required: - - Version + - Version type: object properties: DeviceTemplate: @@ -22166,7 +29466,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. @@ -22176,24 +29476,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: @@ -22287,12 +29587,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: @@ -22310,7 +29610,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. @@ -22341,12 +29641,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 @@ -22403,12 +29703,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: @@ -22426,7 +29726,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. @@ -22457,12 +29757,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 @@ -22505,12 +29805,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: @@ -22528,7 +29828,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. @@ -22559,17 +29859,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: @@ -22585,7 +29885,7 @@ components: SubmitBaselineEventsLimitedResponse: title: SubmitBaselineEventsLimitedResponse required: - - Version + - Version type: object properties: BackOffSeconds: @@ -22601,7 +29901,7 @@ components: SubmitDeviceEventsLimitedResponse: title: SubmitDeviceEventsLimitedResponse required: - - Version + - Version type: object properties: BackOffSeconds: @@ -22617,7 +29917,7 @@ components: SystemReadyResponse: title: SystemReadyResponse required: - - Version + - Version type: object properties: IsReady: @@ -22669,12 +29969,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: @@ -22829,20 +30129,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 @@ -22890,13 +30190,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 @@ -22905,7 +30205,7 @@ components: GetCacheStatsResponse: title: GetCacheStatsResponse required: - - Version + - Version type: object properties: GroupCounts: @@ -22938,7 +30238,7 @@ components: GetAvailableReportTypesResponse: title: GetAvailableReportTypesResponse required: - - Version + - Version type: object properties: Items: @@ -22963,7 +30263,7 @@ components: GetReportTemplatesResponse: title: GetReportTemplatesResponse required: - - Version + - Version type: object properties: Items: @@ -23012,7 +30312,7 @@ components: GetScheduledReportsResponse: title: GetScheduledReportsResponse required: - - Version + - Version type: object properties: Items: @@ -23025,7 +30325,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 @@ -23083,12 +30383,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: @@ -23098,7 +30398,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: @@ -23109,7 +30409,7 @@ components: UpdateReportTemplateResponse: title: UpdateReportTemplateResponse required: - - Version + - Version type: object properties: FileId: @@ -23123,7 +30423,7 @@ components: DataSpecDeviceMonitoringReportResponse: title: DataSpecDeviceMonitoringReportResponse required: - - Version + - Version type: object properties: ReportMetadata: @@ -23143,14 +30443,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. @@ -23163,13 +30463,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. @@ -23230,7 +30530,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: @@ -23341,19 +30641,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.. @@ -23405,7 +30705,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: @@ -23419,7 +30719,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. @@ -23475,12 +30775,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. @@ -23524,7 +30824,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: @@ -23595,13 +30895,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 @@ -23735,7 +31035,7 @@ components: GetRuleResultsResponse: title: GetRuleResultsResponse required: - - Version + - Version type: object properties: Items: @@ -23797,17 +31097,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: @@ -23911,7 +31211,7 @@ components: GetCurrentPlannedChangesResponse: title: GetCurrentPlannedChangesResponse required: - - Version + - Version type: object properties: PlannedChanges: @@ -23957,7 +31257,7 @@ components: GetComplianceDataResponse: title: GetComplianceDataResponse required: - - Version + - Version type: object properties: ReportSummaries: @@ -23979,7 +31279,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 @@ -24025,8 +31325,8 @@ components: ReportScore: title: ReportScore required: - - ReportItemId - - ReportInstanceId + - ReportItemId + - ReportInstanceId type: object properties: Version: @@ -24086,7 +31386,7 @@ components: GetAvailableComplianceDataResponse: title: GetAvailableComplianceDataResponse required: - - Version + - Version type: object properties: AvailableComplianceReports: @@ -24104,7 +31404,7 @@ components: ComplianceReportRun: title: ComplianceReportRun required: - - ReportItemId + - ReportItemId type: object properties: GroupDisplayName: @@ -24123,13 +31423,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 @@ -24175,7 +31475,7 @@ components: GetDeviceActivityResponse: title: GetDeviceActivityResponse required: - - Version + - Version type: object properties: TotalDevices: @@ -24250,7 +31550,7 @@ components: GetEventCountsResponse: title: GetEventCountsResponse required: - - Version + - Version type: object properties: DeviceOrGroupName: @@ -24298,7 +31598,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 @@ -24363,13 +31663,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 @@ -24378,7 +31678,7 @@ components: ExecuteReportResponse: title: ExecuteReportResponse required: - - Version + - Version type: object properties: Instance: @@ -24431,7 +31731,7 @@ components: GetScheduledInstancesResponse: title: GetScheduledInstancesResponse required: - - Version + - Version type: object properties: Items: @@ -24447,7 +31747,7 @@ components: GetScheduledInstanceRenderedResponse: title: GetScheduledInstanceRenderedResponse required: - - Version + - Version type: object properties: Items: @@ -24484,7 +31784,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 @@ -24494,7 +31794,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 @@ -24529,7 +31829,7 @@ components: GetSyncServiceConfigItemsResponse: title: GetSyncServiceConfigItemsResponse required: - - Version + - Version type: object properties: ConfigurationValues: @@ -24571,7 +31871,7 @@ components: AddSyncServiceConfigItemResponse: title: AddSyncServiceConfigItemResponse required: - - Version + - Version type: object properties: ConfigurationValue: @@ -24585,7 +31885,7 @@ components: GetConfigItemsResponse: title: GetConfigItemsResponse required: - - Version + - Version type: object properties: ConfigItems: @@ -24649,15 +31949,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: @@ -24672,13 +31972,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 @@ -24687,7 +31987,7 @@ components: GetAgentTaskStatusesResponse: title: GetAgentTaskStatusesResponse required: - - Version + - Version type: object properties: Statuses: @@ -24755,7 +32055,7 @@ components: SubmitAgentTasksResponse: title: SubmitAgentTasksResponse required: - - Version + - Version type: object properties: Tasks: @@ -24781,13 +32081,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 @@ -24797,8 +32097,8 @@ components: GetPlannedChangeInstanceMembersResponse: title: GetPlannedChangeInstanceMembersResponse required: - - InstanceId - - Version + - InstanceId + - Version type: object properties: InstanceId: @@ -24834,7 +32134,7 @@ components: GetPlannedChangesInstancesResponse: title: GetPlannedChangesInstancesResponse required: - - Version + - Version type: object properties: PlannedChangeInstances: @@ -24856,11 +32156,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: @@ -24874,7 +32174,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 @@ -24895,7 +32195,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. @@ -24979,7 +32279,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: @@ -24993,7 +32293,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. @@ -25006,7 +32306,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_' @@ -25028,7 +32328,7 @@ components: GetPlannedChangeInstancesNameValueResponse: title: GetPlannedChangeInstancesNameValueResponse required: - - Version + - Version type: object properties: PlannedChangeInstances: @@ -25050,11 +32350,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: @@ -25070,7 +32370,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' @@ -25080,7 +32380,7 @@ components: GetPlannedChangesResponse: title: GetPlannedChangesResponse required: - - Version + - Version type: object properties: PlannedChanges: @@ -25107,7 +32407,7 @@ components: AnalyzePlannedChangeResponse: title: AnalyzePlannedChangeResponse required: - - Version + - Version type: object properties: RuleIdsReplaced: @@ -25216,7 +32516,7 @@ components: WhitelistCommandComponentResponse: title: WhitelistCommandComponentResponse required: - - Version + - Version type: object properties: Success: @@ -25249,7 +32549,7 @@ components: CommandComponentTemplateResponse: title: CommandComponentTemplateResponse required: - - Version + - Version type: object properties: Success: @@ -25266,7 +32566,7 @@ components: GetAllCommandComponentTemplatesResponse: title: GetAllCommandComponentTemplatesResponse required: - - Version + - Version type: object properties: Success: @@ -25297,7 +32597,7 @@ components: GetAllCommandComponentsTemplatesResponse: title: GetAllCommandComponentsTemplatesResponse required: - - Version + - Version type: object properties: Success: @@ -25316,7 +32616,7 @@ components: GetCloudTemplateCreationStatusResponse: title: GetCloudTemplateCreationStatusResponse required: - - Version + - Version type: object properties: CloudSystemName: @@ -25383,7 +32683,7 @@ components: SetupPolicyTemplateResponse: title: SetupPolicyTemplateResponse required: - - Version + - Version type: object properties: Version: @@ -25395,7 +32695,7 @@ components: GetPolicyTemplateCreationStatusResponse: title: GetPolicyTemplateCreationStatusResponse required: - - Version + - Version type: object properties: PolicyTemplateName: @@ -25484,7 +32784,7 @@ components: GetMostRecentPolicyResultsResponse: title: GetMostRecentPolicyResultsResponse required: - - Version + - Version type: object properties: Results: @@ -25690,7 +32990,7 @@ components: AddPolicyTemplateRulesResponse: title: AddPolicyTemplateRulesResponse required: - - Version + - Version type: object properties: ActionsTaken: @@ -25731,7 +33031,7 @@ components: UploadPolicyTemplateResponse: title: UploadPolicyTemplateResponse required: - - Version + - Version type: object properties: AddPolicyTemplateResponses: @@ -25748,7 +33048,7 @@ components: GetAgentProcessesResponse: title: GetAgentProcessesResponse required: - - Version + - Version type: object properties: TaskId: @@ -25766,7 +33066,7 @@ components: StartAgentTrackerResponse: title: StartAgentTrackerResponse required: - - Version + - Version type: object properties: TaskId: @@ -25784,7 +33084,7 @@ components: GetAgentServicesResponse: title: GetAgentServicesResponse required: - - Version + - Version type: object properties: TaskId: @@ -25802,7 +33102,7 @@ components: GetGroupPolicyResponse: title: GetGroupPolicyResponse required: - - Version + - Version type: object properties: Templates: @@ -25828,7 +33128,7 @@ components: AddGroupPolicyResponse: title: AddGroupPolicyResponse required: - - Version + - Version type: object properties: Templates: @@ -25854,7 +33154,7 @@ components: GetAgentsRankedResponse: title: GetAgentsRankedResponse required: - - Version + - Version type: object properties: AgentCredentials: @@ -25896,7 +33196,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. @@ -25934,18 +33234,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: @@ -25994,7 +33294,7 @@ components: GetGroupsResponse: title: GetGroupsResponse required: - - Version + - Version type: object properties: Groups: @@ -26065,7 +33365,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: @@ -26085,7 +33385,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 @@ -26127,7 +33427,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 @@ -26156,7 +33456,7 @@ components: GetGroupsTreeResponse: title: GetGroupsTreeResponse required: - - Groups + - Groups type: object properties: Groups: @@ -26196,7 +33496,7 @@ components: AddGroupResponse: title: AddGroupResponse required: - - Version + - Version type: object properties: Name: @@ -26211,7 +33511,7 @@ components: GetOverdueDevicesResponse: title: GetOverdueDevicesResponse required: - - Version + - Version type: object properties: Devices: @@ -26228,7 +33528,7 @@ components: DeleteDevicePermanentlyResponse: title: DeleteDevicePermanentlyResponse required: - - Version + - Version type: object properties: Challenge: @@ -26239,11 +33539,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: @@ -26270,7 +33570,7 @@ components: TestAgentCredentialsResponse: title: TestAgentCredentialsResponse required: - - Version + - Version type: object properties: TaskId: @@ -26308,7 +33608,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 @@ -26317,7 +33617,7 @@ components: DiscoverDevicesResponse: title: DiscoverDevicesResponse required: - - Version + - Version type: object properties: TaskId: @@ -26335,7 +33635,7 @@ components: GetEventHistoryResponse: title: GetEventHistoryResponse required: - - Version + - Version type: object properties: EventId: @@ -26373,7 +33673,7 @@ components: GetEventDeviceGroupsResponse: title: GetEventDeviceGroupsResponse required: - - Version + - Version type: object properties: GroupNames: @@ -26395,7 +33695,7 @@ components: GetInventoryResponse: title: GetInventoryResponse required: - - Version + - Version type: object properties: Items: @@ -26421,7 +33721,7 @@ components: GetAgentInventoryItemsGroupedResponse: title: GetAgentInventoryItemsGroupedResponse required: - - Version + - Version type: object properties: Items: @@ -26473,7 +33773,7 @@ components: GetAgentInventoryAgentsDetailResponse: title: GetAgentInventoryAgentsDetailResponse required: - - Version + - Version type: object properties: Items: @@ -26510,7 +33810,7 @@ components: GetVulnerabilityOverviewResponse: title: GetVulnerabilityOverviewResponse required: - - Version + - Version type: object properties: SoftwareVulnerabilityScoresV3: @@ -26534,7 +33834,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: @@ -26601,7 +33901,7 @@ components: GetVulnerabilityScanStatusResponse: title: GetVulnerabilityScanStatusResponse required: - - Version + - Version type: object properties: InventoryItemsInQueue: @@ -26622,17 +33922,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: @@ -26886,7 +34186,7 @@ components: GetSoftwareVulnerabilityResponse: title: GetSoftwareVulnerabilityResponse required: - - Version + - Version type: object properties: SoftwareItems: @@ -26913,7 +34213,7 @@ components: GetSoftwareVulnerabilityDetailResponse: title: GetSoftwareVulnerabilityDetailResponse required: - - Version + - Version type: object properties: CvesList: @@ -26940,7 +34240,7 @@ components: GetDeviceVulnerabilityResponse: title: GetDeviceVulnerabilityResponse required: - - Version + - Version type: object properties: VulnerableDevices: @@ -26984,7 +34284,7 @@ components: GetDeviceVulnerabilityDetailResponse: title: GetDeviceVulnerabilityDetailResponse required: - - Version + - Version type: object properties: CvesList: @@ -27011,7 +34311,7 @@ components: GetCvesForRelatedCpesResponse: title: GetCvesForRelatedCpesResponse required: - - Version + - Version type: object properties: CvesList: @@ -27037,7 +34337,7 @@ components: GetVulnerableDeviceDetailResponse: title: GetVulnerableDeviceDetailResponse required: - - Version + - Version type: object properties: VulnerableDevices: @@ -27113,7 +34413,7 @@ components: GetLog4NetConfigItemsResponse: title: GetLog4NetConfigItemsResponse required: - - Version + - Version type: object properties: LoggerConfigs: @@ -27190,7 +34490,7 @@ components: GetReportDataResponse: title: GetReportDataResponse required: - - Version + - Version type: object properties: ReportId: @@ -27298,7 +34598,7 @@ components: GetAvailableReportsResponse: title: GetAvailableReportsResponse required: - - Version + - Version type: object properties: ReportMetadata: @@ -27437,7 +34737,7 @@ components: GetUserTwoFactorStatusResponse: title: GetUserTwoFactorStatusResponse required: - - Version + - Version type: object properties: ChangePasswordByUtc: @@ -27499,7 +34799,7 @@ components: ResetUserPasswordResponse: title: ResetUserPasswordResponse required: - - Version + - Version type: object properties: Password: @@ -27516,7 +34816,7 @@ components: PreviewResetUserPasswordResponse: title: PreviewResetUserPasswordResponse required: - - Version + - Version type: object properties: Password: @@ -27556,7 +34856,7 @@ components: GetUserRolesResponse: title: GetUserRolesResponse required: - - Version + - Version type: object properties: Roles: @@ -27580,10 +34880,10 @@ components: UserRole: title: UserRole required: - - Name - - DisplayName - - Permissions - - ReadOnly + - Name + - DisplayName + - Permissions + - ReadOnly type: object properties: Name: @@ -27602,13 +34902,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: @@ -27624,7 +34924,7 @@ components: UpdateUserRoleResponse: title: UpdateUserRoleResponse required: - - Version + - Version type: object properties: Roles: @@ -27640,7 +34940,7 @@ components: GetLicenseInfoResponse: title: GetLicenseInfoResponse required: - - Version + - Version type: object properties: Description: @@ -27670,7 +34970,7 @@ components: GetRolesAndPermissionsResponse: title: GetRolesAndPermissionsResponse required: - - Version + - Version type: object properties: UserName: @@ -27726,122 +35026,123 @@ components: required: true schema: enum: - - application/json + - application/json type: string securitySchemes: Bearer: - type: http - scheme: bearer + type: apiKey + name: Authorization + in: header tags: -- name: acknowledgeEvents -- name: addDeviceConfigProcessRules -- name: agentInventoryAgentsDetail -- name: agentInventoryGrouped -- name: agentProcesses -- name: agents -- name: agentServices -- name: agentSoftwareUpdateSchedules -- name: agentsRanked -- name: agentUpdates -- name: alertEvents -- name: auth -- name: availableReports -- name: baselineEvents -- name: cloudTemplate -- name: command -- name: commandParser -- name: configItem -- name: configItems -- name: credential -- name: credentials -- name: credentialsKeyedByType -- name: dashboard -- name: device -- name: deviceConfig -- name: deviceConfigTemplate -- name: deviceConfigTemplateNames -- name: deviceCredentials -- name: deviceDbCredentials -- name: deviceEvents -- name: deviceFilter -- name: deviceFilters -- name: deviceHostType -- name: deviceName -- name: deviceOnlineStatus -- name: devicePolicyTemplate -- name: devices -- name: deviceSettings -- name: discoverDevices -- name: discoveredDevices -- name: downloadAgentUpdate -- name: downloadFileHash -- name: downloadFileHashById -- name: event -- name: eventDeviceGroups -- name: events -- name: exportAgents -- name: exportUserNotifications -- name: getFileHashBinaries -- name: group -- name: groupAlerts -- name: groupMembers -- name: groupMemberships -- name: groupPolicy -- name: groupPolicyNames -- name: groups -- name: groupsTree -- name: inventory -- name: ipBlocking -- name: licenseInfo -- name: log4netConfigs -- name: misc -- name: openapi3.yaml -- name: organization -- name: permissions -- name: pipelineNodes -- name: plannedChangeInstances -- name: plannedChangeRule -- name: plannedChanges -- name: policyRecent -- name: policyTemplate -- name: policyTemplateAsFile -- name: policyTemplates -- name: policyTemplateVariables -- name: reParentDevices -- name: reportData -- name: reportDescription -- name: reportDifferences -- name: reportExecute -- name: reportRender -- name: reportRenderIsCached -- name: reportRenderStart -- name: reports -- name: resetAdminPassword -- name: resubmitEvents -- name: setCommentsForEvents -- name: startAgentTracker -- name: stats -- name: status -- name: submitAgentTaskResult -- name: submitAgentTaskResultData -- name: submitAgentTaskResultStream -- name: syncServiceConfigItems -- name: testAgentCredentials -- name: testAuditorConnection -- name: testFastConnection -- name: testFastCustomerConnection -- name: testServiceNowConnection -- name: testSmtpConnection -- name: testSyslogConnection -- name: timezones -- name: updatehubdetails -- name: uploadAgentUpdate -- name: uploadPolicyTemplate -- name: userDashboard -- name: userHasChangedPassword -- name: userRoles -- name: userRolesPermisions -- name: userRolesPermissions -- name: users -- name: userSettings -- name: vulnerabilityscanstatus + - 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