Cortex GitOps Logs API

openapi: 3.2.0
info:
  description: The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more.
  title: Cortex GitOps Logs API
  version: v1
servers:
- url: https://api.getcortexapp.com
  description: Cortex Cloud API host
security:
- bearerAuth: []
tags:
- name: GitOps Logs
paths:
  /api/v1/gitops-logs:
    get:
      description: API key must have the `View GitOps logs` permission.
      operationId: listGitOpsLogs
      parameters:
      - description: File name the within repository
        in: query
        name: file
        schema:
          type: string
      - description: Repository name as defined in your Git provider
        in: query
        name: repository
        required: false
        schema:
          type: string
      - description: Commit SHA
        in: query
        name: sha
        required: false
        schema:
          type: string
      - description: Filter by error only
        in: query
        name: errorOnly
        required: false
        schema:
          type: boolean
      - description: Filter by operation
        in: query
        name: operation
        required: false
        schema:
          type: string
          enum:
          - CREATED
          - UPDATED
          - ARCHIVED
          - NO_CHANGE
      - description: Page number to return, 0-indexed. Default 0.
        in: query
        name: page
        required: true
        schema:
          type: integer
          format: int32
          default: 0
      - description: Number of results to return per page, between 1 and 1000. Default 250.
        in: query
        name: pageSize
        required: true
        schema:
          type: integer
          format: int32
          default: 250
      - in: query
        name: fileName
        required: false
        schema:
          type: string
      - description: Unique tag for the Scorecard.
        in: query
        name: scorecardTag
        required: true
        schema:
          type: string
      - in: query
        name: workflowTag
        required: false
        schema:
          type: string
      - description: The entity tag (`x-cortex-tag`) that identifies the entity.
        in: query
        name: tag
        required: true
        schema:
          type: string
          description: The entity tag (`x-cortex-tag`) that identifies the entity.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitOpsLogPaginatedResponse'
          description: Retrieve GitOps logs based on given criteria
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Retrieve GitOps logs
      tags:
      - GitOps Logs
      x-cortex-mcp-enabled: 'false'
components:
  schemas:
    GitOpsLogResponse:
      required:
      - commit
      - dateCreated
      - files
      - repository
      type: object
      properties:
        commit:
          type: string
        dateCreated:
          type: string
          format: date-time
        files:
          type: array
          items:
            $ref: '#/components/schemas/GitOpsLogFileResponse'
        repository:
          $ref: '#/components/schemas/GitOpsLogRepositoryResponse'
    GitOpsLogEntityChange:
      required:
      - name
      - operation
      - tag
      - type
      type: object
      properties:
        name:
          type: string
        operation:
          type: string
          enum:
          - CREATED
          - UPDATED
          - ARCHIVED
          - NO_CHANGE
        tag:
          type: string
        type:
          type: string
    GitOpsLogScorecardChange:
      required:
      - name
      - operation
      - tag
      type: object
      properties:
        name:
          type: string
        operation:
          type: string
          enum:
          - CREATED
          - UPDATED
          - ARCHIVED
          - NO_CHANGE
        tag:
          type: string
    GitOpsLogFileErrorResponse:
      required:
      - errorType
      - message
      type: object
      properties:
        errorType:
          type: string
        message:
          type: string
    GitOpsLogFileResponse:
      required:
      - fileName
      - isPackageFile
      type: object
      properties:
        entity:
          $ref: '#/components/schemas/GitOpsLogEntityChange'
        error:
          $ref: '#/components/schemas/GitOpsLogFileErrorResponse'
        fileName:
          type: string
        isPackageFile:
          type: boolean
        scorecard:
          $ref: '#/components/schemas/GitOpsLogScorecardChange'
        workflow:
          $ref: '#/components/schemas/GitOpsLogWorkflowChange'
    GitOpsLogRepositoryResponse:
      required:
      - provider
      - repositoryName
      type: object
      properties:
        provider:
          type: string
          description: Name of the Git provider
          example: GITHUB
          enum:
          - AZURE_DEVOPS
          - BITBUCKET
          - GITHUB
          - GITLAB
        repositoryName:
          type: string
          description: Repository name as defined in your Git provider
          example: cortexapps/catalog
    TooManyRequestsProblemDetail:
      required:
      - type
      - title
      - status
      type: object
      properties:
        detail:
          type: string
        instance:
          type: string
          format: uri-reference
        retryAfter:
          minimum: 0
          type: integer
          description: The number of seconds until the rate limiting resets.
          format: int32
        status:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          enum:
          - 429
        title:
          type: string
        type:
          type: string
          format: uri-reference
    GitOpsLogPaginatedResponse:
      required:
      - logs
      - page
      - total
      - totalPages
      type: object
      properties:
        logs:
          type: array
          items:
            $ref: '#/components/schemas/GitOpsLogResponse'
        page:
          type: integer
          description: Current page number, 0-indexed
          format: int32
        total:
          type: integer
          description: Total number of results
          format: int32
        totalPages:
          type: integer
          description: Total number of pages
          format: int32
    GitOpsLogWorkflowChange:
      required:
      - name
      - operation
      - tag
      type: object
      properties:
        name:
          type: string
        operation:
          type: string
          enum:
          - CREATED
          - UPDATED
          - ARCHIVED
          - NO_CHANGE
        tag:
          type: string
  responses:
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/TooManyRequestsProblemDetail'
      description: The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
      headers:
        Retry-After:
          description: The number of seconds until the rate limiting resets.
          schema:
            minimum: 0
            type: integer
            format: int32
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: 'All requests to the Cortex API need to provide an `Authorization: Bearer <token>` header, where `<token>` is an API key created in the Settings page of your workspace.'
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Cortex
  source: https://docs.cortex.io/openapi/cortex_swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)