Get Cluster Gitops Status Endpoint

GET /api/v1/clusters/{cluster_id}/gitops/status

Get Cluster Gitops Status Endpoint

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/{cluster_id}/gitops/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "sync_status": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_synced_from": "<string>",
  "last_commit_sha": "<string>",
  "last_commit_timestamp": "2023-11-07T05:31:56Z",
  "pending_commit_sha": "<string>",
  "sync_phase": "<string>",
  "sync_progress_message": "<string>",
  "applied_with_failed_members": false,
  "error": {
    "error_type": "<string>",
    "resource_type": "<string>",
    "resource_name": "<string>",
    "missing_fields": [
      {
        "field": "<string>",
        "description": "<string>",
        "example": "<string>"
      }
    ],
    "invalid_fields": [
      "<string>"
    ],
    "message": "<string>"
  },
  "retry_count": 0,
  "cluster_name": "<string>",
  "cluster_short_id": "<string>",
  "git_repo": {
    "provider": "<string>",
    "branch": "<string>",
    "web_url": "<string>",
    "repo_owner": "<string>",
    "repo_name": "<string>",
    "workspace": "<string>",
    "repo_slug": "<string>",
    "project_key": "<string>",
    "instance_url": "<string>",
    "credential_name": "<string>"
  },
  "credential_missing": false
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

cluster_id · string<uuid4> · required

Response

200

application/json

Successful Response

sync_status · string | null

last_synced_at · string<date-time> | null

last_synced_from · string | null

last_commit_sha · string | null

last_commit_timestamp · string<date-time> | null

pending_commit_sha · string | null

sync_phase · string | null

sync_progress_message · string | null

applied_with_failed_members · boolean · default: false

error · ValidationErrorInfo · object

ValidationErrorInfo

MultipleValidationErrorsInfo

GeneralErrorInfo

Show child attributes

retry_count · integer · default: 0

cluster_name · string | null

cluster_short_id · string | null

git_repo · GitRepoInfo · object | null

Show child attributes

credential_missing · boolean · default: false

True when the cluster's GitOps repository row names a credential that no longer resolves to a stored credential of that provider - a dangling binding whose pushes fail as 404 while git_repo still reads as configured.