Delinea JumpboxRoute API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations JumpboxRoute 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: JumpboxRoute
  description: JumpboxRouteController
paths:
  /v1/jumpbox-route/{id}/level/{order}:
    delete:
      tags:
      - JumpboxRoute
      summary: Delete JumpboxRoute Level
      description: Delete a Jumpbox Route Level on a Jumpbox Route
      operationId: JumpboxRouteService_DeleteJumpboxRouteLevel
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
          format: uuid
      - name: order
        in: path
        description: order
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Boolean
          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
    patch:
      tags:
      - JumpboxRoute
      summary: Edit JumpboxRoute Level
      description: Edit a Jumpbox Route Level
      operationId: JumpboxRouteService_PatchJumpboxRouteLevel
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
          format: uuid
      - name: order
        in: path
        description: order
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JumpboxRouteLevelPatchArgs'
        description: args
      responses:
        '200':
          description: JumpboxRouteLevel Summary Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JumpboxRouteLevelSummaryModel'
        '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/jumpbox-route/search:
    get:
      tags:
      - JumpboxRoute
      summary: Search JumpboxRoutes
      description: Search, filter, sort, and page Jumpbox routes
      operationId: JumpboxRouteService_Search
      parameters:
      - name: filter.includeActive
        in: query
        description: IncludeActive
        required: false
        schema:
          type: boolean
      - name: filter.includeInactive
        in: query
        description: IncludeInactive
        required: false
        schema:
          type: boolean
      - 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
      responses:
        '200':
          description: JumpboxRoute search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfJumpboxRouteSummaryModel'
        '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/jumpbox-route/user:
    get:
      tags:
      - JumpboxRoute
      summary: Get Jumpbox Routes visible to a user
      description: Get an array of Jumpbox Routes that are visible to a specific user
      operationId: JumpboxRouteService_GetAllRoutesForUser
      parameters:
      - name: filter.includeActive
        in: query
        description: IncludeActive
        required: false
        schema:
          type: boolean
      - name: filter.includeInactive
        in: query
        description: IncludeInactive
        required: false
        schema:
          type: boolean
      - 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
      responses:
        '200':
          description: Jumpbox Route Summary Model paging object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfJumpboxRouteSummaryModel'
        '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/jumpbox-route/{id}:
    get:
      tags:
      - JumpboxRoute
      summary: Find JumpboxRoute
      description: Find a Jumpbox Route by Id
      operationId: JumpboxRouteService_Get
      parameters:
      - name: id
        in: path
        description: Jumpbox Route Id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: JumpboxRoute detail object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JumpboxRouteModel'
        '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:
      - JumpboxRoute
      summary: Udpate a Jumpbox Route
      description: Update an existing Jumpbox Route using the existing Jumpbox Route's ID
      operationId: JumpboxRouteService_UpdateJumpboxRoute
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JumpboxRoutePatchArgs'
        description: jumpboxRouteUpdateArgs
      responses:
        '200':
          description: JumpboxRoute Summary Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JumpboxRouteSummaryModel'
        '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/jumpbox-route/{id}/audit:
    get:
      tags:
      - JumpboxRoute
      summary: Get Jumpbox Route Audits
      description: Retrieve audits for the Jumpbox Routes
      operationId: JumpboxRouteService_GetJumpboxAudits
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
          format: uuid
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - 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
      responses:
        '200':
          description: A paged list of audit entries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfJumpboxRouteAuditModel'
        '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/jumpbox-route/{id}/level:
    get:
      tags:
      - JumpboxRoute
      summary: Find Levels for a Jumpbox Route
      description: Find all Levels for a Jumpbox Route by Jumpbox Route Id
      operationId: JumpboxRouteService_GetAllLevels
      parameters:
      - name: id
        in: path
        description: Jumpbox Route Id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Jumpbox route Level View Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfJumpboxRouteLevelViewModel'
        '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:
      - JumpboxRoute
      summary: Create JumpboxRoute Level
      description: Create a new Jumpbox Route Level
      operationId: JumpboxRouteService_AddJumpboxRouteLevel
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JumpboxRouteLevelCreateArgs'
        description: args
      responses:
        '200':
          description: JumpboxRouteLevel Summary Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JumpboxRouteLevelSummaryModel'
        '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/jumpbox-route:
    post:
      tags:
      - JumpboxRoute
      summary: Create JumpboxRoute
      description: Create a new Jumpbox Route
      operationId: JumpboxRouteService_CreatejumpboxRoute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JumpboxRouteCreateArgs'
        description: args
      responses:
        '200':
          description: JumpboxRoute Summary Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JumpboxRouteSummaryModel'
        '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
    JumpboxRouteModel:
      description: JumpboxRouteModel
      properties:
        active:
          description: Indicates if the Jumpbox Route is active
          type: boolean
        description:
          description: Jumpbox Route Descrition
          type: string
        jumpboxRouteId:
          description: Jumpbox Route Id
          type: string
          format: uuid
        jumpboxRouteLevels:
          description: Array of Jumpbox Route Levels attached to a Jumpbox Route
          items:
            $ref: '#/components/schemas/JumpboxRouteLevelModel'
          type: array
        name:
          description: Jumpbox Route Name
          type: string
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    JumpboxRoutePatchModel:
      description: Data
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        description:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
        name:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    PagingOfJumpboxRouteSummaryModel:
      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/JumpboxRouteSummaryModel'
          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
    JumpboxRouteSummaryModel:
      description: Query results
      properties:
        active:
          description: Active
          type: boolean
        description:
          description: Description
          type: string
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
          nullable: true
        name:
          description: Name
          type: string
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    JumpboxRouteLevelModel:
      description: Array of Jumpbox Route Levels attached to a Jumpbox Route
      properties:
        jumpboxRouteId:
          description: Jumpbox Route Id
          type: string
          format: uuid
        order:
          description: Jumpbox Route Level Order
          type: integer
          format: int32
        port:
          description: Port Assigned to this Jumpbox Route Level
          type: integer
          format: int32
        secretId:
          description: Secret Id Assigned to this Jumpbox Route Level
          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
    JumpboxRouteLevelPatchModel:
      description: Data
      properties:
        order:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        port:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        secretId:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
      type: object
    JumpboxRouteCreateArgs:
      description: JumpboxRouteCreateArgs
      properties:
        data:
          $ref: '#/components/schemas/JumpboxRouteCreateModel'
      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
    JumpboxRouteCreateModel:
      description: Data
      properties:
        active:
          description: Active
          type: boolean
        description:
          description: Description
          type: string
        name:
          description: Name
          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
    ViewFieldLink:
      description: AdditionalLinks
      properties:
        isExternal:
          description: IsExternal
          type: boolean
        linkText:
          description: LinkText
          type: string
        url:
          description: Url
          type: string
      type: object
    JumpboxRoutePatchArgs:
      description: JumpboxRoutePatchArgs
      properties:
        data:
          $ref: '#/components/schemas/JumpboxRoutePatchModel'
      type: object
    JumpboxRouteLevelViewModel:
      description: Query results
      properties:
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
        order:
          $ref: '#/components/schemas/ViewFieldValueOfInt32'
        port:
          $ref: '#/components/schemas/ViewFieldValueOfInt32'
        secretId:
          $ref: '#/components/schemas/ViewFieldValueOfInt32'
      type: object
    ViewFieldValueOfInt32:
      description: OrganizationId
      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: integer
          format: int32
      type: object
    JumpboxRouteLevelCreateArgs:
      description: JumpboxRouteLevelCreateArgs
      properties:
        data:
          $ref: '#/components/schemas/JumpboxRouteLevelCreateModel'
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    JumpboxRouteLevelCreateModel:
      description: Data
      properties:
        port:
          description: Port
          type: integer
          format: int32
        secretId:
          description: SecretId
          type: integer
          format: int32
      type: object
    JumpboxRouteLevelPatchArgs:
      description: JumpboxRouteLevelPatchArgs
      properties:
        data:
          $ref: '#/components/schemas/JumpboxRouteLevelPatchModel'
      type: object
    PagingOfJumpboxRouteAuditModel:
      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/JumpboxRouteAuditModel'
          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
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
    JumpboxRouteAuditModel:
      description: Query results
      properties:
        action:
          description: Action
          type: string
        auditId:
          description: Audit ID
          type: string
          format: uuid
        date:
          description: Date
          type: string
        notes:
          description: Notes
          type: string
        userDisplayName:
          description: User Display Name
          type: string
      type: object
    JumpboxRouteLevelSummaryModel:
      description: JumpboxRouteLevelSummaryModel
      properties:
        jumpboxRouteId:
          description: JumpboxRouteId
          type: string
          format: uuid
        order:
          description: Order
          type: integer
          format: int32
        port:
          description: Port
          type: integer
          format: int32
        secretId:
          description: SecretId
          type: integer
          format: int32
      type: object
    PagingOfJumpboxRouteLevelViewModel:
      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
          

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