OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations EventPipeline 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: EventPipeline
description: EventPipelineController
paths:
/v1/event-pipeline/{id}:
get:
tags:
- EventPipeline
summary: Get an Event Pipeline
description: Returns the Event Pipeline for the provided ID
operationId: EventPipelineService_GetEventPipeline
parameters:
- name: id
in: path
description: Event Pipeline ID
required: true
schema:
type: integer
format: int32
responses:
'200':
description: The Event Pipeline View
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineModel'
'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:
- EventPipeline
summary: Update an Event Pipeline
description: Update an existing Event Pipeline using the existing Event Pipeline's ID
operationId: EventPipelineService_UpdateEventPipelines
parameters:
- name: id
in: path
description: Event Pipeline ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineUpdateArgs'
description: args
responses:
'200':
description: The updated Event Pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineModel'
'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/list:
get:
tags:
- EventPipeline
summary: Get a list of Event Pipelines
description: Returns a list of Event Pipelines that meet the paging/searching criterea
operationId: EventPipelineService_GetEventPipelines
parameters:
- name: filter.eventEntityTypeId
in: query
description: EventEntityTypeId
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.eventPipelineName
in: query
description: EventPipelineName
required: false
schema:
type: string
- name: filter.eventPipelinePolicyId
in: query
description: EventPipelinePolicyId
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: The list of Event Pipelines
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfEventPipelineViewModel'
'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/summaries:
get:
tags:
- EventPipeline
summary: Get summaries of Event Pipelines
description: Returns a list of Event Pipeline summaries that meet the searching criterea
operationId: EventPipelineService_GetEventPipelineSummaries
parameters:
- name: filter.eventEntityTypeId
in: query
description: EventEntityTypeId
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.eventPipelineName
in: query
description: EventPipelineName
required: false
schema:
type: string
- name: filter.eventPipelinePolicyId
in: query
description: EventPipelinePolicyId
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: The summaries of Event Pipelines
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfEventPipelineSummaryModel'
'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/stub:
get:
tags:
- EventPipeline
summary: Stub an empty Event Pipeline
description: Returns an empty Event Pipeline to be filled out.
operationId: EventPipelineService_GetEventPipelineStub
responses:
'200':
description: An empty Event Pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipeline'
'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/runs:
get:
tags:
- EventPipeline
summary: Get Event Pipeline Runs
description: Get all of the runs for a specific pipeline
operationId: EventPipelineService_GetEventPipelineRuns
parameters:
- name: filter.eventPipelineId
in: query
description: EventPipelineId
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.eventPipelinePolicyRunId
in: query
description: EventPipelinePolicyRunId
required: false
x-nullable: true
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 pipeline 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:
post:
tags:
- EventPipeline
summary: Create a new Event Pipeline
description: Creates a new Event Pipeline with the provided object.
operationId: EventPipelineService_CreateEventPipelines
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineCreateArgs'
description: args
responses:
'200':
description: The new Event Pipeline
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineModel'
'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/{id}/order:
put:
tags:
- EventPipeline
summary: Reorder an Event Pipeline
description: Reorder an existing Event Pipeline in a policy
operationId: EventPipelineService_ReorderPipeline
parameters:
- name: id
in: path
description: Event Pipeline Id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineOrderUpdateArgs'
description: args
responses:
'200':
description: Event Pipeline Policy Map
content:
application/json:
schema:
description: Event Pipeline Policy Map
items:
$ref: '#/components/schemas/EventPipelinePolicyMap'
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/{id}/activate:
put:
tags:
- EventPipeline
summary: Update an Event Pipeline active value
description: Sets if an Event Pipeline is active or not
operationId: EventPipelineService_TogglePipelineActive
parameters:
- name: id
in: path
description: Event Pipeline Id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventPipelineActivateUpdateArgs'
description: args
responses:
'200':
description: The Active value
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
components:
schemas:
Sort:
description: Sort options. Multiple sort options can be provided in the query string.
required:
- name
- direction
properties:
direction:
$ref: '#/components/schemas/SortDirection'
name:
description: Sort field name
type: string
priority:
description: Priority index. Sorts with lower values are executed earlier
type: integer
format: int32
type: object
UpdateFieldValueOfBoolean:
description: Active
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: boolean
type: object
PagingOfEventPipelineRunViewModel:
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/EventPipelineRunViewModel'
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
EventPipelineTriggerModel:
description: Event Pipeline Trigger
properties:
entityTypeDisplayName:
description: Entity Type Display Name
type: string
eventActionId:
description: Event Action Id
type: integer
format: int32
eventPipelineId:
description: Event Pipeline Id
type: integer
format: int32
eventPipelineTriggerId:
description: Event Pipeline Trigger Id
type: integer
format: int32
triggerDisplayName:
description: Trigger Display Name
type: string
type: object
UpdateFieldValueOfEventPipelineTriggerUpdateModelArray:
description: Triggers
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
items:
$ref: '#/components/schemas/EventPipelineTriggerUpdateModel'
type: array
type: object
SettingUpdateModel:
description: Value
properties:
settingName:
$ref: '#/components/schemas/UpdateFieldValueOfString'
settingValue:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
EventPipelineOrderUpdateArgs:
description: EventPipelineOrderUpdateArgs
properties:
data:
$ref: '#/components/schemas/EventPipelineOrderUpdateModel'
type: object
EventPipelineRunViewModel:
description: Query results
properties:
description:
description: Description
type: string
duration:
description: Duration
type: string
endDate:
description: EndDate
type: string
format: date-time
nullable: true
entityTypeName:
description: EntityTypeName
type: string
eventDateTime:
description: EventDateTime
type: string
format: date-time
eventDetails:
description: EventDetails
type: string
eventName:
description: EventName
type: string
eventPipelineId:
description: EventPipelineId
type: integer
format: int32
nullable: true
eventPipelinePolicyRunId:
description: EventPipelinePolicyRunId
type: string
format: uuid
itemId:
description: ItemId
type: integer
format: int32
itemName:
description: ItemName
type: string
name:
description: Name
type: string
queuedDate:
description: QueuedDate
type: string
format: date-time
startDate:
description: StartDate
type: string
format: date-time
nullable: true
status:
$ref: '#/components/schemas/EventPipelineStatus'
type: object
ViewFieldValueOfSettingForDisplay:
description: Setting
properties:
additionalLinks:
description: AdditionalLinks
items:
$ref: '#/components/schemas/ViewFieldLink'
type: array
description:
description: Description
type: string
fieldInputType:
description: FieldInputType
type: string
nullable: true
hasHistory:
description: HasHistory
type: boolean
nullable: true
helpLink:
description: HelpLink
type: string
helpLinkText:
description: HelpLinkText
type: string
hidden:
description: Hidden
type: boolean
nullable: true
hideOnView:
description: HideOnView
type: boolean
nullable: true
isRequired:
description: IsRequired
type: boolean
nullable: true
label:
description: Label
type: string
maxLength:
description: MaxLength
type: integer
format: int32
nullable: true
name:
description: Name
type: string
placeholder:
description: Placeholder
type: string
readOnly:
description: ReadOnly
type: boolean
nullable: true
readOnlyReason:
description: ReadOnlyReason
type: string
sortOrder:
description: SortOrder
type: integer
format: int32
nullable: true
value:
$ref: '#/components/schemas/SettingForDisplay'
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
PagingOfEventPipelineSummaryModel:
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/EventPipelineSummaryModel'
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
SettingType:
description: SettingType
properties: {}
type: string
enum:
- Default
- Integer
- String
- Boolean
- StringArray
- DropDown
- DropDownItem
- MultilineString
- IntegerArray
- Radio
- RadioItem
PagingOfEventPipelineViewModel:
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/EventPipelineViewModel'
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
InternalServerErrorResponse:
description: Response object for internal server errors
required:
- message
- exceptionMessage
- exceptionType
- stackTrace
properties:
message:
description: Error message
type: string
exceptionMessage:
description: Error message from exception
type: string
exceptionType:
description: Exception type
type: string
stackTrace:
description: Exception stack trace
type: string
type: object
UpdateFieldValueOfInt32:
description: How many days until the password expires.
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: integer
format: int32
type: object
UpdateFieldValueOfOptionalInt32:
description: The minimum length required for local user passwords
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: integer
format: int32
nullable: true
type: object
ViewFieldValueOfString:
description: GeneratedToken
properties:
additionalLinks:
description: AdditionalLinks
items:
$ref: '#/components/schemas/ViewFieldLink'
type: array
description:
description: Description
type: string
fieldInputType:
description: FieldInputType
type: string
nullable: true
hasHistory:
description: HasHistory
type: boolean
nullable: true
helpLink:
description: HelpLink
type: string
helpLinkText:
description: HelpLinkText
type: string
hidden:
description: Hidden
type: boolean
nullable: true
hideOnView:
description: HideOnView
type: boolean
nullable: true
isRequired:
description: IsRequired
type: boolean
nullable: true
label:
description: Label
type: string
maxLength:
description: MaxLength
type: integer
format: int32
nullable: true
name:
description: Name
type: string
placeholder:
description: Placeholder
type: string
readOnly:
description: ReadOnly
type: boolean
nullable: true
readOnlyReason:
description: ReadOnlyReason
type: string
sortOrder:
description: SortOrder
type: integer
format: int32
nullable: true
value:
description: Value
type: string
type: object
ViewFieldValueReadOnlyOfOptionalEventEntityTypeEnum:
description: EventEntityTypeId
properties:
additionalLinks:
description: AdditionalLinks
items:
$ref: '#/components/schemas/ViewFieldLink'
type: array
description:
description: Description
type: string
fieldInputType:
description: FieldInputType
type: string
nullable: true
hasHistory:
description: HasHistory
type: boolean
nullable: true
helpLink:
description: HelpLink
type: string
helpLinkText:
description: HelpLinkText
type: string
hidden:
description: Hidden
type: boolean
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-eventpipeline-api-openapi.yml