Delinea LauncherAgents API

openapi: 3.2.0
info:
  title: Secret Server Rest Activations Launcher Agents 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: LauncherAgents
  description: Manage Launcher Agents and Launcher Agent Collections for Advanced Session Recording
paths:
  /v1/launcheragents/collections:
    get:
      tags:
      - LauncherAgents
      summary: Search Launcher Agent Collections
      description: Search, filter, sort, and page Launcher Agent Collections
      operationId: LauncherAgentsService_SearchCollections
      parameters:
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive Launcher Agent Collections in the results
        required: false
        schema:
          type: boolean
      - name: filter.searchText
        in: query
        description: 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: Launcher Agent Collection search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfLauncherAgentCollectionSummary'
        '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:
      - LauncherAgents
      summary: Create Launcher Agent Collection
      description: Create a new Launcher Agent Collection
      operationId: LauncherAgentsService_CreateCollection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LauncherAgentCollectionCreateArgs'
        description: Launcher Agent Collection creation options
      responses:
        '200':
          description: Launcher Agent Collection object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentCollectionModel'
        '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/launcheragents/collections/stub:
    get:
      tags:
      - LauncherAgents
      summary: Get Launcher Agent Collection Stub
      description: Return the default values for a new Launcher Agent Collection
      operationId: LauncherAgentsService_Stub
      parameters:
      - name: includeInactive
        in: query
        description: IncludeInactive
        required: false
        schema:
          type: boolean
      - name: searchText
        in: query
        description: SearchText
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Launcher Agent Collection object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentCollectionModel'
        '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/launcheragents/collections/{id}:
    get:
      tags:
      - LauncherAgents
      summary: Get Launcher Agent Collection
      description: Get a single Launcher Agent Collection by ID
      operationId: LauncherAgentsService_GetByCollectionId
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive Launcher Agent Collections in the results
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Launcher Agent Collection ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: LauncherAgentCollection object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentCollectionModel'
        '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
    put:
      tags:
      - LauncherAgents
      summary: Update Launcher Agent Collection
      description: Update a single Launcher Agent Collection by ID
      operationId: LauncherAgentsService_UpdateCollection
      parameters:
      - name: id
        in: path
        description: Launcher Agent Collection ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LauncherAgentCollectionUpdateArgs'
        description: Launcher Agent Collection update options
      responses:
        '200':
          description: Launcher Agent Collection object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentCollectionModel'
        '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/launcheragents/collections/audit:
    get:
      tags:
      - LauncherAgents
      summary: Get collections audit
      description: Return audit entries for all collections
      operationId: LauncherAgentsService_GetCollectionsAudit
      parameters:
      - name: isExporting
        in: path
        description: isExporting
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: Launcher collection audit
          content:
            application/json:
              schema:
                description: Launcher collection audit
                items:
                  $ref: '#/components/schemas/LauncherAgentCollectionAudit'
                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/launcheragents/collections/{id}/audit:
    get:
      tags:
      - LauncherAgents
      summary: Get collection audit
      description: Return audit entries for a single collection
      operationId: LauncherAgentsService_GetCollectionAudit
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: isExporting
        in: path
        description: isExporting
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: Launcher collection audit
          content:
            application/json:
              schema:
                description: Launcher collection audit
                items:
                  $ref: '#/components/schemas/LauncherAgentCollectionAudit'
                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/launcheragents/issues:
    get:
      tags:
      - LauncherAgents
      summary: Search Launcher Agents with Issues
      description: Search, filter, sort, and page Launcher Agent with issues
      operationId: LauncherAgentsService_SearchAgentsWithIssues
      parameters:
      - name: filter.launcherAgentCollectionId
        in: query
        description: LauncherAgentCollectionId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.searchText
        in: query
        description: SearchText
        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: Launcher Agent search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfLauncherAgentSummary'
        '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/launcheragents/configuration-state:
    get:
      tags:
      - LauncherAgents
      summary: Get Launcher Agent configuration state
      description: Get all launcher agent  configuration state
      operationId: LauncherAgentsService_GetLauncherAgentState
      responses:
        '200':
          description: LauncherAgentConfigurationState object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentConfigurationState'
        '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/launcheragents:
    get:
      tags:
      - LauncherAgents
      summary: Search Launcher Agents
      description: Search, filter, sort, and page Launcher Agent s
      operationId: LauncherAgentsService_Search
      parameters:
      - name: filter.includeInactive
        in: query
        description: IncludeInactive
        required: false
        schema:
          type: boolean
      - name: filter.launcherAgentCollectionId
        in: query
        description: LauncherAgentCollectionId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.outOfDate
        in: query
        description: OutOfDate
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.searchText
        in: query
        description: SearchText
        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: Launcher Agent  search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfLauncherAgentSummary'
        '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/launcheragents/{id}:
    get:
      tags:
      - LauncherAgents
      summary: 'Get Launcher Agent '
      description: Get a single Launcher Agent  by ID
      operationId: LauncherAgentsService_Get
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive Launcher Agents in the results
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: Launcher Agent ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: LauncherAgent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentModel'
        '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
    put:
      tags:
      - LauncherAgents
      summary: 'Update Launcher Agent '
      description: Update a single Launcher Agent by ID
      operationId: LauncherAgentsService_Update
      parameters:
      - name: id
        in: path
        description: Launcher Agent ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LauncherAgentUpdateArgs'
        description: Launcher Agent update options
      responses:
        '200':
          description: Launcher Agent object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LauncherAgentModel'
        '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/launcheragents/audit:
    get:
      tags:
      - LauncherAgents
      summary: Get Launcher Agent Audits
      description: Get all launcher agent audits
      operationId: LauncherAgentsService_GetAudits
      parameters:
      - name: isExporting
        in: path
        description: isExporting
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: LauncherAgentAudit object
          content:
            application/json:
              schema:
                description: LauncherAgentAudit object
                items:
                  $ref: '#/components/schemas/LauncherAgentAudit'
                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/launcheragents/{id}/audit:
    get:
      tags:
      - LauncherAgents
      summary: Get Launcher Agent Audits by agent ID
      description: Get launcher agent audits by agent ID
      operationId: LauncherAgentsService_GetAuditsByAgentId
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: isExporting
        in: path
        description: isExporting
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: LauncherAgentAudit object
          content:
            application/json:
              schema:
                description: LauncherAgentAudit object
                items:
                  $ref: '#/components/schemas/LauncherAgentAudit'
                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
components:
  schemas:
    PagingOfLauncherAgentSummary:
      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/LauncherAgentSummary'
          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
    LauncherAgentSummary:
      description: Query results
      properties:
        active:
          description: Whether or not the agent is running
          type: boolean
        collectionId:
          description: The identifier of the collection to which this agent belongs
          type: integer
          format: int32
        collectionName:
          description: The name of the collection to which this agent belongs
          type: string
        collectionRecordKeystrokes:
          description: Whether or not this agent will record keystrokes as the default setting for the Collection
          type: boolean
        collectionRecordStandaloneSessions:
          description: Whether or not headless session recording is enabled as the default setting for the Collection
          type: boolean
        created:
          description: The date the agent was installed
          type: string
          format: date-time
        hostName:
          description: Name of the computer which the agent is running on
          type: string
        id:
          description: Unique ID for this agent
          type: integer
          format: int32
        issue:
          description: Any issues with this agent regarding its version and configuration
          type: string
        lastActivity:
          description: The date the agent was last active
          type: string
          format: date-time
        recordKeystrokes:
          description: Whether or not this agent will record keystrokes, or using the Collection Default
          type:
          - boolean
          - 'null'
        recordStandaloneSessions:
          description: Whether or not headless session recording is enabled, or using the Collection Default
          type:
          - boolean
          - 'null'
        version:
          description: The version number currently installed
          type: string
      type: object
    LauncherAgentModel:
      description: LauncherAgentModel
      properties:
        active:
          description: Whether or not the agent is active
          type: boolean
        collectionId:
          description: The ID of the collection the agent belongs to
          type: integer
          format: int32
        collectionName:
          description: The name of the collection the agent belongs to
          type: string
        created:
          description: When the agent was created
          type: string
          format: date-time
        hostName:
          description: The hostname of the machine the agent is installed on
          type: string
        id:
          description: The ID of the agent
          type: integer
          format: int32
        lastActivity:
          description: The date the agent was last active
          type: string
          format: date-time
        recordKeystrokes:
          description: Whether or not this agent will record keystrokes
          type:
          - boolean
          - 'null'
        recordStandaloneSessions:
          description: Whether or not headless session recording is enabled
          type:
          - boolean
          - 'null'
        version:
          description: The version number currently installed
          type: string
      type: object
    LauncherAgentCollectionSummary:
      description: Launcher Agent Collection summary
      properties:
        active:
          description: Whether the Collection is enabled
          type: boolean
        activeAgentCount:
          description: Total number of active Launcher Agents in this Collection
          type: integer
          format: int32
        id:
          description: User ID
          type: integer
          format: int32
        name:
          description: Collection Name
          type: string
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    LauncherAgentCollectionUpdateArgs:
      description: Launcher Agent Collection update options
      properties:
        active:
          description: Whether the Launcher Agent Collection is active
          type: boolean
        id:
          description: Launcher Agent ID. Must match ID in path
          type: integer
          format: int32
          minimum: 1
        name:
          description: Collection Name
          type: string
        recordKeystrokes:
          description: Whether or not agents in this collection will record standalone sessions by default
          type: boolean
        recordStandaloneSessions:
          description: Whether or not agents in this collection will record standalone sessions by default
          type: boolean
      type: object
    LauncherAgentAudit:
      description: LauncherAgentAudit[]
      properties:
        action:
          description: Action
          type: string
        auditSubject:
          description: AuditSubject
          type: string
        date:
          description: Date
          type: string
          format: date-time
        displayName:
          description: DisplayName
          type: string
        formattedDate:
          description: FormattedDate
          type: string
        itemId:
          $ref: '#/components/schemas/Object'
        launcherAgentAuditId:
          description: LauncherAgentAuditId
          type: integer
          format: int32
        launcherAgentCollectionId:
          description: LauncherAgentCollectionId
          type:
          - integer
          - 'null'
          format: int32
        launcherAgentId:
          description: LauncherAgentId
          type: integer
          format: int32
        notes:
          description: Notes
          type: string
        userId:
          description: UserId
          type: integer
          format: int32
        userName:
          description: UserName
          type: string
      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
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    LauncherAgentCollectionCreateArgs:
      description: Launcher Agent Collection create options
      required:
      - name
      - recordStandaloneSessions
      - recordKeystrokes
      properties:
        name:
          description: Collection Name
          type: string
        recordKeystrokes:
          description: Record Keystrokes
          type: boolean
        recordStandaloneSessions:
          description: Record Standalone Sessions
          type: boolean
      type: object
    LauncherAgentCollectionAudit:
      descrip

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