Delinea Discovery API

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 <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> 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/js

# --- truncated at 32 KB (286 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-discovery-api-openapi.yml