Record a computed proposal (upsert by dedupe key)

import requests

url = "https://platform.ankra.app/api/v1/org/decisions"

payload = { "dedupe_key": "<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({dedupe_key: '<string>'})
};

fetch('https://platform.ankra.app/api/v1/org/decisions', 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/decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dedupe_key": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "area": "security",
  "kind": "<string>",
  "subject": {},
  "summary": "<string>",
  "plan": {},
  "evidence": {},
  "status": "proposed",
  "source": "<string>",
  "created_by": "<string>",
  "decided_by": "<string>",
  "decided_at": "2023-11-07T05:31:56Z",
  "decision_note": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receipt": {
    "steps": [
      {
        "name": "<string>",
        "outcome": "dispatched",
        "detail": "<string>",
        "evidence": {}
      }
    ],
    "claimed_at": "2023-11-07T05:31:56Z",
    "executed_by": "<string>",
    "dispatched_at": "2023-11-07T05:31:56Z",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completed_at": "2023-11-07T05:31:56Z",
    "execution_status": "<string>"
  },
  "dedupe_key": "<string>",
  "executable": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "area": "security",
  "kind": "<string>",
  "subject": {},
  "summary": "<string>",
  "plan": {},
  "evidence": {},
  "status": "proposed",
  "source": "<string>",
  "created_by": "<string>",
  "decided_by": "<string>",
  "decided_at": "2023-11-07T05:31:56Z",
  "decision_note": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receipt": {
    "steps": [
      {
        "name": "<string>",
        "outcome": "dispatched",
        "detail": "<string>",
        "evidence": {}
      }
    ],
    "claimed_at": "2023-11-07T05:31:56Z",
    "executed_by": "<string>",
    "dispatched_at": "2023-11-07T05:31:56Z",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completed_at": "2023-11-07T05:31:56Z",
    "execution_status": "<string>"
  },
  "dedupe_key": "<string>",
  "executable": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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"
}

Decisions

Record a computed proposal (upsert by dedupe key)

Records what a surface computed. The dedupe key is the proposal’s identity within the organisation: a re-post refreshes a proposal nobody has decided and leaves a decided, running or finished one exactly as it was decided, so an approval is always of the plan the person saw. status “superseded” withdraws the proposal the dedupe key names instead; withdrawing one somebody approved or set aside erases that decision and takes the area’s permission (403 otherwise). Any member who may write may propose; a scoped token needs the area’s permission. Answers 201 when the dedupe key was new and 200 when it named an existing proposal. Bearer-PAT twin of the browser route of the same name under /org; the console’s session cookie is not accepted here and the browser route answers a token with a login redirect.

POST

api

org

decisions

Record a computed proposal (upsert by dedupe key)

import requests

url = "https://platform.ankra.app/api/v1/org/decisions"

payload = { "dedupe_key": "<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({dedupe_key: '<string>'})
};

fetch('https://platform.ankra.app/api/v1/org/decisions', 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/decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dedupe_key": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "area": "security",
  "kind": "<string>",
  "subject": {},
  "summary": "<string>",
  "plan": {},
  "evidence": {},
  "status": "proposed",
  "source": "<string>",
  "created_by": "<string>",
  "decided_by": "<string>",
  "decided_at": "2023-11-07T05:31:56Z",
  "decision_note": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receipt": {
    "steps": [
      {
        "name": "<string>",
        "outcome": "dispatched",
        "detail": "<string>",
        "evidence": {}
      }
    ],
    "claimed_at": "2023-11-07T05:31:56Z",
    "executed_by": "<string>",
    "dispatched_at": "2023-11-07T05:31:56Z",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completed_at": "2023-11-07T05:31:56Z",
    "execution_status": "<string>"
  },
  "dedupe_key": "<string>",
  "executable": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "area": "security",
  "kind": "<string>",
  "subject": {},
  "summary": "<string>",
  "plan": {},
  "evidence": {},
  "status": "proposed",
  "source": "<string>",
  "created_by": "<string>",
  "decided_by": "<string>",
  "decided_at": "2023-11-07T05:31:56Z",
  "decision_note": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receipt": {
    "steps": [
      {
        "name": "<string>",
        "outcome": "dispatched",
        "detail": "<string>",
        "evidence": {}
      }
    ],
    "claimed_at": "2023-11-07T05:31:56Z",
    "executed_by": "<string>",
    "dispatched_at": "2023-11-07T05:31:56Z",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completed_at": "2023-11-07T05:31:56Z",
    "execution_status": "<string>"
  },
  "dedupe_key": "<string>",
  "executable": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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.

Body

application/json

Body of POST /api/v1/org/decisions: what a surface computed, keyed by dedupe_key. With status "superseded" only dedupe_key is read.

dedupe_key

string

required

Maximum string length: 512

area

enum<string>

Available options:

security,

cost

kind

string

Maximum string length: 64

subject

object

summary

string

Maximum string length: 2000

plan

object

evidence

object

source

string

Maximum string length: 64

status

enum<string>

default:proposed

Available options:

proposed,

superseded

Response

The proposal the dedupe key already named, refreshed or left as decided

One proposal of the decision ledger: what it is about, what the surface computed, where it stands, who decided, and what running it did.

string<uuid>

required

area

enum<string>

required

security or cost; decides which permission approving and running it takes.

Available options:

security,

cost

kind

string

required

What the proposal does, e.g. addon_upgrade, image_rebuild, right_size, off_hours_schedule, waste_cleanup. Only kinds with a platform operation are executable.

subject

object

required

Identity of what the proposal is about (finding_id, cluster_id, addon_name, waste_finding_id ...), one document per kind.

summary

string

required

plan

object

required

The steps the surface computed. plan.parameters is the machine half the executable kinds are called with: addon_upgrade takes {cluster_id, addon_name, chart_version}; off_hours_schedule takes {cluster_id, timezone, schedules: [{action, stop_mode, cron_expression}]}; waste_cleanup takes {waste_finding_id}.

evidence

object

required

status

enum<string>

required

Available options:

proposed,

approved,

set_aside,

running,

succeeded,

failed,

superseded

source

string

required

Which surface computed it (default "surface").

created_by

string | null

required

Ankra user id of whoever posted it.

decided_by

string | null

required

Ankra user id of the last approve or set-aside.

decided_at

string<date-time> | null

required

decision_note

string | null

required

operation_id

string<uuid> | null

required

The platform execution a run dispatched, to watch under /api/v1/org/executions.

receipt

DecisionReceipt · object | null

required

The record of running a proposal: who ran it and when, the platform operation it became, the steps taken and how it ended.

Show child attributes

dedupe_key

string

required

executable

boolean

required

Whether the platform has an operation for the kind, so a surface offers "run" only where running can work.

created_at

string<date-time>

required

updated_at

string<date-time>

required

API reference

Endpoints

Record a computed proposal (upsert by dedupe key)

Authorizations

Headers

Body

Response