openapi: 3.0.0 info: title: Secret Server Rest Activations Discovery API description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the authentication document for more information. The Swagger specification for this API is also available. termsOfService: https://delinea.com/eula contact: name: Support url: https://delinea.com version: 11.7.2 servers: - url: /SecretServer/api security: - BearerToken: [] tags: - name: Discovery description: DiscoveryController paths: /v1/discovery/source/{discoverySourceId}/scanners/{discoveryItemScannerId}: get: tags: - Discovery summary: Get Discovery Scanner Details description: Get the details for a specific discovery scanner operationId: DiscoveryService_GetDiscoverySourceScanner parameters: - name: discoveryItemScannerId in: path description: discoveryItemScannerId required: true schema: type: integer format: int32 - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 responses: '200': description: Discovery Scanner Detail content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDetailModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false delete: tags: - Discovery summary: Remove Scanner from discovery source description: Remove the specified scanner from the discovery source operationId: DiscoveryService_RemoveDiscoverySourceScanner parameters: - name: discoveryItemScannerId in: path description: discoveryItemScannerId required: true schema: type: integer format: int32 - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 responses: '200': description: Success result content: application/json: schema: $ref: '#/components/schemas/RemoveDiscoveryScannerResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/accounts/{id}: get: tags: - Discovery summary: Get discovery account rule description: Returns discovery account rule operationId: DiscoveryService_GetAccountRule parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Model of the discovery account rule content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false delete: tags: - Discovery summary: Delete a discovery account rule description: Returns the model indicating result of the account rule delete operationId: DiscoveryService_DeleteAccountRule parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Model indicating result of delete content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountDeleteResult' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Update a discovery account rule description: Returns the updated discovery account rule operationId: DiscoveryService_UpdateAccountRule parameters: - name: id in: path description: id required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountUpdateArgs' description: args responses: '200': description: Model of the discovery account rule content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/dependencies/{id}: get: tags: - Discovery summary: Get discovery dependency rule description: Returns discovery dependency rule operationId: DiscoveryService_GetDependencyRule parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Model of the discovery dependency rule content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false delete: tags: - Discovery summary: Delete a discovery dependency rule description: Returns the model indicating result of the dependency rule delete operationId: DiscoveryService_DeleteDependencyRule parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Model indicating result of delete content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyDeleteResult' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Update a discovery dependency rule description: Returns the updated discovery dependency rule operationId: DiscoveryService_UpdateDependencyRule parameters: - name: id in: path description: id required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyUpdateArgs' description: args responses: '200': description: Model of the discovery dependency rule content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/sources: get: tags: - Discovery summary: Get discovery sources description: Returns discovery sources operationId: DiscoveryService_SearchDiscoverySources parameters: - name: filter.discoverySourceName in: query description: DiscoverySourceName required: false schema: type: string - name: filter.discoverySourceType in: query description: DiscoverySourceType required: false x-nullable: true schema: type: string - name: filter.includeActive in: query description: IncludeActive required: false x-nullable: true schema: type: boolean - name: filter.includeInactive in: query description: IncludeInactive required: false x-nullable: true schema: type: boolean - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: The Discovery Source Views content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoverySourceSummaryModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{id}: get: tags: - Discovery summary: Get discovery source description: Returns the discovery source operationId: DiscoveryService_GetDiscoverySource parameters: - name: id in: path description: Discovery Source ID required: true schema: type: integer format: int32 responses: '200': description: The Discovery Source View content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Update a discovery source description: Update an existing discovery source using the existing discovery source ID operationId: DiscoveryService_UpdateDiscoverySource parameters: - name: id in: path description: Discovery Source ID required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceUpdateArgs' description: args responses: '200': description: The updated discovery source content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/stub/{typeId}: get: tags: - Discovery summary: Get a Discovery Source Stub description: Get a Discovery Source Stub operationId: DiscoveryService_GetDiscoverySourceStub parameters: - name: typeId in: path description: Discovery Source Type ID required: true schema: type: integer format: int32 responses: '200': description: Discovery Source Stub content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/configuration: get: tags: - Discovery summary: Get Discovery Configuration description: Get Discovery Configuration operationId: DiscoveryService_GetDiscoveryConfiguration responses: '200': description: Discovery Configuration content: application/json: schema: $ref: '#/components/schemas/DiscoveryConfigurationModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Update discovery configuration description: Update discovery configuration operationId: DiscoveryService_UpdateDiscoveryConfiguration requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryConfigurationUpdateArgs' description: args responses: '200': description: The updated discovery configuration content: application/json: schema: $ref: '#/components/schemas/DiscoveryConfigurationModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/status: get: tags: - Discovery summary: Get Discovery Status description: Get Discovery Status operationId: DiscoveryService_GetDiscoveryStatus parameters: - name: includeExtendedMetrics in: query description: includeExtendedMetrics required: false schema: type: boolean responses: '200': description: Discovery Status content: application/json: schema: $ref: '#/components/schemas/DiscoveryStatusModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/available-scanners: get: tags: - Discovery summary: Get Discovery Source Available Scanners description: Get all of the scanners that can be created for this specific discovery source operationId: DiscoveryService_GetAvailableDiscoverySourceScanners parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 responses: '200': description: Discovery Scanner Types content: application/json: schema: description: Discovery Scanner Types items: $ref: '#/components/schemas/DiscoveryScannerSettingTypeSummary' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/secret-search-filters: get: tags: - Discovery summary: Search Secret Search Filters description: Search all secret search filters operationId: DiscoveryService_SearchSecretSearchFilters parameters: - name: filter.status in: query description: Whether to include active, inactive, or both. Defaults to Active only required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Discovery Secret Search Filters content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoverySecretSearchFilterSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false post: tags: - Discovery summary: Create Secret Search Filter description: Create a new Secret Search Filter. operationId: DiscoveryService_CreateSecretSearchFilter requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySecretSearchFilterCreateArgs' description: args responses: '200': description: The newly created Secret Search Filter content: application/json: schema: $ref: '#/components/schemas/DiscoverySecretSearchFilterModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/secret-search-filters/{secretSearchFilterId}: get: tags: - Discovery summary: Get Secret Search Filter description: Get the details for a single Secret Search Filter operationId: DiscoveryService_GetSecretSearchFilter parameters: - name: secretSearchFilterId in: path description: secretSearchFilterId required: true schema: type: integer format: int32 responses: '200': description: Secret Search Filter content: application/json: schema: $ref: '#/components/schemas/DiscoverySecretSearchFilterModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Patch Secret Search Filter description: Update values on a Secret Search Filter operationId: DiscoveryService_PatchSecretSearchFilter parameters: - name: secretSearchFilterId in: path description: secretSearchFilterId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySecretSearchFilterUpdateArgs' description: args responses: '200': description: Updated Secret Search Filter content: application/json: schema: $ref: '#/components/schemas/DiscoverySecretSearchFilterModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/command-sets: get: tags: - Discovery summary: Search Discovery Command Sets description: Search all discovery command sets operationId: DiscoveryService_SearchCommandSets parameters: - name: filter.scanTypeId in: query description: The ID of the scan type. 1=Find Host Ranges, 2=Find Machine, 3=Find Local Accounts, 4=Find Dependencies required: false x-nullable: true schema: type: integer format: int32 - name: filter.searchText in: query description: Only return the items that contain this text in their name required: false schema: type: string - name: filter.status in: query description: Whether to include active, inactive, or both. Defaults to Active only required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Discovery Command Sets content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryCommandSetSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false post: tags: - Discovery summary: Create command set description: Create a new SSH command set. operationId: DiscoveryService_CreateCommandSet requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetCreateArgs' description: args responses: '200': description: The newly created command set content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/command-sets/{commandSetId}: get: tags: - Discovery summary: Get Discovery Command Set description: Get the details for a single command set operationId: DiscoveryService_GetCommandSet parameters: - name: commandSetId in: path description: commandSetId required: true schema: type: integer format: int32 responses: '200': description: Discovery Command Set content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Patch Command Set description: Update values on a command set operationId: DiscoveryService_PatchCommandSet parameters: - name: commandSetId in: path description: commandSetId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetUpdateArgs' description: args responses: '200': description: Updated command set content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/command-sets/{commandSetId}/test-parameters: get: tags: - Discovery summary: Get Discovery Command Set Test Parameters description: Get the test parameters for a single command set operationId: DiscoveryService_GetCommandSetTestParameters parameters: - name: commandSetId in: path description: commandSetId required: true schema: type: integer format: int32 responses: '200': description: Discovery Command Set Test Parameters content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetTestParametersModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/base-scanners: get: tags: - Discovery summary: Search Discovery Base Scanners description: Search all discovery base scanners operationId: DiscoveryService_SearchBaseScanners parameters: - name: filter.isActive in: query description: Filter to return Base Scanners that are enabled / Disabled required: false x-nullable: true schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Discovery Base Scanners content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryBaseScannerSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners: get: tags: - Discovery summary: Search Discovery Scanners description: Search all discovery scanners operationId: DiscoveryService_SearchScanners parameters: - name: filter.discoveryItemScannerId in: query description: Only return the scanner with this ID. This will supercede all other filters. required: false x-nullable: true schema: type: integer format: int32 - name: filter.scanTypeId in: query description: 'Only return the scanners of this scan type: 1 = host, 2 = machine, 3 = account, 4 = dependency' required: false x-nullable: true schema: type: integer format: int32 - name: filter.searchText in: query description: Only return the scanners that contain this text in their name required: false schema: type: string - name: filter.status in: query description: Whether to include active, inactive, or both. Defaults to Active only required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Discovery Scanners content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryScannerSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false post: tags: - Discovery summary: Create Scanner description: Create a new scanner operationId: DiscoveryService_CreateScanner requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerCreateArgs' description: args responses: '200': description: The newly created scanner details content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners/{itemScannerId}: get: tags: - Discovery summary: Get Discovery Scanner description: Get the details for a single scanner operationId: DiscoveryService_GetScanner parameters: - name: itemScannerId in: path description: itemScannerId required: true schema: type: integer format: int32 responses: '200': description: Discovery Command Set content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Patch Scanner description: Update values on a scanner operationId: DiscoveryService_PatchScanner parameters: - name: itemScannerId in: path description: itemScannerId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerUpdateArgs' description: args responses: '200': description: Updated scanner content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners/dependency-templates: get: tags: - Discovery summary: Get Scanner Dependency Templates description: Get Scanner Dependency Templates operationId: DiscoveryService_GetScannerDependencyTemplatesAsync parameters: - name: filter.secretDependencyTypeId in: query description: If set, include only the given Secret Dependency Type. required: false x-nullable: true schema: type: integer format: int32 - name: filter.status in: query description: Whether to include active, inactive, or both. Defaults to Active only required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Dependency Templates List content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryScannerDependencyTemplateSummaryModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners/dependency-types: get: tags: - Discovery summary: Get Scanner Dependency Types description: Get Scanner Dependency Types operationId: DiscoveryService_GetScannerDependencyTypesAsync parameters: - name: filter.validForDependencyChanger in: query description: Whether to filter types only valid for a dependency changer. Defaults to false required: false x-nullable: true schema: type: boolean - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Dependency Types List content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryScannerDependencyTypeSummaryModelAndDiscoveryScannerDependencyTypeFilter' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners/dependency-template/{id}: get: tags: - Discovery summary: Get Scanner Dependency Template description: Get Scanner Dependency Template operationId: DiscoveryService_GetScannerDependencyTemplateAsync parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Dependency Template Details content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Patch Dependency Template description: Update values on a Dependency Template operationId: DiscoveryService_PatchDependencyTemplateAsync parameters: - name: id in: path description: id required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateUpdateArgs' description: args responses: '200': description: Updated Dependency Template content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scan-templates: get: tags: - Discovery summary: Get discovery scan templates description: Returns discovery scan templates operationId: DiscoveryService_SearchScanTemplates parameters: - name: filter.discoveryScanTypeId in: query description: The ID of the scan type. 1=Find Host Ranges, 2=Find Machine, 3=Find Local Accounts, 4=Find Dependencies required: false x-nullable: true schema: type: integer format: int32 - name: filter.discoverySourceId in: query description: Only return scan templates that can be returned from a discovery source required: false x-nullable: true schema: type: integer format: int32 - name: filter.includeInput in: query description: Includes the input scan item templates. required: false schema: type: boolean - name: filter.onlyIncludeBaseScanTemplates in: query description: When true only templates that do not have a parent scan template will be included. These are base or root scan templates. required: false schema: type: boolean - name: filter.searchText in: query description: Only return the items that contain this text in their name or description required: false schema: type: string - name: filter.status in: query description: Whether to include active, inactive, or both. Defaults to Active only required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Discovery Scan Template Models content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryScanTemplateSummaryModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false post: tags: - Discovery summary: Create scan template description: Create a new scan template operationId: DiscoveryService_CreateScanTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScanTemplateCreateArgs' description: args responses: '200': description: The newly created scan template details content: application/json: schema: $ref: '#/components/schemas/DiscoveryScanTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scan-templates/{scanTemplateId}: get: tags: - Discovery summary: Get Discovery Scan Template description: Get the details for a scan template operationId: DiscoveryService_GetScanTemplate parameters: - name: scanTemplateId in: path description: scanTemplateId required: true schema: type: integer format: int32 responses: '200': description: Discovery Scan Template content: application/json: schema: $ref: '#/components/schemas/DiscoveryScanTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false patch: tags: - Discovery summary: Patch scan template description: Update values on a scan template operationId: DiscoveryService_PatchScanTemplate parameters: - name: scanTemplateId in: path description: scanTemplateId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScanTemplateUpdateArgs' description: args responses: '200': description: Updated scan template content: application/json: schema: $ref: '#/components/schemas/DiscoveryScanTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/scanner-settings/search: get: tags: - Discovery summary: Get Scanner Settings description: Get all of the scanner settings for a specific discovery source operationId: DiscoveryService_SearchDiscoverySourceScannerSettings parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 responses: '200': description: Collection of scanner settings content: application/json: schema: description: Collection of scanner settings items: $ref: '#/components/schemas/DiscoveryScannerSettingSummaryModel' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scan-types: get: tags: - Discovery summary: Get Discovery Scan Types description: Get all of the scan types operationId: DiscoveryService_GetScanTypes responses: '200': description: Discovery Scan Types content: application/json: schema: description: Discovery Scan Types items: $ref: '#/components/schemas/DiscoveryScanTypeSummary' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery-source/audit: get: tags: - Discovery summary: Get Discovery Source Audits description: Get Discovery Source Audits operationId: DiscoveryService_GetDiscoverySourceAudits parameters: - name: isExporting in: query description: isExporting required: false schema: type: boolean - name: filter.discoverySourceId in: query description: DiscoverySourceId required: false x-nullable: true schema: type: integer format: int32 - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Discovery Source Audits content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoverySourceAuditModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/ou: get: tags: - Discovery summary: Get and include or exclude for discovery description: Returns the discovery source OU operationId: DiscoveryService_SearchForDomainOu parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 - name: include in: query description: Only return items that can be included required: false schema: type: boolean - name: searchText in: query description: Search for OU items containing this text required: false schema: type: string - name: selectedIds in: query description: When include is false only include items within these exisitng IDs required: false explode: true schema: type: array items: type: string - name: take in: query description: The number of items to return required: false schema: type: integer format: int32 responses: '200': description: The Discovery OU content: application/json: schema: description: The Discovery OU items: $ref: '#/components/schemas/OUModel' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{id}/filter: get: tags: - Discovery summary: Get the source filter for a discovery source description: Get the source filter for a discovery source operationId: DiscoveryService_GetDiscoverySourceFilter parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: The source filter for a discovery source content: application/json: schema: $ref: '#/components/schemas/DomainDiscoveryScopeModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/tree: get: tags: - Discovery summary: Search network tree for discovery description: Search network tree for discovery operationId: DiscoveryService_SearchNetworkTree parameters: - name: filter.discoverySourceId in: query description: Discovery Source Id. When null, returns all required: false x-nullable: true schema: type: integer format: int32 - name: filter.parentId in: query description: Parent Id. When null, uses root required: false x-nullable: true schema: type: integer format: int32 - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Paging model of the network tree content: application/json: schema: $ref: '#/components/schemas/PagingOfNetworkTreeSummaryModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/items: get: tags: - Discovery summary: Search discovery network items description: Returns items that have been discovered and are linked in a discovery source and network tree operationId: DiscoveryService_SearchNetworkItems parameters: - name: filter.createdEndDate in: query description: If set, used to return results that have a created date less than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.createdStartDate in: query description: If set, used to return results that have a created date greater than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.discoveryRuleId in: query description: Filter for items that will be imported by a specific rule required: false x-nullable: true schema: type: integer format: int32 - name: filter.discoverySourceId in: query description: Search for items with this Discovery Source Id required: false x-nullable: true schema: type: integer format: int32 - name: filter.hasComputerAccounts in: query description: If set, used to filter whether the item has computer accounts required: false x-nullable: true schema: type: boolean - name: filter.itemType in: query description: 'Used to filter the item type that should be returned. Empty will return all item types or use: account, computer, key, service-account...' required: false schema: type: string - name: filter.lastPolledEndDate in: query description: If set, used to return results that have a last polled date less than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.lastPolledStartDate in: query description: If set, used to return results that have a last polled date greater than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.lastReachedEndDate in: query description: If set, used to return results that have a last reached date less than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.lastReachedStartDate in: query description: If set, used to return results that have a last reached date greater than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.managed in: query description: If set, used to filter whether the item is managed or unmanaged required: false x-nullable: true schema: type: boolean - name: filter.operatingSystem in: query description: Search for items with this operating system required: false schema: type: string - name: filter.organizationalUnitId in: query description: Search for items with this Organizational Unit Id required: false x-nullable: true schema: type: integer format: int32 - name: filter.scanItemTemplateId in: query description: If set, used to filter the scan template id required: false x-nullable: true schema: type: integer format: int32 - name: filter.searchChildren in: query description: If set then return all descendants, if false only return immediate children. required: false x-nullable: true schema: type: boolean - name: filter.searchText in: query description: Search for items with this name required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Paging model of the network items content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryNetworkItemSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/computer/{id}: get: tags: - Discovery summary: Get discovery network computer detail description: Returns details for a computer that has been discovered and are linked in a discovery source and network tree operationId: DiscoveryService_GetNetworkComputerItem parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Computer detail content: application/json: schema: $ref: '#/components/schemas/DiscoveryNetworkComputerItemDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/computer/scan/logs: get: tags: - Discovery summary: Gets the computer scan logs. description: Gets the computer scan logs based on the filter criteria. operationId: DiscoveryService_GetComputerScanLogs parameters: - name: filter.computerId in: query description: Computer Id to filter on. required: false x-nullable: true schema: type: integer format: int32 - name: filter.discoveryItemScannerId in: query description: Scanner Id to filter on. required: false x-nullable: true schema: type: integer format: int32 - name: filter.discoverySourceId in: query description: Discovery Source Id to filter on. required: false x-nullable: true schema: type: integer format: int32 - name: filter.logLevel in: query description: If null it will return all, if false it will return errors, if true it will return successes required: false x-nullable: true schema: type: boolean - name: filter.scanEndDate in: query description: If set, used to return results that have a scan date less than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.scanItemTemplateId in: query description: Template Id to filter on. required: false x-nullable: true schema: type: integer format: int32 - name: filter.scanStartDate in: query description: If set, used to return results that have a scan date greater than or equal to the value. required: false x-nullable: true schema: type: string format: date-time - name: filter.searchText in: query description: Will filter the log message based on the search text required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Paging model of the computer scan logs. content: application/json: schema: $ref: '#/components/schemas/PagingOfNetworkComputerLogModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/computer-account/{id}: get: tags: - Discovery summary: Get discovery network computer account detail description: Returns a computer account that has been discovered and is linked in a discovery source and network tree operationId: DiscoveryService_GetNetworkComputerAccount parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Computer account detail content: application/json: schema: $ref: '#/components/schemas/DiscoveryNetworkComputerAccountItemDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/service-account/{id}: get: tags: - Discovery summary: Get discovery network service account detail description: Returns a service account that has been discovered and is linked in a discovery source and network tree operationId: DiscoveryService_GetNetworkServiceAccount parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: service account detail content: application/json: schema: $ref: '#/components/schemas/DiscoveryNetworkServiceAccountItemDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/public-key/{id}: get: tags: - Discovery summary: Get discovery network public key detail description: Returns a public key that has been discovered and is linked in a discovery source and network tree operationId: DiscoveryService_GetNetworkPublicKey parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: public keys detail content: application/json: schema: $ref: '#/components/schemas/DiscoveryNetworkPublicKeyItemDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/directory-account/{id}: get: tags: - Discovery summary: Get discovery network directory account detail description: Returns a directory account that has been discovered and is linked in a discovery source and network tree operationId: DiscoveryService_GetNetworkDirectoryAccount parameters: - name: id in: path description: id required: true schema: type: integer format: int32 responses: '200': description: Directory account detail content: application/json: schema: $ref: '#/components/schemas/DiscoveryNetworkDirectoryAccountItemDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/accounts: get: tags: - Discovery summary: Search discovery account rules description: Returns discovery account rules operationId: DiscoveryService_SearchRulesAccounts parameters: - name: filter.discoverySourceId in: query description: Only include rules that apply to this discovery source required: false x-nullable: true schema: type: integer format: int32 - name: filter.statusFilter in: query description: 'Which status types to include: All, Active, Inactive' required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Paging model of the discovery account rules content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryRuleAccountSummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false post: tags: - Discovery summary: Create a discovery account rule description: Returns the created discovery account rule operationId: DiscoveryService_CreateAccountRule requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountCreateArgs' description: args responses: '200': description: Model of the discovery account rule content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/dependencies: get: tags: - Discovery summary: Search discovery dependency rules description: Returns discovery dependency rules operationId: DiscoveryService_SearchRulesDependencies parameters: - name: filter.discoverySourceId in: query description: Only include rules that apply to this discovery source required: false x-nullable: true schema: type: integer format: int32 - name: filter.statusFilter in: query description: 'Which status types to include: All, Active, Inactive' required: false schema: type: string - name: skip in: query description: Number of records to skip before taking results required: false schema: type: integer format: int32 - name: sortBy[0].direction in: query description: Sort direction required: false schema: type: string - name: sortBy[0].name in: query description: Sort field name required: false schema: type: string - name: sortBy[0].priority in: query description: Priority index. Sorts with lower values are executed earlier required: false schema: type: integer format: int32 - name: take in: query description: Maximum number of records to include in results required: false schema: type: integer format: int32 responses: '200': description: Paging model of the discovery dependency rules content: application/json: schema: $ref: '#/components/schemas/PagingOfDiscoveryRuleDependencySummary' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false post: tags: - Discovery summary: Create a discovery dependency rule description: Returns the created discovery dependency rule operationId: DiscoveryService_CreateDependencyRule requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyCreateArgs' description: args responses: '200': description: Model of the discovery dependency rule content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyDetail' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/accounts/state: get: tags: - Discovery summary: Get discovery account rule state description: Returns discovery account rule state operationId: DiscoveryService_GetAccountRuleState responses: '200': description: Model of the discovery account rule state content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountState' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/accounts/info/{secretTemplateId}: get: tags: - Discovery summary: Get discovery account rule info description: Returns discovery account rule info operationId: DiscoveryService_GetAccountRuleInfo parameters: - name: secretTemplateId in: path description: secretTemplateId required: true schema: type: integer format: int32 responses: '200': description: Model of the discovery account rule info content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountInfo' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/secret-templates/{scanTemplateId}: get: tags: - Discovery summary: Get discovery rule secret templates description: Returns discovery rule secret templates operationId: DiscoveryService_GetRuleSecretTemplates parameters: - name: scanTemplateId in: path description: scanTemplateId required: true schema: type: integer format: int32 responses: '200': description: Paging model of the discovery rule secret templates content: application/json: schema: description: Paging model of the discovery rule secret templates items: $ref: '#/components/schemas/DiscoveryRuleSecretTemplate' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/scan-item-fields/{scanTemplateId}: get: tags: - Discovery summary: Get discovery rule scan item fields description: Returns discovery rule scan item fields operationId: DiscoveryService_GetRuleDiscoveryRuleScanItemFields parameters: - name: scanTemplateId in: path description: scanTemplateId required: true schema: type: integer format: int32 responses: '200': description: Paging model of the discovery rule scan item fields content: application/json: schema: description: Paging model of the discovery rule scan item fields items: $ref: '#/components/schemas/DiscoveryRuleScanItemField' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/dependencies/info/{scanTemplateId}: get: tags: - Discovery summary: Get discovery dependency rule info description: Returns discovery dependency rule info operationId: DiscoveryService_GetDependencyRuleInfo parameters: - name: scanTemplateId in: path description: scanTemplateId required: true schema: type: integer format: int32 responses: '200': description: Model of the discovery dependency rule info content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencyInfo' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/folder/{folderId}: get: tags: - Discovery summary: Get discovery rules for a folder description: Returns discovery rules for a folder operationId: DiscoveryService_GetRulesForFolder parameters: - name: folderId in: path description: folderId required: true schema: type: integer format: int32 responses: '200': description: Array of folder discovery rules content: application/json: schema: description: Array of folder discovery rules items: $ref: '#/components/schemas/FolderDiscoveryImportRuleModel' type: array '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/filter/{memberId}: patch: tags: - Discovery summary: Patches discovery source filter description: Patches the properties on a single discovery source filter operationId: DiscoveryService_PatchDiscoverySourceFilter parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 - name: memberId in: path description: memberId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceFilterPatchArgs' description: args responses: '200': description: 'True' content: application/json: schema: $ref: '#/components/schemas/DomainDiscoveryScopeFilterModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v2/discovery/source: post: tags: - Discovery summary: Create a new discovery source description: Create an empty discovery source that does not have any scanners. operationId: DiscoveryService_CreateDiscoverySourceV2 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceCreateArgsV2' description: args responses: '200': description: The new discovery source content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/active-directory: post: tags: - Discovery summary: Create a new active directory discovery source description: Creates a new active directory discovery source operationId: DiscoveryService_CreateActiveDirectoryDiscoverySource requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceCreateArgs' description: args responses: '200': description: The new discovery source content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/run: post: tags: - Discovery summary: Run a discovery command description: Run a discovery command operationId: DiscoveryService_RunDiscoveryNow requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRunArgs' description: args responses: '200': description: true to indicate the command was triggered content: application/json: schema: description: Boolean type: boolean '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/command-sets/{commandSetId}/test: post: tags: - Discovery summary: Test Discovery Command Set description: Test the discover command set operationId: DiscoveryService_TestCommandSet requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetTestArgs' description: args responses: '200': description: The results of the test content: application/json: schema: $ref: '#/components/schemas/DiscoveryCommandSetTestResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners/duplicate: post: tags: - Discovery summary: Duplicate Scanner description: Duplicate a new scanner operationId: DiscoveryService_DuplicateScanner requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDuplicateArgs' description: args responses: '200': description: The newly duplicated scanner details content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/scanners/dependency-template: post: tags: - Discovery summary: Create a Dependency Template description: Create a new Dependency Template operationId: DiscoveryService_CreateDependencyTemplateAsync requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateCreateArgs' description: args responses: '200': description: The newly created Dependency Template details content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/scanners: post: tags: - Discovery summary: Add Scanner to discovery source description: Add the specified scanner to this discovery source. After adding the scanner the scanner it will initially be invalid until the scanner map and scanner credentials have been updated. operationId: DiscoveryService_AddDiscoverySourceScanner parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDetailCreateArgs' description: args responses: '200': description: The newly created scanner details content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerDetailModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/scanners/sort: post: tags: - Discovery summary: Sort Scanner description: Sorts the scanners for execution. operationId: DiscoveryService_SortScanner parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerSortArgs' description: args responses: '200': description: Whether or not the sort was successful. content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerSortResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/scanner-settings: post: tags: - Discovery summary: Create scanner setting description: Create a scanner setting on a discovery source operationId: DiscoveryService_CreateDiscoverySourceScannerSettings parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerSettingCreateArgs' description: args responses: '200': description: New scanner setting content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerSettingViewModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/computer/scan: post: tags: - Discovery summary: Run a scan on the specified computer description: Run a scan on the specified computer operationId: DiscoveryService_ScanComputer requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryComputerScanArgs' description: args responses: '200': description: Result model to indicate whether the scan was initiated. content: application/json: schema: $ref: '#/components/schemas/DiscoveryComputerScanResultsModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/network/item/computer/delete: post: tags: - Discovery summary: Delete the specified computers description: Delete the specified computers operationId: DiscoveryService_DeleteComputers requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryComputerDeleteArgs' description: args responses: '200': description: Result model to indicate success of each deletion. content: application/json: schema: $ref: '#/components/schemas/DiscoveryComputerDeleteResultsModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/dependencies/import: post: tags: - Discovery summary: Discovery Dependency Import Bulk Operation description: Starts a discovery dependency import bulk operation operationId: DiscoveryService_DiscoveryDependencyImport requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryDependencyImportArgs' description: args responses: '200': description: Returns bulk operation response content: application/json: schema: $ref: '#/components/schemas/BulkOperationResponseMessage' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/account/import: post: tags: - Discovery summary: Discovery Account Import Bulk Operation description: Starts a discovery account import bulk operation operationId: DiscoveryService_DiscoveryAccountImport requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryImportArgs' description: args responses: '200': description: Returns bulk operation response content: application/json: schema: $ref: '#/components/schemas/BulkOperationResponseMessage' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/accounts/sort: post: tags: - Discovery summary: Sort Rule Accounts description: Sorts the Rule Accounts. operationId: DiscoveryService_SortRuleAccounts requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountSortArgs' description: args responses: '200': description: Whether or not the sort was successful. content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleAccountSortResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/rules/dependencies/sort: post: tags: - Discovery summary: Sort Rule Dependencies description: Sorts the Rule Dependencies. operationId: DiscoveryService_SortRuleDependencies requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencySortArgs' description: args responses: '200': description: Whether or not the sort was successful. content: application/json: schema: $ref: '#/components/schemas/DiscoveryRuleDependencySortResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/scanners/{discoveryItemScannerId}/credentials: put: tags: - Discovery summary: Save scanner credentials description: Completely replace all the scanner credentials with this list operationId: DiscoveryService_SaveDiscoveryScannerCredentials parameters: - name: discoveryItemScannerId in: path description: discoveryItemScannerId required: true schema: type: integer format: int32 - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerCredentialsArgs' description: args responses: '200': description: Success result content: application/json: schema: $ref: '#/components/schemas/DiscoveryUpdateCredentialsResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/scanners/{discoveryItemScannerId}/settings: put: tags: - Discovery summary: Save scanner settings description: Completely replace all the scanner settings for this scanner operationId: DiscoveryService_SaveDiscoveryScannerSettings parameters: - name: discoveryItemScannerId in: path description: discoveryItemScannerId required: true schema: type: integer format: int32 - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoveryScannerSettingsArgs' description: args responses: '200': description: Success result content: application/json: schema: $ref: '#/components/schemas/DiscoveryUpdateSettingsResultModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false /v1/discovery/source/{discoverySourceId}/filters: put: tags: - Discovery summary: Updates discovery source filters description: Updates the full collection of discovery source filters for a discovery source operationId: DiscoveryService_UpdateDiscoverySourceFilters parameters: - name: discoverySourceId in: path description: discoverySourceId required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiscoverySourceFiltersUpdateArgs' description: args responses: '200': description: The source filter for a discovery source content: application/json: schema: $ref: '#/components/schemas/DomainDiscoveryScopeModel' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' deprecated: false components: schemas: DiscoverySecretSearchFilterCreateArgs: description: DiscoverySecretSearchFilterCreateArgs properties: data: $ref: '#/components/schemas/DiscoverySecretSearchFilterCreateData' type: object DiscoveryNetworkOsItemSummary: description: Operating Systems that were discovered and appear in the network view properties: operatingSystem: description: Operating System type: string operatingSystemCount: description: Number of occurences of Operating System type: integer format: int32 type: object DiscoveryDependencyTemplateSummary: description: Dependency templates used for creating a dependency rule properties: secretDependencyTemplateId: description: Secret Dependency Template ID type: integer format: int32 secretDependencyTemplateName: description: Secret Dependency Template Name type: string type: object DiscoveryNetworkComputerItemDetail: description: Computer Item that was discovered and appear in the network view properties: accountTotal: description: Number of Accounts associated to this Network Item type: integer format: int32 nullable: true computerAccounts: description: Computer Accounts associated to this Network Item items: $ref: '#/components/schemas/DiscoveryNetworkComputerAccount' type: array createdDate: description: Date Item was Created type: string format: date-time description: description: Description type: string discoveryItemScannerId: description: Discovery Item Scanner Id type: integer format: int32 nullable: true discoveryItemScannerName: description: Discovery Item Scanner Name type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string displayName: description: Display Name type: string distinguishedName: description: Distinguished Name type: string dnsHostName: description: DNS Host Name type: string lastErrorMessage: description: Last Error Message type: string lastLogon: description: Last Logon type: string format: date-time nullable: true lastPolledDate: description: Date Item was Last Polled type: string format: date-time nullable: true lastReachedDate: description: Date Item was Last Reached type: string format: date-time nullable: true networkItemId: description: The Id of this Network Item type: integer format: int32 organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true organizationUnitName: description: Organization Unit Name type: string publicKeyAccounts: description: Public Key Accounts associated to this Network Item items: $ref: '#/components/schemas/DiscoveryNetworkPublicKeyAccount' type: array scanItemTemplateId: description: Scan Item Template Id type: integer format: int32 nullable: true scanItemTemplateName: description: Scan Item Template Name type: string serviceAccounts: description: Service Accounts associated to this Network Item items: $ref: '#/components/schemas/DiscoveryNetworkServiceAccount' type: array type: object SortDirection: description: Sort direction properties: {} type: string enum: - None - Asc - Desc MachineNameResolutionType: description: Use machine name and FQDM or only use machine name properties: {} type: string enum: - UseMachineNameAndFQDM - OnlyUseMachineName DiscoverySourceFiltersUpdateModel: description: Data properties: filters: description: Filters items: $ref: '#/components/schemas/DomainDiscoveryScopeFilterUpdateModel' type: array type: object DiscoverySourceCreateModel: description: Data properties: active: description: Is discovery source active type: boolean discoverSpecificOUs: description: Discover specific OUs type: boolean discoveryScannerId: description: Discovery scanner ID type: string nullable: true discoverySourceSettings: $ref: '#/components/schemas/DiscoverySourceSettingsCreateModel' lastDiscoveryRunDate: description: Last discovery run date type: string format: date-time nullable: true machineNameResolutionType: $ref: '#/components/schemas/MachineNameResolutionType' name: description: The discovery source name type: string secretId: description: Discovery Secret credential type: integer format: int32 nullable: true siteId: description: The site ID type: integer format: int32 type: object DiscoveryNetworkComputerAccount: description: Discovery Network Computer Account properties: accountName: description: Account Name type: string canLaunch: description: Can Launch type: boolean computerAccountId: description: Computer Account Id type: integer format: int32 secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object PasswordOptionEnum: description: Password Option properties: {} type: string enum: - Current - ChangeTo - Random - PrivateKey - PublicKey UpdateFieldValueOfInt32Array: description: FolderIds properties: dirty: description: Dirty type: boolean value: description: Value items: type: integer format: int32 type: array type: object DomainDiscoveryScopeFilterPatchModel: description: A filter on a domain scope properties: scanTargetType: $ref: '#/components/schemas/UpdateFieldValueOfScanTargetType' secretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' siteId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' type: object DiscoveryCommandType: description: CommandType properties: {} type: string enum: - Discovery - ComputerScan DiscoveryCommandSetTestArgs: description: Test args for a command set properties: data: $ref: '#/components/schemas/DiscoveryCommandSetTestData' type: object UpdateFieldValueOfOptionalInt32: description: The minimum length required for local user passwords properties: dirty: description: Dirty type: boolean value: description: Value type: integer format: int32 nullable: true type: object DiscoveryRuleAccountState: description: Discovery Rule Account State properties: emailEnabled: description: Email Enabled type: boolean rpcEnabled: description: RPC Enabled type: boolean type: object DiscoveryRuleAccountDetail: description: Discovery Rule Account Detail properties: accountAlerts: description: Account Alerts type: boolean accountNameContains: description: Partial search of Account Name type: string actionCreateSecrets: description: Action Create Secrets. Set to true when secrets are to be created. type: boolean computerNameContains: description: Partial search of Computer Name type: string currentPassphrase: description: Current Passphrase type: string currentPassword: description: Curent Password type: string currentPrivateKey: description: Current Private Key type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string filterFields: description: Filter Fields. Dynamic filters for the selected Scan Template items: $ref: '#/components/schemas/DiscoveryRuleScanItemFilter' type: array folderId: description: Folder Id where will the new Secrets get created type: integer format: int32 nullable: true folderName: description: Folder Name where will the new Secrets get created type: string importOnlyPolledLastScan: description: Import only those polled in last scan type: boolean includeChildOUs: description: Include Child OUs type: boolean isActive: description: Is Active type: boolean matchingCondition: $ref: '#/components/schemas/MatchingConditionEnum' newPassword: description: New Password type: string operatingSystemContains: description: Partial search of Operating System type: string organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true organizationUnitName: description: Organization Unit Name type: string passwordChangingPrivilegedAccountSecretIds: description: Secrets of Privileged Account used for Password Changing items: $ref: '#/components/schemas/DiscoveryRuleSecret' type: array passwordChangingType: $ref: '#/components/schemas/PasswordChangingTypeEnum' passwordOption: $ref: '#/components/schemas/PasswordOptionEnum' ruleDescription: description: Rule Description type: string ruleId: description: Rule Id type: integer format: int32 ruleName: description: Rule Name type: string scanTemplateId: description: Scan Template Id type: integer format: int32 scanTemplateName: description: Scan Template Name type: string secretNamePattern: description: Pattern used for naming secrets type: string secretPermissions: $ref: '#/components/schemas/SecretPermissionEnum' secretTemplateId: description: Secret Template Id type: integer format: int32 nullable: true secretTemplateName: description: Secret Template Name type: string siteId: description: Site Id type: integer format: int32 subscribedSpecificGroups: description: Groups for subscription items: $ref: '#/components/schemas/DiscoveryRuleSubscribedGroup' type: array subscriberType: $ref: '#/components/schemas/SubscriberTypeEnum' takeOverAccountType: $ref: '#/components/schemas/TakeOverAccountTypeEnum' takeOverPasswordTypeId: description: Take Over Password Type Id type: integer format: int32 nullable: true takeoverSecretIds: description: Secrets used for Takeover items: $ref: '#/components/schemas/DiscoveryRuleSecret' type: array takeOverThreshold: description: Take Over Threshold type: integer format: int32 type: object DiscoveryScannerDetailCreateArgs: description: DiscoveryScannerDetailCreateArgs properties: data: $ref: '#/components/schemas/DiscoveryScannerDetailCreateModel' type: object DiscoveryRuleAccountCreateModel: description: Discovery Rule Account Create Model properties: accountAlerts: description: Account Alerts type: boolean accountNameContains: description: Partial search of Account Name type: string actionCreateSecrets: description: Action Create Secrets. Set to true when secrets are to be created. type: boolean computerNameContains: description: Partial search of Computer Name type: string currentPassphrase: description: Current Passphrase type: string currentPassword: description: Current Password type: string currentPrivateKey: description: Current Private Key type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true filterFields: description: Filter Fields. Dynamic filters for the selected Scan Template items: $ref: '#/components/schemas/DiscoveryRuleScanItemFilter' type: array folderId: description: Folder Id where will the new Secrets get created type: integer format: int32 nullable: true importOnlyPolledLastScan: description: Import only those polled in last scan type: boolean includeChildOUs: description: Include Child OUs type: boolean isActive: description: Is Active type: boolean matchingCondition: description: Whether to 'and' or 'or' ComputerNameContains and AccountNameContains type: string nullable: true newPassword: description: New Password type: string operatingSystemContains: description: Partial search of Operating System type: string organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true passwordChangingPrivilegedAccountSecretIds: description: Ids of Secrets of Privileged Account used for Password Changing items: type: integer format: int32 type: array passwordChangingType: $ref: '#/components/schemas/PasswordChangingTypeEnum' passwordOption: description: Password Option type: string nullable: true ruleDescription: description: Rule Description type: string ruleName: description: Rule Name type: string scanTemplateId: description: Scan Template Id type: integer format: int32 secretNamePattern: description: Pattern used for naming secrets type: string secretPermissions: description: Secret Permissions type: string nullable: true secretTemplateId: description: Secret Template Id type: integer format: int32 nullable: true siteId: description: Site Id type: integer format: int32 nullable: true subscribedSpecificGroupIds: description: Groups for subscription items: type: integer format: int32 type: array subscriberType: $ref: '#/components/schemas/SubscriberTypeEnum' takeOverAccountType: $ref: '#/components/schemas/TakeOverAccountTypeEnum' takeOverPasswordTypeId: description: Take Over Password Type Id type: integer format: int32 nullable: true takeoverSecretIds: description: Ids of Secrets used for Takeover items: type: integer format: int32 type: array takeOverThreshold: description: Take Over Threshold type: integer format: int32 type: object DiscoveryRunModel: description: Data properties: commandType: $ref: '#/components/schemas/DiscoveryCommandType' type: object DiscoveryScannerDependencyTemplateSummaryModel: description: Discovery Scanner Dependency Template Summary properties: active: description: Indicates if the Dependency Template is active. type: boolean secretDependencyTemplateId: description: The Id of the Dependency Template. type: integer format: int32 secretDependencyTemplateName: description: The name of the Dependency Template. type: string secretDependencyTypeId: description: The Dependency Type Id of the Dependency Template. type: integer format: int32 secretDependencyTypeName: description: The Dependency Type Name of the Dependency Template. type: string type: object DiscoveryUpdateCredentialsResultModel: description: Result of updating discovery scanner credentials properties: success: description: Indicates if the update was successful type: boolean type: object DiscoveryComputerDeleteArgs: description: DiscoveryComputerDeleteArgs properties: data: description: Data items: type: integer format: int32 type: array type: object DiscoveryRuleAccountSummary: description: Discovery Rule Account Summary properties: discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string folderId: description: Folder Id where will the new Secrets get created type: integer format: int32 nullable: true folderName: description: Folder Name where will the new Secrets get created type: string isActive: description: Is Active type: boolean ruleAction: description: When a match is found this action is taken type: string ruleDescription: description: Rule Description type: string ruleId: description: Rule Id type: integer format: int32 ruleName: description: Rule Name type: string ruleSummary: description: A descriptive summary of what the rule does type: string scanTemplateId: description: Scan Template Id type: integer format: int32 scanTemplateName: description: Scan Template Name type: string secretTemplateId: description: Secret Template Id type: integer format: int32 nullable: true secretTemplateName: description: Secret Template Name type: string sortOrder: description: Sort Order type: integer format: int32 takeOverThreshold: description: Take Over Threshold type: integer format: int32 type: object PagingOfDiscoveryNetworkItemSummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryNetworkItemSummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryCommandSetCreateArgs: description: Create command set args properties: data: $ref: '#/components/schemas/DiscoveryCommandSetCreateData' type: object UpdateFieldValueOfDiscoverySourceSettingsUpdateModel: description: Additional discovery settings properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/DiscoverySourceSettingsUpdateModel' type: object DiscoveryRuleAccountDeleteResult: description: Discovery Rule Account Delete Result properties: success: description: Success type: boolean type: object DiscoveryCommandSetUpdateData: description: Actual model updates for a command set properties: commands: $ref: '#/components/schemas/UpdateFieldValueOfString' commandSetName: $ref: '#/components/schemas/UpdateFieldValueOfString' discoveryScannerId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' isActive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' scanTypeId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object DiscoveryScannerDependencyTemplateUpdateData: description: Update a Dependency Template properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' scanItemTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' secretDependencyChangerId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' secretDependencyTemplateDescription: $ref: '#/components/schemas/UpdateFieldValueOfString' secretDependencyTemplateName: $ref: '#/components/schemas/UpdateFieldValueOfString' secretDependencyTypeId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object DiscoveryScanTemplateCreateFieldModel: description: Define a field when creating a scan template properties: includeInMatch: description: Include this field in the matching to identify if this is a unique scanned item type: boolean parentScanItemFieldId: description: Which field does this field inherit type: integer format: int32 nullable: true scanItemFieldName: description: Name of the scan field type: string type: object DiscoveryScannerDetailModel: description: Scanner details properties: canEdit: description: Can the scanner be edited type: boolean credentials: description: The credentials used by this discovery source items: $ref: '#/components/schemas/DiscoveryScannerCredentialModel' type: array discoveryItemScannerDescription: description: The description of the scanner type: string discoveryItemScannerDisplayName: description: The localized name of the scanner type: string discoveryItemScannerId: description: The ID for the instance of this scanner type for this discovery source type: integer format: int32 discoveryItemScannerName: description: The name of the scanner type: string discoveryScannerId: description: The ID for the type of scanner type: integer format: int32 discoverySourceId: description: Which discovery source is this scanner associated to type: integer format: int32 inputScanItemTemplateDisplayName: description: The localized name of the input template type: string inputScanItemTemplateId: description: The input template for this scanner type: integer format: int32 inputScanItemTemplateName: description: The name of the input template type: string isActive: description: Is this scanner active type: boolean outputScanItemTemplateDisplayName: description: The localized name of the output scan template type: string outputScanItemTemplateId: description: The output scan template ID type: integer format: int32 outputScanItemTemplateName: description: The name of the output scan template type: string scannerItems: description: The scanner settings for this scanner on this discovery source items: $ref: '#/components/schemas/DiscoveryScannerDetailItemModel' type: array sortOrder: description: The sort order for this scanner type: integer format: int32 type: object DiscoveryCommandSetUpdateArgs: description: Update args for a command set properties: data: $ref: '#/components/schemas/DiscoveryCommandSetUpdateData' type: object DiscoveryComputerScanResultModel: description: Individual computer scan results. properties: computerId: description: Computer Id the scan was started on. type: integer format: int32 computerName: description: Name of the computer the scan was started on. type: string statuses: description: Indicates the status of the individual scans. items: $ref: '#/components/schemas/DiscoveryComputerScanStatusResultModel' type: array success: description: Will return true if all scans initiated successfully. type: boolean type: object PagingOfDiscoveryBaseScannerSummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryBaseScannerSummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object UpdateFieldValueOfMachineNameResolutionType: description: Use machine name and FQDM or only use machine name properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/MachineNameResolutionType' type: object DiscoveryScanTemplateFieldModel: description: Scan template field properties: includeInMatch: description: Include this field in the matching to find unique items type: boolean isActive: description: indicates if this field is active type: boolean isRequired: description: Indicates if this field is required type: boolean parentScanItemFieldId: description: The ID of the parent field type: integer format: int32 nullable: true parentScanItemFieldName: description: The name of the parent field type: string scanItemFieldId: description: Scan template field ID type: integer format: int32 scanItemFieldName: description: The name of the field type: string scanItemTemplateId: description: Which scan template does this field belong to type: integer format: int32 sortOrder: description: The sort order for this field type: integer format: int32 systemField: description: IS this a system field type: boolean type: object DiscoveryScanTypeSummary: description: DiscoveryScanTypeSummary[] properties: discoveryScanTypeId: description: Discovery Scan Type Id type: integer format: int32 scanTypeDescription: description: Scan Type Description type: string scanTypeName: description: Scan Type Name type: string type: object DiscoveryScannerCredentialsArgs: description: DiscoveryScannerCredentialsArgs properties: data: $ref: '#/components/schemas/DiscoveryScannerCredentialsData' type: object DiscoveryRuleSubscribedGroup: description: Discovery Rule Subscribed Group properties: groupId: description: Group Id type: integer format: int32 groupName: description: Group Name type: string type: object DiscoverySourceSettingsModel: description: Additional settings for discovery source properties: daysToKeepMachines: description: Days To Keep Machines type: string nullable: true distinguishedName: description: The domain distinguished name type: string domainType: description: 'Domain type: ActiveDirectory, OpenLdap, or AzureActiveDirectory' type: string nullable: true friendlyName: description: The domain friendly name type: string fullyQualifiedDomainName: description: The fully qualified domain name type: string netBIOSName: description: The NetBIOS name type: string useSecureLDAP: description: Use secure LDAP type: boolean type: object SubscriberTypeEnum: description: Subscriber Type properties: {} type: string enum: - Admins - SpecificUsers PagingOfNetworkTreeSummaryModel: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/NetworkTreeSummaryModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryCommandSetTestResultModel: description: The result of the command set test properties: success: description: Success type: boolean type: object DiscoveryScanTemplateModel: description: Discovery scan template properties: actions: $ref: '#/components/schemas/DiscoveryScanTemplateActionsModel' concurrencyId: description: Globally unique ID for this scan template type: string isActive: description: Indicates if this template is active type: boolean isInUse: description: Will return true if in use. A scan template cannot be modified once it is in use. type: boolean parentConcurrencyId: description: The globally unique id of the parent template if it has one type: string parentScanTemplateId: description: The ID of the parent template if it has one type: integer format: int32 nullable: true parentScanTemplateName: description: The name of the parent scan template type: string scanTemplateFields: description: The fields on this template items: $ref: '#/components/schemas/DiscoveryScanTemplateFieldModel' type: array scanTemplateId: description: The unique ID for this scan template type: integer format: int32 scanTemplateName: description: The name of this template type: string scanTypeId: description: The scan type ID type: integer format: int32 scanTypeName: description: The name of the scan type type: string type: object Sort: description: Sort options. Multiple sort options can be provided in the query string. required: - name - direction properties: direction: $ref: '#/components/schemas/SortDirection' name: description: Sort field name type: string priority: description: Priority index. Sorts with lower values are executed earlier type: integer format: int32 type: object UpdateFieldValueOfBoolean: description: Active properties: dirty: description: Dirty type: boolean value: description: Value type: boolean type: object DiscoveryNetworkItemSummary: description: Items that were discovered and appear in the network view properties: accountTotal: description: Number of Accounts associated to this Network Item type: integer format: int32 nullable: true createdDate: description: Date Item was Created type: string format: date-time description: description: Description type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string displayName: description: Display Name type: string fullName: description: Full Name type: string hasError: description: Indicates that the item has an error type: boolean nullable: true hasLocalAdminRights: description: If the item is a local computer account this will indicate if the account has local admin rights. If not, it will be null. type: boolean nullable: true hostEnvironment: description: If the item is a computer or related to a computer, this will be the OS of that computer. If not, it will be null. type: string hostId: description: Host Id type: integer format: int32 nullable: true hostName: description: Host Name type: string isLocalAdministrator: description: If the item is a local computer account this will indicate if the account is a local administrator. If not, it will be null. type: boolean nullable: true isManaged: description: Is the item already managed as a secret or dependency type: boolean itemType: description: The Type of this Network Item type: string itemTypeDisplayName: description: The Display Name of the Type of this Network Item type: string lastLogon: description: If the item is a local computer, this will be the date of the last Logon on this Item. If not, it will be null. type: string format: date-time nullable: true lastPolledDate: description: Date Item was Last Polled type: string format: date-time nullable: true lastReachedDate: description: Date Item was Last Reached type: string format: date-time nullable: true networkItemId: description: The Id of this Network Item type: integer format: int32 passwordExpirationStatus: description: The status of the password expiration on this item. Will be null for a computer. type: string passwordLastSet: description: Indicates the last time the password was changed on this item. Will be null for a computer type: string format: date-time nullable: true scanItemTemplateId: description: Scan Item Template Id type: integer format: int32 nullable: true scanItemTemplateName: description: Scan Item Template Name type: string searchGroups: description: If the item is a computer account, these are the groups that the discovered account is a member of. If not, it will be null. type: string secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object BulkOperationResponseMessage: description: BulkOperationResponseMessage properties: bulkOperationId: description: BulkOperationId type: string type: object RemoveDiscoveryScannerResultModel: description: RemoveDiscoveryScannerResultModel properties: success: description: Success type: boolean type: object DiscoveryBaseScannerSummary: description: Base scanner properties: active: description: Indicates if this base scanner is active type: boolean scannerId: description: ID of the base scanner type: integer format: int32 scannerTypeName: description: The scanner type name type: string supportsDiscoveryScanTypeId: description: Indicate which scan types this base scanner supports items: type: integer format: int32 type: array type: object DiscoveryRuleAccountUpdateArgs: description: Discovery Rule Account Update Args properties: data: $ref: '#/components/schemas/DiscoveryRuleAccountUpdateModel' type: object DiscoveryRuleAccountInfo: description: Discovery Rule Account Info properties: isKeyType: description: Is Key Type type: boolean passwordTypeIdsForPasswordChanging: description: Password Type Ids for Password Changing Secret Filter items: type: integer format: int32 type: array passwordTypesForTakeOver: description: Password Types for Take Over items: $ref: '#/components/schemas/DiscoveryRulePasswordType' type: array requiresTakeover: description: Requires Takeover type: boolean rpcRequiresPrivilege: description: RPC Requires Privilege type: boolean secretFieldNameForMachine: description: Secret Field Name For Machine type: string takeOverAccountType: $ref: '#/components/schemas/TakeOverAccountTypeEnum' type: object PagingOfDiscoverySourceSummaryModel: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoverySourceSummaryModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryStatusModel: description: DiscoveryStatusModel properties: actions: description: Actions the current user can perform for Discovery items: $ref: '#/components/schemas/DiscoveryActionType' type: array discoveryComputerScanEndDateTime: description: The date and time the Scan Computer messages completed queueing last. type: string format: date-time nullable: true discoveryComputerScanStartDateTime: description: The date and time Scan Computer messages last started. type: string format: date-time nullable: true discoveryFetchEndDateTime: description: The date and time the Host Range and Machine fetching last completed. This will be empty if a synchronization has never been run. type: string format: date-time nullable: true discoveryFetchStartDateTime: description: The date and time the Host Range and Machine fetching was last run or started. This will be empty if a synchronization has never been run. type: string format: date-time nullable: true discoverySourceCount: description: Total number of discovery sources either active or inactive type: integer format: int32 isDiscoveryComputerScanRunning: description: Indicates if computer scanning is actively queueing. type: boolean isDiscoveryEnabled: description: Indicates if Discovery is currently enabled type: boolean isDiscoveryFetchRunning: description: Indicates if the Host Range and Machine fetching is currently running. type: boolean itemMetrics: description: Metrics of discovered items. Populated when includeMetrics is set to true items: $ref: '#/components/schemas/DiscoveryNetworkMetricItemSummary' type: array itemOsMetrics: description: Operating System of discovered items. Populated when includeMetrics is set to true items: $ref: '#/components/schemas/DiscoveryNetworkOsItemSummary' type: array nextComputerScanDiscoveryDateTime: description: The next time computer scanning is expected to run type: string format: date-time nullable: true nextFetchDiscoveryDateTime: description: The next time the Host Range and Machine fetching is expected to run type: string format: date-time nullable: true scanResultItemMetrics: description: Scan Results of discovered items. Populated when includeMetrics is set to true items: $ref: '#/components/schemas/DiscoveryScanResultItemSummary' type: array type: object UpdateFieldValueOfPasswordOptionEnum: description: Password Option properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/PasswordOptionEnum' type: object DiscoveryScanTemplateCreateArgs: description: Scan template create args properties: data: $ref: '#/components/schemas/DiscoveryScanTemplateCreateData' type: object FolderDiscoveryImportRuleModel: description: FolderDiscoveryImportRuleModel[] properties: ruleId: description: Rule Id type: integer format: int32 ruleName: description: Rule Name type: string type: object DiscoverySecretSearchFilterModel: description: Secret Search Filter Summary defines Secret search criteria based on a target item being scanned properties: allowPartialMatch: description: When true the name pattern only needs to be included in the secret and not an exact match type: boolean expectSingle: description: When true a warning will be logged that multiple secrets matched the pattern type: boolean folderId: description: The id of the folder to search type: integer format: int32 nullable: true folderName: description: Folder name to search type: string folderPath: description: Folder path to search type: string includeSubfolders: description: Whether or not subfolders should be searched type: boolean isActive: description: Is the filter active type: boolean secretNameSearchPattern: description: The pattern that should match the secret name like MACHINE$\Administrator type: string secretSearchFilterId: description: The unique ID for this filter type: integer format: int32 secretTypeId: description: The type of secret template to match type: integer format: int32 secretTypeName: description: Secret template name type: string type: object DiscoveryComputerScanResultsModel: description: DiscoveryComputerScanResultsModel properties: results: description: Individual computer scan results. items: $ref: '#/components/schemas/DiscoveryComputerScanResultModel' type: array type: object BadRequestResponse: description: Response object for invalid requests required: - message properties: message: description: Error message type: string messageDetail: description: Error message detail type: string errorCode: description: Error message code type: string modelState: description: An object describing validation errors type: object type: object DiscoverySourceUpdateModel: description: Data properties: active: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' daysToKeepMachines: $ref: '#/components/schemas/UpdateFieldValueOfInt32' discoverSpecificOUs: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' discoverySourceSettings: $ref: '#/components/schemas/UpdateFieldValueOfDiscoverySourceSettingsUpdateModel' machineNameResolutionType: $ref: '#/components/schemas/UpdateFieldValueOfMachineNameResolutionType' name: $ref: '#/components/schemas/UpdateFieldValueOfString' secretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' siteId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object DiscoveryScanTemplateUpdateData: description: Update a scan template properties: accountScanId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' fields: $ref: '#/components/schemas/UpdateFieldValueOfDiscoveryScanTemplateUpdateFieldModelArray' isActive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' parentScanTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' scanTemplateName: $ref: '#/components/schemas/UpdateFieldValueOfString' scanTypeId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object DiscoveryConfigurationModel: description: DiscoveryConfigurationModel properties: discoveryIntervalDays: description: Synchronize days interval for Discovery type: integer format: int32 discoveryIntervalHours: description: Synchronize hours interval for Discovery type: integer format: int32 discoveryScanOffsetHours: description: 'Sets time offset in hours for discovery scan operations. Default value: 0' type: integer format: int32 enableDiscovery: description: Whether or not discovery is enabled type: boolean engineADDiscoveryBatchSize: description: 'The size of the batch for Active Directory Account engine scanning - set higher if engine takes too much time to process. Default value: 1' type: integer format: int32 ignoreClusterNodeObjects: description: 'If set to true, Discovery scans will bypass machines identified as ''msclustervirtualserver.'' Default value: False' type: boolean maxLogAgeDays: description: How long to keep logs type: integer format: int32 type: object DiscoveryComputerScanStatusResultModel: description: Indicates the status of the individual scans. properties: message: description: Optional message to indicate status. type: string scanType: $ref: '#/components/schemas/ComputerScanType' success: description: Will return true if scan type initiated successfully. type: boolean type: object PagingOfDiscoverySecretSearchFilterSummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoverySecretSearchFilterSummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryCommandSetTestData: description: Test data for a command set properties: {} type: object DiscoveryScannerDependencyTypeFilter: description: Discovery Scanner Dependnecy Type Filters properties: validForDependencyChanger: description: Whether to filter types only valid for a dependency changer. Defaults to false type: boolean nullable: true type: object DiscoverySourceCreateModelV2: description: Data properties: name: description: The discovery source name type: string siteId: description: The site ID that will run scanners for this discovery source type: integer format: int32 type: object DiscoveryScannerSettingsData: description: Data properties: settings: description: Settings items: $ref: '#/components/schemas/DiscoveryScannerSettingValue' type: array type: object UpdateFieldValueOfSubscriberTypeEnum: description: Subscriber Type properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/SubscriberTypeEnum' type: object DiscoveryScanTemplateCreateData: description: Create a scan template model properties: accountScanId: description: When scantype = 4 the account scan template ID should be specified type: integer format: int32 nullable: true createDefaultFields: description: When true the Fields property can be blank and the scan template will be created with the default fields from the parent type: boolean fields: description: The mapping and list of fields for this scan template items: $ref: '#/components/schemas/DiscoveryScanTemplateCreateFieldModel' type: array isActive: description: Indicates if this scan template is active type: boolean parentScanTemplateId: description: The ID of the parent scan template type: integer format: int32 nullable: true scanTemplateName: description: The name of the scan template type: string scanTypeId: description: Scan type ID (1, 2, 3, 4) type: integer format: int32 type: object DiscoveryImportArgs: description: The args for discovery import properties: data: $ref: '#/components/schemas/DiscoveryImportModel' type: object DiscoveryScannerCredentialModel: description: The credentials used by this discovery source properties: secretId: description: SecretId type: integer format: int32 nullable: true secretName: description: SecretName type: string secretNameSearchPattern: description: SecretNameSearchPattern type: string secretSearchFilterId: description: SecretSearchFilterId type: integer format: int32 nullable: true sortOrder: description: SortOrder type: integer format: int32 type: object TakeOverAccountTypeEnum: description: Take Over Account Type properties: {} type: string enum: - Single - Multiple UpdateFieldValueOfPasswordChangingTypeEnum: description: Password Changing Type properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/PasswordChangingTypeEnum' type: object AuthenticationFailedResponse: description: Response object for authentication failures required: - message properties: message: description: Error message type: string type: object DiscoveryNetworkMetricItemSummary: description: Metrics of Item type that were discovered and appear in the network view properties: itemType: description: The Type of this Network Item type: string itemTypeDisplayName: description: The Display Name of the Type of this Network Item type: string managedCount: description: Number of items managed type: integer format: int32 notManagedCount: description: Number of items not managed type: integer format: int32 type: object DiscoveryConfigurationUpdateModel: description: Update discovery configuration properties: dependencyNotFoundThreshold: $ref: '#/components/schemas/UpdateFieldValueOfInt32' discoveryIntervalDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' discoveryIntervalHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' discoveryScanOffsetHours: $ref: '#/components/schemas/UpdateFieldValueOfInt32' enableDiscovery: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' engineADDiscoveryBatchSize: $ref: '#/components/schemas/UpdateFieldValueOfInt32' ignoreClusterNodeObjects: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' maxLogAgeDays: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object DomainDiscoveryScopeFilterUpdateModel: description: Filters properties: discoveryFilterId: description: A filter ID type: integer format: int32 nullable: true filterType: $ref: '#/components/schemas/DiscoveryFilterType' guid: description: The AD GUID type: string scanTargetType: $ref: '#/components/schemas/ScanTargetType' secretId: description: The secret ID associated with the member type: integer format: int32 nullable: true siteId: description: The site ID type: integer format: int32 nullable: true type: object DiscoveryNetworkPublicKeyAccount: description: Discovery Network Public Key Account properties: accountName: description: Account Name type: string canLaunch: description: Can Launch type: boolean computerAccountId: description: Computer Account Id type: integer format: int32 secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object DiscoveryRuleAccountSortData: description: Sorts the account rules by id order properties: discoveryRuleAccountIds: description: The id order to sort items: type: integer format: int32 type: array type: object PagingOfDiscoveryScanTemplateSummaryModel: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryScanTemplateSummaryModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryScannerDuplicateData: description: Defines a scanner to duplicate properties: itemScannerId: description: The ID for the scanner being duplicated type: integer format: int32 newItemScannerName: description: The name of the new scanner type: string type: object DiscoveryCommandSetActionsModel: description: Indicates the actions the current user can perform on this command set properties: canEdit: description: Indicates if the current user can edit this command set type: boolean type: object DiscoveryRuleAccountSortArgs: description: Discovery Sort Rule Account Sort Args properties: data: $ref: '#/components/schemas/DiscoveryRuleAccountSortData' type: object DiscoveryScanTemplateUpdateArgs: description: Scan template update args properties: data: $ref: '#/components/schemas/DiscoveryScanTemplateUpdateData' type: object DiscoverySourceModel: description: Discovery Source Settings properties: active: description: Is discovery source active type: boolean daysToKeepMachines: description: Days To Keep Machines type: integer format: int32 discoverSpecificOUs: description: Discover specific OUs type: boolean discoveryScannerId: description: Discovery scanner ID type: string nullable: true discoverySourceId: description: The discovery source ID type: integer format: int32 discoverySourceSettings: $ref: '#/components/schemas/DiscoverySourceSettingsModel' lastDiscoveryRunDate: description: Last discovery run date type: string format: date-time nullable: true machineNameResolutionType: $ref: '#/components/schemas/MachineNameResolutionType' name: description: The discovery source naame type: string secretId: description: Default Discovery Secret credentials type: integer format: int32 nullable: true siteId: description: The site ID type: integer format: int32 type: object UpdateFieldValueOfString: description: Description properties: dirty: description: Dirty type: boolean value: description: Value type: string type: object PagingOfDiscoveryScannerSummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryScannerSummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object PagingOfDiscoveryRuleAccountSummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryRuleAccountSummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryRulePasswordType: description: Discovery Rule Password Type properties: passwordTypeId: description: Password Type Id type: integer format: int32 passwordTypeName: description: Password Type Name type: string type: object DiscoveryNetworkServiceAccount: description: Discovery Network Service Account properties: canLaunch: description: Can Launch type: boolean computerAccountId: description: Id of Directory Service Computer Account if one is found to be associated type: integer format: int32 nullable: true computerAccountName: description: Name of Directory Service Computer Account if one is found to be associated type: string computerDependencyId: description: Computer Dependency Id type: integer format: int32 computerId: description: Computer Id type: integer format: int32 computerName: description: Computer Name type: string dependencyName: description: Dependency Name type: string secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object DiscoverySourceSettingsCreateModel: description: Additional settings for discovery source properties: domainType: $ref: '#/components/schemas/DomainType' friendlyName: description: The domain friendly name type: string fullyQualifiedDomainName: description: The fully qualified domain name type: string useSecureLDAP: description: Use secure LDAP type: boolean type: object DiscoveryScannerCredentialsData: description: Scanner credential update properties: credentials: description: Completely replace the credentials on this scanner with this updated list items: $ref: '#/components/schemas/DiscoveryScannerUpdateCredential' type: array type: object DiscoveryRuleSecret: description: Discovery Rule Secret properties: id: description: Secret Id type: integer format: int32 name: description: Secret Name type: string type: object DiscoveryNetworkDirectoryAccountItemDetail: description: Discovery Network Directory Account Item Detail properties: accountDomain: description: Account Domain type: string accountDomainId: description: Account Domain Id type: integer format: int32 nullable: true addedManually: description: Added Manually type: boolean canLaunch: description: Can Launch type: boolean computerId: description: Computer Id type: integer format: int32 nullable: true computerName: description: Computer Name type: string createdDate: description: Date Item was Created type: string format: date-time discoveryItemScannerId: description: Discovery Item Scanner Id type: integer format: int32 nullable: true discoveryItemScannerName: description: Discovery Item Scanner Name type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string displayName: description: Display Name type: string distinguishedName: description: Distinguished Name type: string excluded: description: Excluded from Discovery type: boolean networkItemId: description: The Id of this Network Item type: integer format: int32 organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true organizationUnitName: description: Organization Unit Name type: string passwordExpirationDate: description: Password Expiration Date type: string format: date-time nullable: true passwordExpirationStatus: description: Password Expiration Status type: integer format: int32 nullable: true passwordLastSet: description: Password Last Set type: string format: date-time nullable: true scanItemTemplateId: description: Scan Item Template Id type: integer format: int32 nullable: true scanItemTemplateName: description: Scan Item Template Name type: string secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string serviceAccounts: description: Service Accounts associated to this Network Item items: $ref: '#/components/schemas/DiscoveryNetworkServiceAccount' type: array type: object DiscoveryActionType: description: Actions the current user can perform for Discovery properties: {} type: string enum: - CreateDiscoverySource - EditDiscoverySource - RunDiscovery - RunComputerScan - EditConfiguration - ViewScanners Severity: description: Error severity level properties: {} type: string enum: - None - Retry - Warn - Critical - Fatal DiscoveryScannerActionsModel: description: Defines the actions that the current user can perform on the scanner properties: canEdit: description: Can the current user edit this scanner type: boolean canEditInputTemplate: description: Can the current user change the input template type: boolean canEditOutputTemplate: description: Can the current user change the output template type: boolean type: object DomainDiscoveryScopeModel: description: A discovery filter to limit discovery to specific OU properties: discoverySourceId: description: The Secret Server ID of the discovery soure type: integer format: int32 filters: description: A list of filter memebers items: $ref: '#/components/schemas/DomainDiscoveryScopeFilterModel' type: array lookupTableIsReady: description: Is the look up table ready for the discovery source type: boolean type: object DiscoveryRuleDependencyUpdateModel: description: Discovery Rule Dependency Update Model properties: discoverySourceId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' isActive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' organizationUnitId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' privilegedAccountSecretId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' restartServices: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' ruleName: $ref: '#/components/schemas/UpdateFieldValueOfString' scanTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' secretDependencyTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' siteId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' type: object DiscoveryScannerSummary: description: A Discovery Scanner is what is used in a discovery flow to scan and find things. All scanners consume one type of scan template (entity) and output scan templates of a different type. For example, a machine scanner consumes machine scan templates and outputs account scan templates. properties: baseScannerName: description: The base scanner indicates how the scanner actually executes or performs the scanning type: string discoveryItemScannerDescription: description: Short description of this scanner type: string discoveryItemScannerDisplayName: description: The localized name of the scanner type: string discoveryItemScannerId: description: The unique ID for this scanner type: integer format: int32 discoveryItemScannerName: description: The name of this scanner type: string discoveryScanTypeId: description: 'The type of scanner: 1 = host, 2 = machine, 3 = account, 4 = dependency' type: integer format: int32 inputScanItemTemplateDisplayName: description: Localized name of the input scan template type: string inputScanItemTemplateId: description: The ID of the scan template that this scanner consumes type: integer format: int32 inputScanItemTemplateName: description: The name of the scan template that this scanner consumes type: string isActive: description: Whether or not this scanner is active type: boolean outputScanItemTemplateDisplayName: description: Localized name of the output scan template type: string outputScanItemTemplateId: description: The ID of the scan template that this scanner outputs type: integer format: int32 outputScanItemTemplateName: description: The name of the scan template that this scanner outputs type: string type: object DiscoverySecretSearchFilterSummary: description: Secret Search Filter Summary defines Secret search criteria based on a target item being scanned properties: allowPartialMatch: description: When true the name pattern only needs to be included in the secret and not an exact match type: boolean expectSingle: description: When true a warning will be logged that multiple secrets matched the pattern type: boolean folderId: description: The id of the folder to search type: integer format: int32 nullable: true folderName: description: Folder name to search type: string folderPath: description: Folder path to search type: string includeSubfolders: description: Whether or not subfolders should be searched type: boolean isActive: description: Is the filter active type: boolean secretNameSearchPattern: description: The pattern that should match the secret name like MACHINE$\Administrator type: string secretSearchFilterId: description: The unique ID for this filter type: integer format: int32 secretTypeId: description: The type of secret template to match type: integer format: int32 secretTypeName: description: Secret template name type: string type: object DiscoverySecretSearchFilterCreateData: description: Secret Search Filter Create properties: allowPartialMatch: description: When true the name pattern only needs to be included in the secret and not an exact match type: boolean expectSingle: description: When true a warning will be logged that multiple secrets matched the pattern type: boolean folderId: description: The id of the folder to search type: integer format: int32 includeSubfolders: description: Whether or not subfolders should be searched type: boolean isActive: description: Is the filter active type: boolean secretNameSearchPattern: description: The pattern that should match the secret name like MACHINE$\Administrator type: string secretTypeId: description: The type of secret template to match type: integer format: int32 type: object DiscoveryRuleDependencySortArgs: description: Discovery Sort Rule Dependency Sort Args properties: data: $ref: '#/components/schemas/DiscoveryRuleDependencySortData' type: object UpdateFieldValueOfInt32: description: How many days until the password expires. properties: dirty: description: Dirty type: boolean value: description: Value type: integer format: int32 type: object DiscoveryCommandSetTestParametersModel: description: Command set test parameters properties: commandSetId: description: The command set these test params are for type: integer format: int32 type: object NetworkTreeSummaryModel: description: An outside organization associated with a discovery source properties: hasChildren: description: Indication that the OU has children type: boolean id: description: The Id of the OU type: integer format: int32 name: description: The name of the OU type: string parentId: description: The Id of the Parent OU type: integer format: int32 type: object DiscoveryScannerDetailItemModel: description: The scanner settings for this scanner on this discovery source properties: determinesAuthentication: description: DeterminesAuthentication type: boolean displayName: description: DisplayName type: string dropDownOptions: description: DropDownOptions items: $ref: '#/components/schemas/ViewFieldDropDownOption' type: array editable: description: Editable type: boolean fieldType: description: FieldType type: integer format: int32 name: description: Name type: string regexValidation: description: RegexValidation type: string tooltip: description: Tooltip type: string value: description: Value type: string visible: description: Visible type: boolean type: object DiscoveryScannerDetailCreateModel: description: The scanner to add to the discovery source. properties: discoveryItemScannerId: description: The scanner to add type: integer format: int32 type: object UpdateFieldValueOfDiscoveryScanTemplateUpdateFieldModelArray: description: When these are passed all fields will be updated to whatever is passed so it is a complete replace of the fields. properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/DiscoveryScanTemplateUpdateFieldModel' type: array type: object DiscoverySourceFiltersUpdateArgs: description: DiscoverySourceFiltersUpdateArgs properties: data: $ref: '#/components/schemas/DiscoverySourceFiltersUpdateModel' type: object DiscoveryScannerSettingValue: description: Value properties: settingName: description: The unique scanner setting name type: string settingValue: description: The value for this setting. This should be a json serialized version of the value. type: string type: object DiscoveryComputerScanArgs: description: DiscoveryComputerScanArgs properties: data: $ref: '#/components/schemas/DiscoveryComputerScansModel' type: object DiscoveryScannerSortResultModel: description: Sort Response Model properties: success: description: Whether or not the sort was successful. type: boolean type: object DiscoveryCommandSetCreateData: description: Command sets allow SH commands to be run to discover machines or accounts. Using scripts is a preferred option over command sets. properties: commands: description: This field is the SH commands that will be executed for this command set. This should be a block of text with each command on its own line. Each command can be preceded by only one comment line that is indicated with the hash or pound symbol. type: string commandSetName: description: The name of the command set type: string discoveryScannerId: description: The scanner id which can only be 1 = SSH or 2 = ODBC type: integer format: int32 isActive: description: Indicates if this command set will be active type: boolean scanTypeId: description: The scan type which can only be 2 = machines or 3 = accounts type: integer format: int32 type: object DiscoveryImportModel: description: A model for discovery account import properties: changePassword: description: Should the password be changed type: boolean discoverySourceId: description: The discovery source of the items type: integer format: int32 folderId: description: A folder for the secret type: integer format: int32 nullable: true itemIds: description: Item IDs of the accounts items: type: integer format: int32 type: array nextPassword: description: A value to set the next password to type: string passphrase: description: A current passphrase for the provided private key type: string password: description: The current password type: string privateKey: description: A current private key type: string randomPassword: description: Should a random password be set type: boolean scanItemTemplateId: description: The scan item template ID of the items type: integer format: int32 secretNameFormat: description: A tokenized secret name type: string secretPrivilegedAccount: description: A privileged account for RPC of the secret items: type: integer format: int32 type: array secretTypeId: description: The secret type to create type: integer format: int32 nullable: true siteId: description: A site ID to create the secret type: integer format: int32 nullable: true takeOverAccountPasswordTypeId: description: A password type for the privileged account to be used for take over type: integer format: int32 nullable: true takeOverAccountSecrets: description: A privileged account to be used for take over items: type: integer format: int32 type: array type: object DiscoveryScannerDependencyTypeSummaryModel: description: Discovery Scanner Dependency Type Summary properties: hasRequiredLicensing: description: Indicates if the Dependency Type is available for use with the current licensing. type: boolean isAssignableToDependencyTemplates: description: Indicates if the Dependency Type can be assigned to a Dependency Template. type: boolean isValidCustomDependencyChanger: description: Indicates if the Dependency Type can be assigned to a custom Dependency Changer. type: boolean secretDependencyTypeId: description: The Id of the Dependency Type. type: integer format: int32 secretDependencyTypeName: description: The name of the Dependency Type. type: string type: object DiscoveryDependencyImportModel: description: The model to import depenencies from Discovery properties: changePassword: description: Should the password be changed on the secret type: boolean dependencyPrivilegedAccountId: description: A privileged account for the dependency type: integer format: int32 nullable: true folderId: description: The folder ID to create a a secret type: integer format: int32 nullable: true itemIds: description: The item IDs of dependencies items: type: integer format: int32 type: array nextPassword: description: A password to update the account to type: string password: description: The existing password of the account if needed type: string randomPassword: description: Should a random password be used type: boolean restartService: description: Should the service be restart on changes type: boolean secretDependencyTemplateId: description: A template for the dependency type: integer format: int32 nullable: true secretNameFormat: description: The tokienized secret name type: string secretPrivilegedAccount: description: An RPC privileged account for the secret type: integer format: int32 nullable: true secretTypeId: description: The secret type to create type: integer format: int32 nullable: true siteId: description: Site ID type: integer format: int32 nullable: true sshKeySecretId: description: A secret for an SSH key for the dependency type: integer format: int32 nullable: true type: object UpdateFieldValueOfSecretPermissionEnum: description: Secret Permissions properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/SecretPermissionEnum' type: object UpdateFieldValueOfDiscoveryScannerSettingValue: description: Define any scanner specific setting values properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/DiscoveryScannerSettingValue' type: object DiscoveryRuleDependencyDeleteResult: description: Discovery Rule Dependency Delete Result properties: success: description: Success type: boolean type: object DiscoveryRunArgs: description: DiscoveryRunArgs properties: data: $ref: '#/components/schemas/DiscoveryRunModel' type: object DiscoverySecretSearchFilterUpdateData: description: Secret Search Filter Update properties: allowPartialMatch: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' expectSingle: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' folderId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' includeSubfolders: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' isActive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' secretNameSearchPattern: $ref: '#/components/schemas/UpdateFieldValueOfString' secretSearchFilterId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' secretTypeId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object DiscoveryScannerSettingsArgs: description: DiscoveryScannerSettingsArgs properties: data: $ref: '#/components/schemas/DiscoveryScannerSettingsData' type: object DiscoveryUpdateSettingsResultModel: description: DiscoveryUpdateSettingsResultModel properties: success: description: Success type: boolean warningMessage: description: WarningMessage type: string type: object DiscoveryRuleSecretTemplate: description: DiscoveryRuleSecretTemplate[] properties: id: description: Secret Template Id type: integer format: int32 name: description: Secret Template Name type: string type: object DiscoverySecretSearchFilterUpdateArgs: description: DiscoverySecretSearchFilterUpdateArgs properties: data: $ref: '#/components/schemas/DiscoverySecretSearchFilterUpdateData' type: object DiscoveryScannerCreateData: description: Defines a new scanner properties: baseScannerId: description: The base scanner ID to use type: integer format: int32 commandSetId: description: The command set ID if this is an SSH discovery scanner type: integer format: int32 nullable: true concurrencyId: description: Globally unique ID for this scan template type: string inputScanItemTemplateId: description: The input template ID that defines the data the scanner should consume type: integer format: int32 isActive: description: Indicates if this scanner is active type: boolean itemScannerDescription: description: The description of the scanner type: string itemScannerId: description: The item scanner ID type: integer format: int32 itemScannerName: description: The name of the scanner type: string outputScanItemTemplateId: description: The output template ID that defines the structure of the data the scanner should output type: integer format: int32 scannerId: description: The ID for this scanner type: integer format: int32 scanTypeId: description: Indicates the scan type ID (1, 2, 3, 4) type: integer format: int32 scriptArguments: description: Any script args for powershell scanners type: string scriptId: description: The specific powershell script ID to use with this scanner type: integer format: int32 nullable: true type: object DiscoverySourceFilterPatchArgs: description: DiscoverySourceFilterPatchArgs properties: data: $ref: '#/components/schemas/DomainDiscoveryScopeFilterPatchModel' type: object DiscoveryRuleDependencyDetail: description: Discovery Rule Dependency Detail properties: discoverySourceId: description: Discovery Source Id type: integer format: int32 discoverySourceName: description: Discovery Source Name type: string isActive: description: Is Active type: boolean organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true organizationUnitName: description: Organization Unit Name type: string privilegedAccountSecretId: description: Privileged Account Secret Id type: integer format: int32 nullable: true privilegedAccountSecretName: description: Privileged Account Secret Name type: string restartServices: description: Restart Services type: boolean ruleId: description: Rule Id type: integer format: int32 ruleName: description: Rule Name type: string scanTemplateId: description: Scan Template Id type: integer format: int32 scanTemplateName: description: Scan Template Name type: string secretDependencyTemplateId: description: Secret Dependency Template Id type: integer format: int32 secretDependencyTemplateName: description: Secret Dependency Template Name type: string siteId: description: Site Id type: integer format: int32 nullable: true type: object ViewFieldDropDownOption: description: DropDownOptions properties: fieldDisplay: description: FieldDisplay type: string fieldValue: description: FieldValue type: string type: object DomainType: description: Domain Type properties: {} type: string enum: - ActiveDirectory - OpenLdap - AzureActiveDirectory DiscoveryRuleDependencySortResultModel: description: Sort Response Model properties: success: description: Whether or not the sort was successful. type: boolean type: object PagingOfNetworkComputerLogModel: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/NetworkComputerLogModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryFilterType: description: Indicates if the filter is an include or exclude properties: {} type: string enum: - Include - Exclude DiscoveryComputerDeleteResultModel: description: Individual computer scan results. properties: computerId: description: Computer Id the scan was started on. type: integer format: int32 computerName: description: Name of the computer the scan was started on. type: string success: description: Will return true if all scans initiated successfully. type: boolean type: object DiscoveryRuleDependencyCreateModel: description: Discovery Rule Dependency Create Model properties: discoverySourceId: description: Discovery Source Id type: integer format: int32 organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true privilegedAccountSecretId: description: Privileged Account Secret Id type: integer format: int32 nullable: true restartServices: description: Restart Services type: boolean ruleName: description: Rule Name type: string scanTemplateId: description: Scan Template Id type: integer format: int32 secretDependencyTemplateId: description: Secret Dependency Template Id type: integer format: int32 siteId: description: Site Id type: integer format: int32 nullable: true type: object DiscoveryScannerCreateArgs: description: Create scanner args properties: data: $ref: '#/components/schemas/DiscoveryScannerCreateData' type: object DiscoveryScanTemplateUpdateFieldModel: description: Update values for a scan template field properties: includeInMatch: description: Indicates if this field is used to determine uniqueness of this item type: boolean parentScanItemFieldId: description: The parent field, if any type: integer format: int32 nullable: true scanItemFieldId: description: The ID for the field or empty / null if this is a new field that is being added type: integer format: int32 nullable: true scanItemFieldName: description: The name of the scan item template field type: string type: object DiscoveryNetworkPublicKeyItemDetail: description: Discovery Network Public Key Item Detail properties: addedManually: description: Added Manually type: boolean canLaunch: description: Can Launch type: boolean computerId: description: Computer Id type: integer format: int32 nullable: true computerName: description: Computer Name type: string createdDate: description: Date Item was Created type: string format: date-time discoveryItemScannerId: description: Discovery Item Scanner Id type: integer format: int32 nullable: true discoveryItemScannerName: description: Discovery Item Scanner Name type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string displayName: description: Display Name type: string excluded: description: Excluded from Discovery type: boolean hasLocalAdminRights: description: Has Local Admin Rights type: boolean nullable: true isLocalAdministrator: description: Is Local Administrator type: boolean nullable: true networkItemId: description: The Id of this Network Item type: integer format: int32 organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true organizationUnitName: description: Organization Unit Name type: string passwordExpirationDate: description: Password Expiration Date type: string format: date-time nullable: true passwordExpirationStatus: description: Password Expiration Status type: integer format: int32 nullable: true passwordLastSet: description: Password Last Set type: string format: date-time nullable: true publicKey: description: Public Key type: string scanItemTemplateId: description: Scan Item Template Id type: integer format: int32 nullable: true scanItemTemplateName: description: Scan Item Template Name type: string secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object DiscoveryScannerSortArgs: description: Sort scanner args properties: data: $ref: '#/components/schemas/DiscoveryScannerSortData' type: object OUModel: description: OUModel[] properties: displayName: description: The display name of the OU type: string distinguishedName: description: The distinguished name of the OU type: string guid: description: The GUID of the OU type: string id: description: The Secret Server ID of the OU type: integer format: int32 parentGuid: description: The parent GUID of the OU type: string type: description: The type of the OU type: string type: object DiscoverySourceCreateArgsV2: description: DiscoverySourceCreateArgsV2 properties: data: $ref: '#/components/schemas/DiscoverySourceCreateModelV2' type: object DiscoveryScannerSettingCreateArgs: description: Discovery Scanner Settings Create Args properties: data: $ref: '#/components/schemas/DiscoveryScannerSettingCreateData' type: object DiscoveryScannerUpdateData: description: Update values for a specific scanner properties: baseScannerId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' commandSetId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' inputScanItemTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' isActive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' itemScannerDescription: $ref: '#/components/schemas/UpdateFieldValueOfString' itemScannerName: $ref: '#/components/schemas/UpdateFieldValueOfString' outputScanItemTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' scannerId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' scriptArguments: $ref: '#/components/schemas/UpdateFieldValueOfString' scriptId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' settings: description: Define any scanner specific setting values items: $ref: '#/components/schemas/UpdateFieldValueOfDiscoveryScannerSettingValue' type: array type: object DiscoveryScannerDependencyTemplateModel: description: Discovery Scanner Dependency Template properties: active: description: Indicates of the Dependency Template is active. type: boolean canEdit: description: Indicates if the Dependency Template can be edited. type: boolean scanItemTemplateId: description: The Scan Template Id of the Dependency Template. type: integer format: int32 secretDependencyChangerId: description: The Dependency Changer Id of the Dependency Template if assigned. type: integer format: int32 nullable: true secretDependencyTemplateDescription: description: The description of the Dependency Template. type: string secretDependencyTemplateId: description: The Id of the Dependency Template. type: integer format: int32 secretDependencyTemplateName: description: The name of the Dependency Template. type: string secretDependencyTypeId: description: The Dependency Type Id of the Dependency Template. type: integer format: int32 type: object UpdateFieldValueOfDiscoveryRuleScanItemFilterArray: description: Filter Fields. Dynamic filters for the selected Scan Template properties: dirty: description: Dirty type: boolean value: description: Value items: $ref: '#/components/schemas/DiscoveryRuleScanItemFilter' type: array type: object DiscoveryScannerSortData: description: Sorts the scanners by id order properties: discoveryItemScannerIds: description: The id order to sort items: type: integer format: int32 type: array type: object DiscoveryNetworkServiceAccountItemDetail: description: Discovery Network Service Account Item Detail properties: accountDomain: description: Account Domain Name type: string accountDomainId: description: Account Domain Id type: integer format: int32 nullable: true addedManually: description: Added Manually type: boolean canLaunch: description: Can Launch type: boolean computerId: description: Computer Id type: integer format: int32 computerName: description: Computer Name type: string createdDate: description: Date Item was Created type: string format: date-time description: description: Description type: string discoveryItemScannerId: description: Discovery Item Scanner Id type: integer format: int32 nullable: true discoveryItemScannerName: description: Discovery Item Scanner Name type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string displayName: description: Display Name type: string excluded: description: Excluded from Discovery type: boolean networkItemId: description: The Id of this Network Item type: integer format: int32 passwordExpirationStatus: description: Password Expiration Status type: integer format: int32 nullable: true passwordLastSet: description: Password Last Set type: string format: date-time nullable: true scanItemTemplateId: description: Scan Item Template Id type: integer format: int32 nullable: true scanItemTemplateName: description: Scan Item Template Name type: string secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object DiscoveryScannerSettingViewModel: description: Discovery Scanner Settings properties: discoverySourceScannerMapId: description: Unique ID for scanner setting type: integer format: int32 type: object DiscoveryCommandSetModel: description: Discovery Command Set properties: actions: $ref: '#/components/schemas/DiscoveryCommandSetActionsModel' commands: description: The actual commands that will run in the shell for this command set type: string commandSetId: description: Unique ID for the command set type: integer format: int32 commandSetName: description: Name of the command set type: string discoveryScannerId: description: 'Defines the scan type ID: 1 = SSH, 2 = ODBC' type: integer format: int32 isActive: description: Indicates if this command set is active type: boolean isStandard: description: Indicates if this is a standard out of the box command set type: boolean scanTypeId: description: 'Defines the scan type ID: 1 = host, 2 = machine, 3 = account, 4 = dependency' type: integer format: int32 scanTypeName: description: The name of the scan type type: string type: object DiscoveryScannerDuplicateArgs: description: Duplicate scanner args properties: data: $ref: '#/components/schemas/DiscoveryScannerDuplicateData' type: object DiscoveryScannerSettingCreateData: description: Create discovery scanner settings properties: discoveryScanTypeId: description: DiscoveryScanTypeId to create type: integer format: int32 type: object ScanTargetType: description: The scan target type for the member properties: {} type: string enum: - Users - Computers - UsersAndComputers UpdateFieldValueOfScanTargetType: description: The scan target type for the member properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/ScanTargetType' type: object DiscoveryScannerDependencyTemplateCreateArgs: description: Scanner Dependency Template create args properties: data: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateCreateData' type: object DiscoveryRuleDependencyUpdateArgs: description: Discovery Rule Dependency Update Args properties: data: $ref: '#/components/schemas/DiscoveryRuleDependencyUpdateModel' type: object DiscoveryRuleDependencySummary: description: Discovery Rule Dependency Summary properties: dependencyTemplateId: description: Dependency Template Id type: integer format: int32 dependencyTemplateName: description: Dependency Template Name type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string isActive: description: Is Active type: boolean ruleId: description: Rule Id type: integer format: int32 ruleName: description: Rule Name type: string scanTemplateId: description: Scan Template Id type: integer format: int32 scanTemplateName: description: Scan Template Name type: string sortOrder: description: Sort Order type: integer format: int32 type: object InternalServerErrorResponse: description: Response object for internal server errors required: - message - exceptionMessage - exceptionType - stackTrace properties: message: description: Error message type: string exceptionMessage: description: Error message from exception type: string exceptionType: description: Exception type type: string stackTrace: description: Exception stack trace type: string type: object DiscoveryDependencyImportArgs: description: The args for dependency import properties: data: $ref: '#/components/schemas/DiscoveryDependencyImportModel' type: object PasswordChangingTypeEnum: description: Password Changing Type properties: {} type: string enum: - PrivilegedAccount - SecretCredentials DiscoveryScannerSettingSummaryModel: description: DiscoveryScannerSettingSummaryModel[] properties: active: description: Active type: boolean canEdit: description: Can this scanner be edited. Built in scanners are not able to be edited so any scanner you can edit was created by users. type: boolean discoveryItemScannerDescription: description: Description of the scanner type: string discoveryItemScannerDisplayName: description: Localized name of the scanner type: string discoveryItemScannerId: description: The ID that identifies this specific scanner item which is not specific to a discovery source but the type of scanner type: integer format: int32 discoveryItemScannerName: description: The name of the scanner type: string discoveryScannerId: description: Discovery Scanner Id type: integer format: int32 discoveryScanTypeId: description: Discovery Scanner Type Id type: integer format: int32 discoverySourceScannerMapId: description: The ID for the map type: integer format: int32 errors: description: Errors that exist on the scanner items: type: string type: array inputScanItemTemplateDisplayName: description: Localized name of the input scan template type: string inputScanItemTemplateId: description: The ID for the type of items this scanner will consume type: integer format: int32 inputScanItemTemplateName: description: The name of the type of items this scanner will consume type: string outputScanItemTemplateDisplayName: description: Localized name of the output scan template type: string outputScanItemTemplateId: description: The ID of the items that this scanner will output or produce type: integer format: int32 outputScanItemTemplateName: description: The name of the items that this scanner will output or produce type: string sortOrder: description: The order in which the scanners are sorted type: integer format: int32 nullable: true type: object PagingOfDiscoveryRuleDependencySummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryRuleDependencySummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryScannerUpdateArgs: description: Scanner update args properties: data: $ref: '#/components/schemas/DiscoveryScannerUpdateData' type: object DiscoveryScannerDependencyTemplateUpdateArgs: description: Scanner Dependency Template update args properties: data: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateUpdateData' type: object DiscoveryScanTemplateSummaryModel: description: Scan templates are the mapping of the fields of an item that was discovered properties: canEdit: description: System templates cannot be edited and will also be false if the current user cannot edit it. type: boolean isActive: description: Is this scan template active type: boolean scanTemplateId: description: Scan Template ID type: integer format: int32 scanTemplateName: description: Scan Template Name type: string scanTypeId: description: Scan Type Id type: integer format: int32 scanTypeName: description: Scan Type type: string type: object DiscoverySourceAuditModel: description: Discovery Source Audit properties: action: description: Action type: string date: description: Date type: string format: date-time discoverySourceAuditId: description: DiscoverySourceAuditId type: integer format: int32 discoverySourceId: description: DiscoverySourceId type: integer format: int32 displayName: description: DisplayName type: string formattedDate: description: FormattedDate type: string itemId: description: ItemId type: integer format: int32 notes: description: Notes type: string userId: description: UserId type: integer format: int32 userName: description: UserName type: string type: object DiscoveryComputerScanModel: description: ComputerScans properties: computerId: description: Performs a scan on the specified computer id. type: integer format: int32 scanType: $ref: '#/components/schemas/ComputerScanType' type: object DiscoverySourceCreateArgs: description: DiscoverySourceCreateArgs properties: data: $ref: '#/components/schemas/DiscoverySourceCreateModel' type: object DiscoveryRuleScanItemField: description: DiscoveryRuleScanItemField[] properties: scanItemFieldDisplayName: description: Scan Item Field Display Name type: string scanItemFieldId: description: Scan Item Field Id type: integer format: int32 scanItemFieldName: description: Scan Item Field Name type: string type: object DiscoveryScannerSettingTypeSummary: description: DiscoveryScannerSettingTypeSummary[] properties: discoveryItemScannerDescription: description: Description of the scanner type: string discoveryItemScannerId: description: Item Scanner ID type: integer format: int32 discoveryItemScannerName: description: Scanner name type: string discoveryScanTypeId: description: Scanner Type ID type: integer format: int32 isSuggested: description: True if this scanner is typically created type: boolean type: object NetworkComputerLogModel: description: Computer Scan Log Model properties: computerId: description: Id of the computer scanned. type: integer format: int32 computerName: description: Name of the computer scanned. type: string computerScanLogId: description: Computer Scan Log Id. type: integer format: int32 discoveryItemScannerId: description: The scanner id used. type: integer format: int32 nullable: true discoveryItemScannerName: description: The scanner name used. type: string discoverySourceId: description: The discovery source id used. type: integer format: int32 discoverySourceName: description: The discovery source name used. type: string scanDate: description: Date the scan was performed. type: string format: date-time scanItemTemplateId: description: The template Id used. type: integer format: int32 nullable: true scanItemTemplateName: description: The template name used. type: string status: description: Status Message for the log entry. type: string success: description: Whether the log message was a successful status. type: boolean type: object DiscoveryComputerScansModel: description: Data properties: computerScans: description: ComputerScans items: $ref: '#/components/schemas/DiscoveryComputerScanModel' type: array type: object DiscoveryScanTemplateActionsModel: description: Actions that the current user can perforom on the scan template properties: canEdit: description: Can the current user edit the scan template type: boolean type: object UpdateFieldValueOfMatchingConditionEnum: description: Whether to 'and' or 'or' ComputerNameContains and AccountNameContains properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/MatchingConditionEnum' type: object DiscoveryRuleDependencyInfo: description: Discovery Rule Dependency Info properties: dependencyTemplates: description: Dependency Templates items: $ref: '#/components/schemas/DiscoveryDependencyTemplateSummary' type: array isPrivilegedSecretRequired: description: Determines whether a Privileged Secret is Required when creating a rule for the given scan template type: boolean passwordTypeIds: description: Password Type Ids for Filtering Secrets items: type: integer format: int32 type: array secretTemplates: description: Secret Templates items: $ref: '#/components/schemas/DiscoveryRuleSecretTemplate' type: array type: object DiscoveryCommandSetSummary: description: Command sets are used to assign a command to a scanner to execute properties: discoveryCommandSetId: description: The unique ID for this command set type: integer format: int32 discoveryCommandSetName: description: The name of this command set type: string discoveryScannerId: description: Which scanner ID is associated to this command set type: integer format: int32 discoveryScannerTypeName: description: Which scanner ID is associated to this command set type: string discoveryScanTypeId: description: The scan type ID associated to this command set type: integer format: int32 discoveryScanTypeName: description: The scan type name associated to this command set type: string isActive: description: Whether or not this command set is active type: boolean isStandard: description: Is this a standard or system command set type: boolean type: object DiscoverySourceSettingsUpdateModel: description: Value properties: friendlyName: $ref: '#/components/schemas/UpdateFieldValueOfString' fullyQualifiedDomainName: $ref: '#/components/schemas/UpdateFieldValueOfString' useSecureLDAP: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' type: object ComputerScanType: description: Type of scan to perform. Options are All, LocalAccount, DependencyAccount. Will default to All if not set. properties: {} type: string enum: - All - LocalAccount - DependencyAccount DiscoverySourceUpdateArgs: description: DiscoverySourceUpdateArgs properties: data: $ref: '#/components/schemas/DiscoverySourceUpdateModel' type: object DiscoveryNetworkComputerAccountItemDetail: description: Discovery Network Computer Account Item Detail properties: addedManually: description: Added Manually type: boolean canLaunch: description: Can Launch type: boolean computerId: description: Computer Id type: integer format: int32 nullable: true computerName: description: Computer Name type: string createdDate: description: Date Item was Created type: string format: date-time discoveryItemScannerId: description: Discovery Item Scanner Id type: integer format: int32 nullable: true discoveryItemScannerName: description: Discovery Item Scanner Name type: string discoverySourceId: description: Discovery Source Id type: integer format: int32 nullable: true discoverySourceName: description: Discovery Source Name type: string displayName: description: Display Name type: string excluded: description: Excluded from Discovery type: boolean hasLocalAdminRights: description: Has Local Admin Rights type: boolean nullable: true isLocalAdministrator: description: Is Local Administrator type: boolean nullable: true networkItemId: description: The Id of this Network Item type: integer format: int32 organizationUnitId: description: Organization Unit Id type: integer format: int32 nullable: true organizationUnitName: description: Organization Unit Name type: string passwordExpirationDate: description: Password Expiration Date type: string format: date-time nullable: true passwordExpirationStatus: description: Password Expiration Status type: integer format: int32 nullable: true passwordLastSet: description: Password Last Set type: string format: date-time nullable: true scanItemTemplateId: description: Scan Item Template Id type: integer format: int32 nullable: true scanItemTemplateName: description: Scan Item Template Name type: string secretId: description: Secret Id type: integer format: int32 nullable: true secretName: description: Secret Name type: string type: object PagingOfDiscoverySourceAuditModel: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoverySourceAuditModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object PagingOfDiscoveryCommandSetSummary: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryCommandSetSummary' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryRuleDependencySortData: description: Sorts the dependency rules by id order properties: discoveryRuleDependencyIds: description: The id order to sort items: type: integer format: int32 type: array type: object MatchingConditionEnum: description: Whether to 'and' or 'or' ComputerNameContains and AccountNameContains properties: {} type: string enum: - And - Or DiscoveryRuleAccountCreateArgs: description: Discovery Rule Account Create Args properties: data: $ref: '#/components/schemas/DiscoveryRuleAccountCreateModel' type: object DiscoveryComputerDeleteResultsModel: description: DiscoveryComputerDeleteResultsModel properties: results: description: Individual computer scan results. items: $ref: '#/components/schemas/DiscoveryComputerDeleteResultModel' type: array type: object DiscoveryRuleDependencyCreateArgs: description: Discovery Rule Dependency Create Args properties: data: $ref: '#/components/schemas/DiscoveryRuleDependencyCreateModel' type: object DiscoveryScannerModel: description: Scanner Model properties: actions: $ref: '#/components/schemas/DiscoveryScannerActionsModel' baseScannerId: description: The base scanner ID type: integer format: int32 baseScannerName: description: The name of the base scanner type: string commandSetId: description: The specific command set ID if this is an SSH scanner type: integer format: int32 nullable: true commandSetName: description: The specific command set ID if this is an SSH scanner type: string concurrencyId: description: Globally unique ID for this scan template type: string dependencyItemScannerDisplayName: description: A localized version of the scanner item name type: string discoveryItemScannerDisplayDescription: description: A localized description for this scanner type: string discoveryItemScannerDisplayName: description: A localized version of the scanner name type: string inputScanItemTemplateId: description: The ID of the input scan template type: integer format: int32 inputTemplateDisplayName: description: A localized name of the input template type: string inputTemplateName: description: The name of the input scan template type: string isActive: description: Indicates if this scanner is active type: boolean isInUse: description: Indicates if this scanner is used in any discover source scanner flows type: boolean itemScannerDescription: description: The description of the scanner type: string itemScannerId: description: Unique ID for this scanner type: integer format: int32 itemScannerName: description: The name of the scanner type: string outputScanItemTemplateId: description: The ID of the output scan template type: integer format: int32 outputTemplateDisplayName: description: A localized name of the output template type: string outputTemplateName: description: The name of the output scan template type: string scannerId: description: The scanner ID for this scanner type: integer format: int32 scannerItems: description: All of the setting values for this scanner items: $ref: '#/components/schemas/DiscoveryScannerDetailItemModel' type: array scanTypeId: description: The scan type (1, 2, 3, 4) type: integer format: int32 scriptArguments: description: Any args that will be passed to the PS scanner script type: string scriptId: description: If this is a PS scanner this is the associated script type: integer format: int32 nullable: true scriptName: description: If this is a PS scanner this is the associated script name type: string type: object DiscoverySourceSettingsSummaryModel: description: Additional settings for discovery source properties: distinguishedName: description: The domain distinguished name type: string domainType: description: 'Domain type: ActiveDirectory, OpenLdap, or AzureActiveDirectory' type: string nullable: true friendlyName: description: The domain friendly name type: string fullyQualifiedDomainName: description: The fully qualified domain name type: string netBIOSName: description: The NetBIOS name type: string useSecureLDAP: description: Use secure LDAP type: boolean type: object DiscoveryScannerDependencyTemplateCreateData: description: Create a Scanner Dependency Template model properties: active: description: Indicates if this Dependency Template is active type: boolean scanItemTemplateId: description: The Scan Template ID of the Dependency Template type: integer format: int32 secretDependencyChangerId: description: The Dependency Changer ID of the Dependency Template type: integer format: int32 nullable: true secretDependencyTemplateDescription: description: The description of the Dependency Template type: string secretDependencyTemplateName: description: The name of the Dependency Template type: string secretDependencyTypeId: description: The Dependency Type of the Dependency Template type: integer format: int32 type: object DiscoveryRuleAccountSortResultModel: description: Sort Response Model properties: success: description: Whether or not the sort was successful. type: boolean type: object DiscoveryRuleScanItemFilter: description: Discovery Rule Scan Item Filter properties: filterFieldValue: description: Filter Field Value type: string scanItemFieldId: description: Scan Item Field Id type: integer format: int32 type: object SecretPermissionEnum: description: Secret Permissions properties: {} type: string enum: - InheritPermission - CopyPermission PagingOfDiscoveryScannerDependencyTypeSummaryModelAndDiscoveryScannerDependencyTypeFilter: description: Specify filtering, paging, sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 filter: $ref: '#/components/schemas/DiscoveryScannerDependencyTypeFilter' hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryScannerDependencyTypeSummaryModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DomainDiscoveryScopeFilterModel: description: A filter for a discovery source properties: discoveryFilterId: description: A filter ID type: integer format: int32 displayName: description: The display name of the member type: string filterType: $ref: '#/components/schemas/DiscoveryFilterType' guid: description: The GUID of the member type: string scanTargetType: $ref: '#/components/schemas/ScanTargetType' secretId: description: The secret ID associated with the member type: integer format: int32 nullable: true secretName: description: The secret name associated with the member type: string siteId: description: The site ID type: integer format: int32 nullable: true siteName: description: The site name of the member type: string type: object DiscoveryConfigurationUpdateArgs: description: DiscoveryConfigurationUpdateArgs properties: data: $ref: '#/components/schemas/DiscoveryConfigurationUpdateModel' type: object DiscoveryRuleAccountUpdateModel: description: Discovery Rule Account Update Model properties: accountAlerts: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' accountNameContains: $ref: '#/components/schemas/UpdateFieldValueOfString' actionCreateSecrets: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' computerNameContains: $ref: '#/components/schemas/UpdateFieldValueOfString' currentPassphrase: $ref: '#/components/schemas/UpdateFieldValueOfString' currentPassword: $ref: '#/components/schemas/UpdateFieldValueOfString' currentPrivateKey: $ref: '#/components/schemas/UpdateFieldValueOfString' discoverySourceId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' filterFields: $ref: '#/components/schemas/UpdateFieldValueOfDiscoveryRuleScanItemFilterArray' folderId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' importOnlyPolledLastScan: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' includeChildOUs: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' isActive: $ref: '#/components/schemas/UpdateFieldValueOfBoolean' matchingCondition: $ref: '#/components/schemas/UpdateFieldValueOfMatchingConditionEnum' newPassword: $ref: '#/components/schemas/UpdateFieldValueOfString' operatingSystemContains: $ref: '#/components/schemas/UpdateFieldValueOfString' organizationUnitId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' passwordChangingPrivilegedAccountSecretIds: $ref: '#/components/schemas/UpdateFieldValueOfInt32Array' passwordChangingType: $ref: '#/components/schemas/UpdateFieldValueOfPasswordChangingTypeEnum' passwordOption: $ref: '#/components/schemas/UpdateFieldValueOfPasswordOptionEnum' ruleDescription: $ref: '#/components/schemas/UpdateFieldValueOfString' ruleName: $ref: '#/components/schemas/UpdateFieldValueOfString' scanTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' secretNamePattern: $ref: '#/components/schemas/UpdateFieldValueOfString' secretPermissions: $ref: '#/components/schemas/UpdateFieldValueOfSecretPermissionEnum' secretTemplateId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' siteId: $ref: '#/components/schemas/UpdateFieldValueOfInt32' subscribedSpecificGroupIds: $ref: '#/components/schemas/UpdateFieldValueOfInt32Array' subscriberType: $ref: '#/components/schemas/UpdateFieldValueOfSubscriberTypeEnum' takeOverAccountType: $ref: '#/components/schemas/UpdateFieldValueOfTakeOverAccountTypeEnum' takeOverPasswordTypeId: $ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32' takeoverSecretIds: $ref: '#/components/schemas/UpdateFieldValueOfInt32Array' takeOverThreshold: $ref: '#/components/schemas/UpdateFieldValueOfInt32' type: object UpdateFieldValueOfTakeOverAccountTypeEnum: description: Take Over Account Type properties: dirty: description: Dirty type: boolean value: $ref: '#/components/schemas/TakeOverAccountTypeEnum' type: object DiscoverySourceSummaryModel: description: Query results properties: active: description: Is discovery source active type: boolean daysToKeepMachines: description: Days To Keep Machines type: integer format: int32 discoverSpecificOUs: description: Discover specific OUs type: boolean discoveryScannerId: description: Discovery scanner ID type: string nullable: true discoverySourceId: description: The discovery source ID type: integer format: int32 discoverySourceSettings: $ref: '#/components/schemas/DiscoverySourceSettingsSummaryModel' lastDiscoveryRunDate: description: Last discovery run date type: string format: date-time nullable: true machineNameResolutionType: $ref: '#/components/schemas/MachineNameResolutionType' name: description: The discovery source naame type: string secretId: description: Default Discovery Secret credentials type: integer format: int32 nullable: true siteId: description: The site ID type: integer format: int32 type: object DiscoveryScannerUpdateCredential: description: Completely replace the credentials on this scanner with this updated list properties: secretId: description: SecretId type: integer format: int32 nullable: true secretSearchFilterId: description: SecretSearchFilterId type: integer format: int32 nullable: true type: object PagingOfDiscoveryScannerDependencyTemplateSummaryModel: description: Specify paging and sorting options for querying records and returning results properties: batchCount: description: Number of result batches available with current query options type: integer format: int32 currentPage: description: Index of current result page type: integer format: int32 hasNext: description: Whether there are any results in additional pages type: boolean hasPrev: description: Whether there are any results in previous pages type: boolean nextSkip: description: Correct value of 'skip' for the next page of results type: integer format: int32 pageCount: description: Number of result pages available with current query options type: integer format: int32 prevSkip: description: Correct value of 'skip' for the previous page of results type: integer format: int32 records: description: Query results items: $ref: '#/components/schemas/DiscoveryScannerDependencyTemplateSummaryModel' type: array severity: $ref: '#/components/schemas/Severity' skip: description: Number of records to skip before taking results type: integer format: int32 sortBy: description: List of sort properties items: $ref: '#/components/schemas/Sort' type: array success: description: Whether the query executed successfully type: boolean take: description: Maximum number of records to include in results type: integer format: int32 total: description: Total number of results available type: integer format: int32 type: object DiscoveryScanResultItemSummary: description: Discovery Sources that were scanned during the last scan and the summarized results properties: discoverySourceId: description: Discovery Source Id type: integer format: int32 discoverySourceName: description: Discovery Source Name type: string errorCount: description: Number of scans that had errors on the Discovery Source type: integer format: int32 successCount: description: Number of scans that were successful on the Discovery Source type: integer format: int32 type: object securitySchemes: BearerToken: type: apiKey description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer token''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the token request documentation.' name: Authorization in: header