Resolve a preserved GitOps path

import requests

url = "https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/gitops/preserved-paths/resolve"

payload = {
    "path": "<string>",
    "head_content_hash": "<string>",
    "render_content_hash": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    path: '<string>',
    head_content_hash: '<string>',
    render_content_hash: '<string>'
  })
};

fetch('https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/gitops/preserved-paths/resolve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/gitops/preserved-paths/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "head_content_hash": "<string>",
  "render_content_hash": "<string>"
}
'

{
  "path": "<string>",
  "resolution": "git",
  "sync_triggered": true,
  "message": "<string>"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

Clusters

Resolve a preserved GitOps path

Records a decision on one preserved file, over the two sides the caller listed: git imports Git’s content into the platform, cluster writes Ankra’s version into Git and makes the file Ankra’s again, none withdraws a decision that has not run yet. The next sync executes a decision; a git decision runs once every preserved file on the cluster has a decision, because the import reads Git at head, and an import the platform refuses (for example one that would lower an add-on’s chart version) records why on the file and clears the decision. Nothing is written to Git by this call. Requires clusters.write on the cluster. Bearer-PAT twin of the browser route of the same name under /org.

POST

api

org

clusters

{cluster_id}

gitops

preserved-paths

resolve

Resolve a preserved GitOps path

import requests

url = "https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/gitops/preserved-paths/resolve"

payload = {
    "path": "<string>",
    "head_content_hash": "<string>",
    "render_content_hash": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    path: '<string>',
    head_content_hash: '<string>',
    render_content_hash: '<string>'
  })
};

fetch('https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/gitops/preserved-paths/resolve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/gitops/preserved-paths/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "head_content_hash": "<string>",
  "render_content_hash": "<string>"
}
'

{
  "path": "<string>",
  "resolution": "git",
  "sync_triggered": true,
  "message": "<string>"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

Authorizations

Authorization

string

header

required

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

Headers

x-ankra-organisation-id

string

PAT organisation override.

Path Parameters

cluster_id

string<uuid>

required

Body

application/json

path

string

required

Full repository path of the preserved file, as the listing names it.

resolution

enum<string>

required

git imports Git's content into the platform; cluster writes Ankra's version into Git; none withdraws a decision that has not run yet, so the file awaits one again.

Available options:

git,

cluster,

none

head_content_hash

string

required

The head_content_hash the listing returned. A file that changed in Git since is refused with 409. Not compared for none.

render_content_hash

string

required

The render_content_hash the listing returned. A file whose Ankra version changed since is refused with 409. Not compared for none.

Response

The decision was recorded, or withdrawn for none.

path

string

required

resolution

enum<string>

required

Available options:

git,

cluster,

none

sync_triggered

boolean

required

Whether a sync was nudged to execute the decision now; the next periodic sync executes it otherwise. Always false for none, which has nothing to execute.

message

string

required

API reference

Endpoints

Resolve a preserved GitOps path

Authorizations

Headers

Path Parameters

Body

Response