GitOps Logs

Use these operations to interact with GitOps logs in Cortex.

Required permissions

Your API key must have the View GitOps logs permission.

Operations

Retrieve GitOps logs

get

API key must have the View GitOps logs permission.

Authorizations
Query parameters
filestringOptional

File name the within repository

repositorystringOptional

Repository name as defined in your Git provider

shastringOptional

Commit SHA

errorOnlybooleanOptional

Filter by error only

operationstring · enumOptional

Filter by operation

Possible values:
pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0
pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250
fileNamestringOptional
scorecardTagstringRequired

Unique tag for the Scorecard.

workflowTagstringOptional
tagstringRequired

The entity tag (x-cortex-tag) that identifies the entity.

Responses
200
Retrieve GitOps logs based on given criteria
application/json
get
GET /api/v1/gitops-logs HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "logs": [
    {
      "commit": "text",
      "dateCreated": "2025-06-28T19:25:44.176Z",
      "files": [
        {
          "entity": {
            "name": "text",
            "operation": "CREATED",
            "tag": "text",
            "type": "text"
          },
          "error": {
            "errorType": "text",
            "message": "text"
          },
          "fileName": "text",
          "isPackageFile": true,
          "scorecard": {
            "name": "text",
            "operation": "CREATED",
            "tag": "text"
          },
          "workflow": {
            "name": "text",
            "operation": "CREATED",
            "tag": "text"
          }
        }
      ],
      "repository": {
        "provider": "GITHUB",
        "repositoryName": "cortexapps/catalog"
      }
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Last updated

Was this helpful?