openapi: 3.2.0
info:
  title: Testkube Export API
  description: Testkube provides a Kubernetes-native framework for test definition, execution and results
  contact:
    email: contact@testkube.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.0.0
tags:
- name: Export
paths:
  /export:
    get:
      tags:
      - Export
      summary: Export execution data
      description: Exports all execution metadata, logs and workflow sequence numbers as a gzipped tar archive. The archive size is limited by the server (configured via the EXPORT_ARCHIVE_MAX_SIZE env var); use the 'since' parameter to narrow the date range if the limit is exceeded.
      operationId: exportExecutions
      parameters:
      - name: since
        in: query
        required: false
        description: Export only executions created after this date. Accepts ISO 8601 date (YYYY-MM-DD) or RFC 3339 timestamp (e.g. 2025-01-01T00:00:00Z).
        schema:
          type: string
        examples:
          date:
            value: '2025-01-01'
          datetime:
            value: '2025-01-01T00:00:00Z'
      responses:
        200:
          description: successful operation
          headers:
            Content-Disposition:
              description: Content disposition with the archive filename
              schema:
                type: string
                example: attachment; filename="testkube-export.tar.gz"
          content:
            application/gzip:
              schema:
                type: string
                format: binary
        400:
          description: invalid 'since' parameter value
          content:
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Problem'
        413:
          description: export archive exceeds the server-configured size limit
          content:
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Problem'
        500:
          description: problem with exporting execution data
          content:
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Problem'
components:
  schemas:
    Problem:
      description: problem response in case of error
      type: object
      properties:
        type:
          type: string
          description: Type contains a URI that identifies the problem type.
          example: https://kubeshop.io/testkube/problems/invalidtestname
        title:
          type: string
          description: Title is a short, human-readable summary of the problem type. This title SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
          example: Invalid test name
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem.
          example: 500
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: Your test name can't contain forbidden characters like "}}}" passed
        instance:
          type: string
          description: A URI that identifies the specific occurrence of the problem. This URI may or may not yield further information if de-referenced.
          example: http://10.23.23.123:8088/tests
externalDocs:
  description: Find out more about Testkube
  url: https://testkube.kubeshop.io/