Get a deployment

import requests

url = "https://platform.ankra.app/api/v1/org/deployments/{deployment_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/deployments/{deployment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment": "<string>",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repository": "<string>",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_attempt": 2,
  "release_name": "<string>",
  "artifact_repository": "<string>",
  "artifact_digest": "<string>",
  "artifact_tag": "<string>",
  "signature_key_id": "<string>",
  "commit_sha": "<string>",
  "state": "pending",
  "target_count": 1,
  "succeeded_count": 1,
  "failed_count": 1,
  "error_class": "<string>",
  "error_message": "<string>",
  "requested_by": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "targets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "host_target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "host_target_name": "<string>",
      "status": "pending",
      "attempt": 2,
      "timeout_seconds": 2,
      "claimed_at": "2023-11-07T05:31:56Z",
      "heartbeat_at": "2023-11-07T05:31:56Z",
      "times_out_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "previous_digest": "<string>",
      "running_digest": "<string>",
      "result": {},
      "error_class": "<string>",
      "error_message": "<string>",
      "log_artifact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "targets_truncated": true
}

GET

api

org

deployments

{deployment_id}

Get a deployment

import requests

url = "https://platform.ankra.app/api/v1/org/deployments/{deployment_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/deployments/{deployment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment": "<string>",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repository": "<string>",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_attempt": 2,
  "release_name": "<string>",
  "artifact_repository": "<string>",
  "artifact_digest": "<string>",
  "artifact_tag": "<string>",
  "signature_key_id": "<string>",
  "commit_sha": "<string>",
  "state": "pending",
  "target_count": 1,
  "succeeded_count": 1,
  "failed_count": 1,
  "error_class": "<string>",
  "error_message": "<string>",
  "requested_by": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "targets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "host_target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "host_target_name": "<string>",
      "status": "pending",
      "attempt": 2,
      "timeout_seconds": 2,
      "claimed_at": "2023-11-07T05:31:56Z",
      "heartbeat_at": "2023-11-07T05:31:56Z",
      "times_out_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "previous_digest": "<string>",
      "running_digest": "<string>",
      "result": {},
      "error_class": "<string>",
      "error_message": "<string>",
      "log_artifact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "targets_truncated": true
}

Authorizations

Authorization

string

header

required

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

Path Parameters

deployment_id

string<uuid>

required

Response

The deployment and its targets.

One release of a published artefact digest to the host targets of an environment.

string<uuid>

required

environment

string

required

The name of the environment the release was deployed to.

Pattern: ^[a-z0-9][a-z0-9-]{0,62}$

environment_id

string<uuid>

required

repository_id

string<uuid> | null

required

repository

string | null

required

The pipeline repository as owner/name; null when it is no longer connected.

pipeline_run_id

string<uuid> | null

required

pipeline_step_id

string<uuid> | null

required

step_attempt

integer

required

Required range: x >= 1

release_name

string

required

artifact_repository

string

required

artifact_digest

string

required

Pattern: ^sha256:[a-f0-9]{64}$

artifact_tag

string | null

required

signature_key_id

string | null

required

commit_sha

string | null

required

state

enum<string>

required

Available options:

pending,

running,

succeeded,

failed,

cancelled,

timed_out

target_count

integer

required

Required range: x >= 0

succeeded_count

integer

required

Required range: x >= 0

failed_count

integer

required

Required range: x >= 0

error_class

string | null

required

error_message

string | null

required

requested_by

string | null

required

started_at

string<date-time> | null

required

finished_at

string<date-time> | null

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

targets

object[]

required

Show child attributes

targets_truncated

boolean

required

True when targets stopped at its 1000-row cap; target_count still carries the total.

API reference

Endpoints

Get a deployment

Authorizations

Path Parameters

Response