Delinea EventPipelinePolicy API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations EventPipelinePolicy 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: EventPipelinePolicy
  description: EventPipelinePolicyController
paths:
  /v1/event-pipeline-policy/{policyId}/pipeline/{pipelineId}:
    delete:
      tags:
      - EventPipelinePolicy
      summary: Remove Event Pipeline From Policy
      description: Remove a pipeline from a specific policy
      operationId: EventPipelinePolicyService_RemoveEventPipelineFromPolicy
      parameters:
      - name: pipelineId
        in: path
        description: Event Pipeline ID
        required: true
        schema:
          type: integer
          format: int32
      - name: policyId
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: boolean indicating success
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/event-pipeline-policy/{id}:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Event Pipeline Policy
      description: Get a specific policy by ID
      operationId: EventPipelinePolicyService_GetEventPipelinePolicy
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Policy details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyModel'
        '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:
      - EventPipelinePolicy
      summary: Update Event Pipeline Policy
      description: Update a policy
      operationId: EventPipelinePolicyService_UpdateEventPipelinePolicy
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicyUpdateArgs'
        description: args
      responses:
        '200':
          description: The update policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyModel'
        '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:
      - EventPipelinePolicy
      summary: Add Pipeline To Event Pipeline Policy
      description: Returns data pertaining to children of a folder that has a particular pipeline policy assigned
      operationId: EventPipelinePolicyService_AddPipelineToEventPipelinePolicy
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicyAddPipelineArgs'
        description: eventPipelinePolicyAddPipelineArgs
      responses:
        '200':
          description: Pipeline policy children
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyMapModel'
        '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/event-pipeline-policy/list:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Event Pipeline Policies
      description: Get all pipeline policies
      operationId: EventPipelinePolicyService_GetEventPipelinePolicies
      parameters:
      - name: filter.eventPipelineId
        in: query
        description: EventPipelineId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.eventPipelinePolicyName
        in: query
        description: EventPipelinePolicyName
        required: false
        schema:
          type: string
      - name: filter.folderId
        in: query
        description: FolderId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - 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: A paged list of all policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfEventPipelinePolicySummary'
        '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/event-pipeline-policy/runs:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Event Pipeline Policy Runs
      description: Get all runs by specific search criteria
      operationId: EventPipelinePolicyService_GetEventPipelinePolicyRuns
      parameters:
      - name: filter.eventPipelinePolicyId
        in: query
        description: EventPipelinePolicyId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.eventPipelinePolicyRunId
        in: query
        description: EventPipelinePolicyRunId
        required: false
        schema:
          type: string
          format: uuid
      - 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 policy runs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfEventPipelineRunViewModel'
        '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/event-pipeline-policy/activity:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Event Pipeline Policy Run Activity
      description: Get all activity for a specific policy run ID
      operationId: EventPipelinePolicyService_GetEventPipelinePolicyRunActivity
      parameters:
      - name: eventPipelineId
        in: query
        description: eventPipelineId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: eventPipelinePolicyRunId
        in: query
        description: Event Pipeline Policy Run ID
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Details for a specific run
          content:
            application/json:
              schema:
                description: Details for a specific run
                items:
                  $ref: '#/components/schemas/EventPipelinePolicyRunActivityViewModel'
                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/event-pipeline-policy/{id}/secretpolicies:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Secret Policies For Pipeline Policies
      description: Get all of the secret polocies that are related to this pipeline
      operationId: EventPipelinePolicyService_GetSecretPoliciesForPipelinePolicies
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      - name: filter.eventPipelinePolicyId
        in: query
        description: EventPipelinePolicyId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.eventPipelinePolicyName
        in: query
        description: EventPipelinePolicyName
        required: false
        schema:
          type: string
      - name: filter.includeActive
        in: query
        description: IncludeActive
        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: Paged list of secret policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretPolicyViewModel'
        '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/event-pipeline-policy/{id}/folders:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Folders For Pipeline Policies
      description: Get all of the folders for a policy pipeline
      operationId: EventPipelinePolicyService_GetFoldersForPipelinePolicies
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of all folders to which this policy is applied
          content:
            application/json:
              schema:
                description: List of all folders to which this policy is applied
                items:
                  $ref: '#/components/schemas/FolderSimpleViewModel'
                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
    put:
      tags:
      - EventPipelinePolicy
      summary: Update Event Pipeline Policy Folder Maps
      description: Adds or updates the Pipeline Policy Folder Maps to reflect the collection of folder maps for the pipeline policy that was passed in.
      operationId: EventPipelinePolicyService_UpdateEventPipelinePolicyFolderMaps
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicyFolderMapUpdateArgs'
        description: eventPipelinePolicyFolderMaps
      responses:
        '200':
          description: boolean indicating success
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/event-pipeline-policy/{id}/groups:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Groups For Pipeline Policies
      description: Get all of the groups that apply this pipeline
      operationId: EventPipelinePolicyService_GetGroupsForPipelinePolicies
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of all groups
          content:
            application/json:
              schema:
                description: List of all groups
                items:
                  $ref: '#/components/schemas/UserGroupSearchResultModel'
                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
    put:
      tags:
      - EventPipelinePolicy
      summary: Update Event Pipeline Policy Group Maps
      description: Adds or updates the Pipeline Policy Group Maps to reflect the collection of group maps for the pipeline policy that was passed in.
      operationId: EventPipelinePolicyService_UpdateEventPipelinePolicyGroupMaps
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicyGroupMapUpdateArgs'
        description: eventPipelinePolicyGroupMaps
      responses:
        '200':
          description: boolean indicating success
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/event-pipeline-policy/{id}/groups/count:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Group Count For Pipeline Policy
      description: Returns the count of groups that have a particular pipeline policy assigned
      operationId: EventPipelinePolicyService_GetGroupCountForPipelinePolicy
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Number of groups affected
          content:
            application/json:
              schema:
                description: Int32
                type: integer
                format: int32
        '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/event-pipeline-policy/{id}/folders/{folderId}/childdata:
    get:
      tags:
      - EventPipelinePolicy
      summary: Get Child Folder Data For Pipeline Policy Folder
      description: Get all of the child data for a specific folder
      operationId: EventPipelinePolicyService_GetChildFolderDataForPipelinePolicyFolder
      parameters:
      - name: folderId
        in: path
        description: Folder ID
        required: true
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of child data
          content:
            application/json:
              schema:
                description: List of child data
                items:
                  $ref: '#/components/schemas/EventPipelinePolicyFolderChildData'
                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/event-pipeline-policy/export/{id}:
    get:
      tags:
      - EventPipelinePolicy
      summary: Export Event Pipeline Policy
      description: Export a policy
      operationId: EventPipelinePolicyService_ExportEventPipelinePolicy
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: the exported json of the policy
          content:
            application/json:
              schema:
                description: String
                type: string
        '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/event-pipeline-policy:
    post:
      tags:
      - EventPipelinePolicy
      summary: Create Pipeline Policy
      description: Create Pipeline Policy
      operationId: EventPipelinePolicyService_CreateEventPipelinePolicy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicyCreateArgs'
        description: eventPipelinePolicy
      responses:
        '200':
          description: Newly created model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyModel'
        '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/event-pipeline-policy/duplicate:
    post:
      tags:
      - EventPipelinePolicy
      summary: Duplicate Event Pipeline Policy
      description: Create a duplicate of a policy
      operationId: EventPipelinePolicyService_DuplicateEventPipelinePolicy
      requestBody:
        $ref: '#/components/requestBodies/EventPipelinePolicyImportArgs'
      responses:
        '200':
          description: The duplicated model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyModel'
        '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/event-pipeline-policy/import:
    post:
      tags:
      - EventPipelinePolicy
      summary: Import Event Pipeline Policy
      description: Import a policy
      operationId: EventPipelinePolicyService_ImportEventPipelinePolicy
      requestBody:
        $ref: '#/components/requestBodies/EventPipelinePolicyImportArgs'
      responses:
        '200':
          description: The imported policy model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyModel'
        '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/event-pipeline-policy/{id}/order:
    put:
      tags:
      - EventPipelinePolicy
      summary: Update Event Pipeline Policy Sort Order
      description: Update the sort order of a policy
      operationId: EventPipelinePolicyService_UpdateEventPipelinePolicySortOrder
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicySortOrderUpdateArgs'
        description: args
      responses:
        '200':
          description: updated policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPipelinePolicyModel'
        '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/event-pipeline-policy/{id}/activate:
    put:
      tags:
      - EventPipelinePolicy
      summary: Activate Event Pipeline Policy
      description: Activate a specific policy
      operationId: EventPipelinePolicyService_ActivateEventPipelinePolicy
      parameters:
      - name: id
        in: path
        description: Event Pipeline Policy ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventPipelinePolicyActivateArgs'
        description: args
      responses:
        '200':
          description: boolean indicating success
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
       

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