Retry a terminal execution

Starts a new execution that repeats a failed, cancelled or critical execution’s steps, and returns the new execution. Answers 409 when the execution is in any other state, when none of its steps has a target resource left to act on, when one of its steps is still running or cancelling, or while any execution in its retry tree (the execution it was retried from, every retry of that one, and their retries) is still live: one retry tree has at most one live execution.

POST /api/v1/org/executions/{execution_id}/retry

Retry a terminal execution

Python

import requests

url = "https://platform.ankra.app/api/v1/org/executions/{execution_id}/retry"

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

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

print(response.text)

200

{
  "display_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "cluster",
  "status": "running",
  "type": "<string>",
  "capture_trigger": "stop",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "error_excerpt": "<string>",
  "outcome": "unknown",
  "step_summary": {
    "failed": 0,
    "pending": 0,
    "running": 0,
    "succeeded": 0,
    "total": 0
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "upgrade": {
    "from_version": "<string>",
    "target_version": "<string>"
  }
}

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

execution_id · string<uuid4> · required

Response

200

application/json

Successful Response

display_name · string · required

id · string<uuid> · required

name · string · required

organisation_id · string<uuid> · required

scope · enum<string> · required

Available options: cluster, platform

status · enum<string> · required

Available options: running, stopping, success, cleanup, failed, critical, cancelled

type · string · required

capture_trigger · enum<string> | null

What asked for a cluster_state_snapshot execution's capture; null on every other execution.

Available options: stop, power_schedule, scheduled

cluster_id · string<uuid> | null

cluster_name · string | null

created_at · string<date-time> | null

error_excerpt · string | null

outcome · enum<string> | null

Available options: unknown, noop, mutated, failed, cancelled

step_summary · StepSummary · object

Show child attributes

updated_at · string<date-time> | null

upgrade · ExecutionUpgrade · object | null

The Kubernetes version change an upgrade run rolls out, recorded when the upgrade started it.

Show child attributes