Get Application Api Endpoint

GET /api/v1/org/applications/{application_id}

Get Application Api Endpoint

Python

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}"

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

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

print(response.text)

200

{
  "app_repo_branch": "<string>",
  "app_repo_name": "<string>",
  "app_repo_owner": "<string>",
  "created_at": "<string>",
  "deployment_state": "<string>",
  "deployment_state_message": "<string>",
  "id": "<string>",
  "name": "<string>",
  "state": "<string>",
  "updated_at": "<string>",
  "analysis_status": "<string>",
  "app_repo_url": "<string>",
  "chart_oci_url": "<string>",
  "chart_version_count": 123,
  "clusters_behind": 123,
  "clusters_up_to_date": 123,
  "components": [
    {
      "app_subdir": "<string>",
      "container_port": 123,
      "image_repository": "<string>",
      "is_primary": true,
      "name": "<string>",
      "registry_credential_name": "<string>",
      "registry_declared": true,
      "workflow_path": "<string>"
    }
  ],
  "container_image_url": "<string>",
  "creation_progress": [
    {
      "key": "<string>",
      "status": "<string>",
      "message": "<string>"
    }
  ],
  "cve_summary": {},
  "deployment_count": 123,
  "detected_framework": "<string>",
  "detected_language": "<string>",
  "error_message": "<string>",
  "file_dispositions": [
    {
      "disposition": "<string>",
      "path": "<string>"
    }
  ],
  "generated_files": [
    {
      "content": "<string>",
      "path": "<string>"
    }
  ],
  "healthy_deployment_count": 123,
  "helm_repo_add_command": "<string>",
  "latest_chart_version": "<string>",
  "latest_delivery_status": "<string>",
  "latest_workflow_at": "<string>",
  "latest_workflow_conclusion": "<string>",
  "latest_workflow_status": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "default": "<string>",
      "description": "<string>",
      "required": false,
      "type": "string"
    }
  ],
  "publish_readiness": {},
  "pull_request_merged_at": "<string>",
  "pull_request_url": "<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

application_id · string · required

Response

200

application/json

Successful Response

app_repo_branch · string · required

app_repo_name · string · required

app_repo_owner · string · required

created_at · string · required

deployment_state · string · required

Whether the application is running: running, degraded, failed, deploying, not_deployed or unknown. Distinct from state, which is the application record's own lifecycle.

deployment_state_message · string | null · required

Why deployment_state is what it is, when there is something to say: the re-checked failure reason, or what could not be established. Null when the state needs no explanation.

id · string · required

name · string · required

state · string · required

updated_at · string · required

analysis_status · string | null

app_repo_url · string | null

chart_oci_url · string | null

chart_version_count · integer | null

clusters_behind · integer | null

clusters_up_to_date · integer | null

components · ApplicationComponent · object[] | null

Show child attributes

container_image_url · string | null

creation_progress · CreationProgressStepResponse · object[] | null

Show child attributes

cve_summary · Cve Summary · object | null

Show child attributes

deployment_count · integer | null

detected_framework · string | null

detected_language · string | null

error_message · string | null

file_dispositions · FileDispositionItem · object[] | null

Show child attributes

generated_files · GeneratedFileItem · object[] | null

Show child attributes

healthy_deployment_count · integer | null

helm_repo_add_command · string | null

latest_chart_version · string | null

latest_delivery_status · string | null

latest_workflow_at · string | null

latest_workflow_conclusion · string | null

latest_workflow_status · string | null

parameters · ApplicationParameterItem · object[] | null

Show child attributes

publish_readiness · Publish Readiness · object | null

pull_request_merged_at · string | null

pull_request_url · string | null