Delinea DistributedEngine API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations DistributedEngine 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: DistributedEngine
  description: View and maintain Distributed Engine integrations
paths:
  /v1/distributed-engine/configuration:
    get:
      tags:
      - DistributedEngine
      summary: Distributed Engine Configuration
      description: Retrieve the current settings for Distributed Engine configuration
      operationId: DistributedEngineService_GetDistributedEngineConfiguration
      responses:
        '200':
          description: Distributed Engines Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedEngineConfigurationModel'
        '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:
      - DistributedEngine
      summary: Update Distributed Engine Configuration
      description: Update the current settings for Distributed Engine configuration
      operationId: DistributedEngineService_PatchDistributedEngineConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DistributedEngineConfigurationUpdateArgs'
        description: args
      responses:
        '200':
          description: Updated Distributed Engine Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedEngineConfigurationModel'
        '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/distributed-engine/site-connectors:
    get:
      tags:
      - DistributedEngine
      summary: Search Site Connectors
      description: Search Site Connectors
      operationId: DistributedEngineService_SearchSiteConnectors
      parameters:
      - name: filter.includeInactive
        in: query
        description: IncludeInactive
        required: false
        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: Site Connectors that matched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSiteConnectorSummaryModel'
        '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/distributed-engine/site-connector/{id}:
    get:
      tags:
      - DistributedEngine
      summary: Get Site Connector
      description: Get Site Connector for passed in Id
      operationId: DistributedEngineService_GetSiteConnector
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Site Connector if found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteConnectorViewModel'
        '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:
      - DistributedEngine
      summary: Update Site Connector
      description: Update Site Connector object with passed in Id
      operationId: DistributedEngineService_UpdateSiteConnector
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteConnectorUpdateArgs'
        description: args
      responses:
        '200':
          description: Updated Site Connector object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteConnectorViewModel'
        '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/distributed-engine/site-connector/stub:
    get:
      tags:
      - DistributedEngine
      summary: Get Site Connector Stub
      description: Get Site Connector for passed in args
      operationId: DistributedEngineService_GetSiteConnectorStub
      parameters:
      - name: queueType
        in: query
        description: QueueType
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Stub of a Site Connector model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteConnectorViewModel'
        '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/distributed-engine/site-connector/{siteConnectorId}/credentials:
    get:
      tags:
      - DistributedEngine
      summary: Get Site Connector Credentials
      description: Get Site Connector Credentials
      operationId: DistributedEngineService_GetSiteConnectorCredentials
      parameters:
      - name: siteConnectorId
        in: path
        description: siteConnectorId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Site Connector Credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteConnectorCredentialsModel'
        '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/distributed-engine/engines:
    get:
      tags:
      - DistributedEngine
      summary: Search Engines
      description: Search Engines
      operationId: DistributedEngineService_SearchEngines
      parameters:
      - name: filter.activationStatus
        in: query
        description: Only return engines with this activation status
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.connectionStatus
        in: query
        description: Only return engines with this connection status
        required: false
        x-nullable: true
        schema:
          type: string
      - name: filter.friendlyName
        in: query
        description: Only return engines with a friendly name that contains this text
        required: false
        schema:
          type: string
      - name: filter.onlyIncludeRequiringAction
        in: query
        description: Only include engines that require action.  For example, pending but not deleted or no site assigned.
        required: false
        schema:
          type: boolean
      - name: filter.siteId
        in: query
        description: Only return engines for this site
        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: Engines that matched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfEngineSummaryModel'
        '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/distributed-engine/engine-settings/site/{siteId}:
    get:
      tags:
      - DistributedEngine
      summary: Get Default Engine Settings for Site
      description: Get Default Engine Settings object having passed in Site Id
      operationId: DistributedEngineService_GetEngineSettingsForSite
      parameters:
      - name: siteId
        in: path
        description: siteId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get Engine Settings object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineSettingsModel'
        '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/distributed-engine/site/{siteId}/engine-audits:
    get:
      tags:
      - DistributedEngine
      summary: Get Engine Audits for Site
      description: Get Engine Audits having passed in Site Id
      operationId: DistributedEngineService_GetEngineAuditsForSite
      parameters:
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - name: filter.engineId
        in: query
        description: EngineId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.searchTerm
        in: query
        description: SearchTerm
        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
      - name: siteId
        in: path
        description: siteId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get Engine Audit Summary object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfEngineAuditSummary'
        '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/distributed-engine/engine-settings/{engineId}:
    get:
      tags:
      - DistributedEngine
      summary: Get Engine Settings
      description: Get Engine Settings object having passed in Engine Id
      operationId: DistributedEngineService_GetEngineSettings
      parameters:
      - name: engineId
        in: path
        description: engineId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get Engine Settings object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineSettingsModel'
        '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/distributed-engine/sites:
    get:
      tags:
      - DistributedEngine
      summary: Search Sites
      description: Search Sites
      operationId: DistributedEngineService_SearchSites
      parameters:
      - name: filter.includeInactive
        in: query
        description: Include inactive sites
        required: false
        schema:
          type: boolean
      - name: filter.includeSiteMetrics
        in: query
        description: When true metrics are included for returned sites such as how many inactive or active sites
        required: false
        schema:
          type: boolean
      - name: filter.onlyIncludeSitesThatCanAddNewEngines
        in: query
        description: Only returns sites that can have new engines added
        required: false
        schema:
          type: boolean
      - name: filter.siteId
        in: query
        description: Return the site with this ID
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.siteName
        in: query
        description: Return sites that partially match 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: Sites that matched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSiteSummaryModel'
        '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/distributed-engine/site/{id}:
    get:
      tags:
      - DistributedEngine
      summary: Get Site
      description: Get Site for passed in Id
      operationId: DistributedEngineService_GetSite
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Site if found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteBasicModel'
        '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:
      - DistributedEngine
      summary: Patch Site
      description: Patch Site object having passed in Id
      operationId: DistributedEngineService_PatchSite
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteUpdateArgs'
        description: args
      responses:
        '200':
          description: Patch Site object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteBasicModel'
        '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/distributed-engine/site/stub:
    get:
      tags:
      - DistributedEngine
      summary: Get Site Stub
      description: Get Site for passed in args
      operationId: DistributedEngineService_GetSiteStub
      responses:
        '200':
          description: Stub of a Site model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteBasicModel'
        '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/distributed-engine/site/{id}/audit:
    get:
      tags:
      - DistributedEngine
      summary: GetSiteAudits
      description: Get audits by Site Id
      operationId: DistributedEngineService_GetSiteAudits
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: isExporting
        in: query
        description: isExporting
        required: false
        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: Paged List of Audits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSiteAuditSummary'
        '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/distributed-engine/site/{id}/logs:
    get:
      tags:
      - DistributedEngine
      summary: SearchSiteLogs
      description: Search site logs by Site Id
      operationId: DistributedEngineService_SearchSiteLogs
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: filter.engineId
        in: query
        description: Filter by a specific engine ID
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.searchTerm
        in: query
        description: Term used to search the Engine Name and/or the Message of the Site Log
        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: Paged List of Logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSiteLogSummaryModel'
        '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/distributed-engine/site-connector/{id}/download-memorymq:
    get:
      tags:
      - DistributedEngine
      summary: Download Memory MQ
      description: Downloads MemoryMQ
      operationId: DistributedEngineService_DownloadMemoryMq
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: MemoryMQ File Download
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileStream'
        '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/distributed-engine/{id}/server-capabilities:
    get:
      tags:
      - DistributedEngine
      summary: Get Server Capabilities
      description: Gets the server capabilities of an engine's server
      operationId: DistributedEngineService_GetServerCapabilities
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returns the server capabilities of an engine's server
          content:
            application/json:
              schema:
                description: Returns the server capabilities of an engine's server
                items:
                  $ref: '#/components/schemas/EngineServerCapabilitiesSummary'
                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:
        

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