Delinea Reports API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations Reports 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: Reports
  description: View and maintain Reports
paths:
  /v1/reports/{id}:
    get:
      tags:
      - Reports
      summary: Get Report
      description: Gets a Report and returns the Report Model
      operationId: ReportsService_GetReportDetail
      parameters:
      - name: id
        in: path
        description: Report ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Report object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportModel'
        '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:
      - Reports
      summary: Update Report
      description: Updates a Report and returns the report
      operationId: ReportsService_UpdateReport
      parameters:
      - name: id
        in: path
        description: Report ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportUpdateArgs'
        description: Report update options
      responses:
        '200':
          description: Report object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportModel'
        '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
    delete:
      tags:
      - Reports
      summary: Delete Report
      description: Delete a report by ID
      operationId: ReportsService_Delete
      parameters:
      - name: id
        in: path
        description: Report ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          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
  /v2/reports/{id}:
    delete:
      tags:
      - Reports
      summary: Delete Report
      description: Delete a report by ID
      operationId: ReportsService_DeleteV2
      parameters:
      - name: id
        in: path
        description: Report ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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/reports/categories/{reportCategoryId}:
    get:
      tags:
      - Reports
      summary: Get Report Category
      description: Get Report Category
      operationId: ReportsService_GetReportCategory
      parameters:
      - name: reportCategoryId
        in: path
        description: reportCategoryId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Report Category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCategoryDetailModel'
        '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
    delete:
      tags:
      - Reports
      summary: Delete Report Category
      description: This will delete the report category and all assigned reports will be set inactive
      operationId: ReportsService_DeleteReportCategory
      parameters:
      - name: reportCategoryId
        in: path
        description: reportCategoryId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: true if 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
    patch:
      tags:
      - Reports
      summary: Update Report Category
      description: Update Report Category
      operationId: ReportsService_UpdateReportCategory
      parameters:
      - name: reportCategoryId
        in: path
        description: reportCategoryId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCategoryUpdateArgs'
        description: args
      responses:
        '200':
          description: Report Category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCategoryDetailModel'
        '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
  /v2/reports/categories/{reportCategoryId}:
    delete:
      tags:
      - Reports
      summary: Delete Report Category
      description: This will delete the report category and all assigned reports will be set inactive
      operationId: ReportsService_DeleteReportCategoryV2
      parameters:
      - name: reportCategoryId
        in: path
        description: reportCategoryId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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/reports/schedules/{reportScheduleId}:
    get:
      tags:
      - Reports
      summary: Get Report Schedule
      description: Get Report Schedule
      operationId: ReportsService_GetReportSchedule
      parameters:
      - name: reportScheduleId
        in: path
        description: reportScheduleId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Report Schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleModel'
        '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
    delete:
      tags:
      - Reports
      summary: Delete Report Schedule
      description: Delete Report Schedule
      operationId: ReportsService_DeleteReportSchedule
      parameters:
      - name: reportScheduleId
        in: path
        description: reportScheduleId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: 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
    patch:
      tags:
      - Reports
      summary: Update Report Schedule
      description: Update Report Schedule
      operationId: ReportsService_UpdateReportSchedule
      parameters:
      - name: reportScheduleId
        in: path
        description: reportScheduleId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportScheduleUpdateArgs'
        description: args
      responses:
        '200':
          description: Report Schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleModel'
        '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
  /v2/reports/schedules/{reportScheduleId}:
    delete:
      tags:
      - Reports
      summary: Delete Report Schedule
      description: Delete Report Schedule
      operationId: ReportsService_DeleteReportScheduleV2
      parameters:
      - name: reportScheduleId
        in: path
        description: reportScheduleId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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/reports/{id}/audits:
    get:
      tags:
      - Reports
      summary: Get Report Audits
      description: Get report audits by report Id
      operationId: ReportsService_GetReportAuditsById
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Report Audit Summaries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfReportAuditSummary'
        '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/reports/audits:
    get:
      tags:
      - Reports
      summary: Get All Report Audits
      description: Get all report audits
      operationId: ReportsService_GetReportAudits
      parameters:
      - name: isExporting
        in: query
        description: isExporting
        required: false
        schema:
          type: boolean
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Report Audit Summaries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfReportAuditSummary'
        '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/reports:
    get:
      tags:
      - Reports
      summary: Search Reports
      description: Search, filter, sort, and page reports
      operationId: ReportsService_SearchReportSummary
      parameters:
      - name: filter.categoryId
        in: query
        description: Category ID
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive Reports in the results
        required: false
        schema:
          type: boolean
      - name: filter.reportName
        in: query
        description: Report Name - Searching by report name ignores other filters
        required: false
        schema:
          type: string
      - 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: Report search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfReportSummary'
        '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:
      - Reports
      summary: Create Report
      description: Creates a new Report and returns the report
      operationId: ReportsService_CreateReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCreateArgs'
        description: Report create options
      responses:
        '200':
          description: Report object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportModel'
        '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/reports/lookup:
    get:
      tags:
      - Reports
      summary: Lookup Reports
      description: Search, filter, sort, and page reports, returning only group ID and name
      operationId: ReportsService_Lookup
      parameters:
      - name: filter.categoryId
        in: query
        description: Category ID
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive Reports in the results
        required: false
        schema:
          type: boolean
      - name: filter.reportName
        in: query
        description: Report Name - Searching by report name ignores other filters
        required: false
        schema:
          type: string
      - 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: Reports search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfReportLookup'
        '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/reports/categories:
    get:
      tags:
      - Reports
      summary: List Report Categories
      description: List the report categories
      operationId: ReportsService_GetCategories
      responses:
        '200':
          description: Report categories array
          content:
            application/json:
              schema:
                description: Report categories array
                items:
                  $ref: '#/components/schemas/ReportCategory'
                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
    post:
      tags:
      - Reports
      summary: Create Report Category
      description: Create Report Category
      operationId: ReportsService_CreateReportCategory
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCategoryCreateArgs'
        description: args
      responses:
        '200':
          description: Report Category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCategoryDetailModel'
        '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/reports/charttypes:
    get:
      tags:
      - Reports
      summary: List Report Chart Types
      description: List the report chart types
      operationId: ReportsService_GetChartTypes
      responses:
        '200':
          description: Report chart types array
          content:
            application/json:
              schema:
                description: Report chart types array
                items:
                  $ref: '#/components/schemas/ReportChartType'
                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/reports/{id}/defaultparameters:
    get:
      tags:
      - Reports
      summary: Report Parameters
      description: Gets the default parameters for the specified report
      operationId: ReportsService_GetDefaultParameters
      parameters:
      - name: id
        in: path
        description: Report ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Report Parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDefaultParams'
        '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/reports/schedules:
    get:
      tags:
      - Reports
      summary: Search Report Schedules
      description: Search Report Schedules
      operationId: ReportsService_SearchReportSchedules
      parameters:
      - name: filter.includeDeleted
        in: query
        description: When set, deleted reports will be included
        required: false
        schema:
          type: boolean
      - name: filter.reportId
        in: query
        description: Report Id
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      res

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