Read one application deployment restore point with its receipt

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id}"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://platform.ankra.app/api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "backup_vault_id": "<string>",
  "scope_kind": "<string>",
  "stack_names": [
    "<string>"
  ],
  "trigger": "<string>",
  "status": "<string>",
  "total_bytes": 123,
  "total_bytes_known": true,
  "verification_status": "unverified",
  "created_at": "2023-11-07T05:31:56Z",
  "asset_count": 123,
  "verified_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "assets": [
    {
      "id": "<string>",
      "kind": "<string>",
      "name": "<string>",
      "size_bytes": 123,
      "size_bytes_known": true,
      "artifacts": [
        {
          "kind": "<string>",
          "format": "<string>",
          "size_bytes": 123,
          "sha256": "<string>",
          "database": "<string>"
        }
      ]
    }
  ],
  "manifest": {},
  "run": {}
}

Backups

Read one application deployment restore point with its receipt

Reads one restore point of one application deployment with its manifest: assets with their measured sizes and per-artifact size and SHA-256 checksums, coverage, what was not carried, and the run that produced it. The stack is resolved from the application’s own installation rows; a restore point captured from another stack or cluster is not found here. Requires the backups rollout flag and backups.read. Object keys are never returned. A completed capture is not a verified restore: verification_status is written only by an automated restore verification.

GET

/

api

/

v1

/

org

/

applications

/

{application_id}

/

deployments

/

{deployment_id}

/

restore-points

/

{restore_point_id}

Read one application deployment restore point with its receipt

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id}"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://platform.ankra.app/api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "backup_vault_id": "<string>",
  "scope_kind": "<string>",
  "stack_names": [
    "<string>"
  ],
  "trigger": "<string>",
  "status": "<string>",
  "total_bytes": 123,
  "total_bytes_known": true,
  "verification_status": "unverified",
  "created_at": "2023-11-07T05:31:56Z",
  "asset_count": 123,
  "verified_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "assets": [
    {
      "id": "<string>",
      "kind": "<string>",
      "name": "<string>",
      "size_bytes": 123,
      "size_bytes_known": true,
      "artifacts": [
        {
          "kind": "<string>",
          "format": "<string>",
          "size_bytes": 123,
          "sha256": "<string>",
          "database": "<string>"
        }
      ]
    }
  ],
  "manifest": {},
  "run": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

application_id

string

required

deployment_id

string<uuid>

required

The deployment cluster id.

restore_point_id

string<uuid>

required

Response

The restore point with its manifest.

A restore point with its manifest. Each manifest asset may carry artifacts, the uploaded files with size_bytes and sha256 as verified at capture; object keys are withheld.

id

string<uuid>

required

organisation_id

string<uuid>

required

backup_vault_id

string

required

scope_kind

string

required

stack_names

string[]

required

trigger

string

required

status

string

required

total_bytes

integer<int64>

required

total_bytes_known

boolean

required

verification_status

enum<string>

required

Available options:

unverified,

passed,

failed

created_at

string<date-time>

required

asset_count

integer

required

verified_at

string<date-time> | null

completed_at

string<date-time> | null

assets

object[]

Show child attributes

manifest

object | null

run

object | null