Retrieve GitOps logs

GET 
/api/v1/gitops-logs

Retrieve GitOps logs

Request

Query Parameters

file string

File name the within repository

repository string

Repository name as defined in your Git provider

sha string

Commit SHA

errorOnly boolean

Filter by error only

operation string

Possible values: [CREATED, UPDATED, ARCHIVED, NO_CHANGE]

Filter by operation

page int32required

Default value: 0

Page number to return, 0 indexed.

pageSize int32required

Default value: 50

Number of results to return per page.

fileName string

Responses

200

Retrieve GitOps logs based on given criteria

application/json

Schema

Schema

logs

object[]

required

Array [

commit stringrequired

dateCreated date-timerequired

files

object[]

required

Array [

entity

object

name stringrequired

operation stringrequired

Possible values: [CREATED, UPDATED, ARCHIVED, NO_CHANGE]

tag stringrequired

type stringrequired

error

object

errorType stringrequired

message stringrequired

fileName stringrequired

isPackageFile booleanrequired

scorecard

object

name stringrequired

operation stringrequired

Possible values: [CREATED, UPDATED, ARCHIVED, NO_CHANGE]

tag stringrequired

]

repository

object

required

provider stringrequired

Possible values: [AZURE_DEVOPS, BITBUCKET, GITHUB, GITLAB]

Name of the Git provider

repositoryName stringrequired

Repository name as defined in your Git provider

]

page int32required

Current page number, 0-indexed

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "logs": [
    {
      "commit": "string",
      "dateCreated": "2024-04-26T18:10:54.028Z",
      "files": [
        {
          "entity": {
            "name": "string",
            "operation": "CREATED",
            "tag": "string",
            "type": "string"
          },
          "error": {
            "errorType": "string",
            "message": "string"
          },
          "fileName": "string",
          "isPackageFile": true,
          "scorecard": {
            "name": "string",
            "operation": "CREATED",
            "tag": "string"
          }
        }
      ],
      "repository": {
        "provider": "GITHUB",
        "repositoryName": "cortexapps/catalog"
      }
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

Loading...