Skip to main content
GET
/
v1
/
releases
/
{release_id}
get a release
curl --request GET \
  --url https://api.nuon.co/v1/releases/{release_id} \
  --header 'Authorization: <api-key>'
{
  "build_id": "<string>",
  "created_at": "<string>",
  "created_by_id": "<string>",
  "id": "<string>",
  "release_steps": [
    {
      "component_release_id": "<string>",
      "created_at": "<string>",
      "created_by_id": "<string>",
      "delay": "<string>",
      "id": "<string>",
      "install_deploys": [
        {
          "action_workflow_runs": [
            {
              "action_workflow_config_id": "<string>",
              "config": {
                "action_workflow_id": "<any>",
                "app_config_id": "<any>",
                "app_id": "<any>",
                "break_glass_role_arn": "<any>",
                "component_dependency_ids": "<any>",
                "created_at": "<any>",
                "created_by_id": "<any>",
                "id": "<any>",
                "references": "<any>",
                "refs": "<any>",
                "steps": "<any>",
                "timeout": "<any>",
                "triggers": "<any>",
                "updated_at": "<any>"
              },
              "created_at": "<string>",
              "created_by": {
                "account_type": "<any>",
                "created_at": "<any>",
                "email": "<any>",
                "id": "<any>",
                "org_ids": "<any>",
                "permissions": "<any>",
                "roles": "<any>",
                "subject": "<any>",
                "updated_at": "<any>",
                "user_journeys": "<any>"
              },
              "created_by_id": "<string>",
              "execution_time": 123,
              "id": "<string>",
              "install_action_workflow": {
                "action_workflow": {
                  "app_id": "<string>",
                  "config_count": 123,
                  "configs": [
                    {
                      "action_workflow_id": "<any>",
                      "app_config_id": "<any>",
                      "app_id": "<any>",
                      "break_glass_role_arn": "<any>",
                      "component_dependency_ids": "<any>",
                      "created_at": "<any>",
                      "created_by_id": "<any>",
                      "id": "<any>",
                      "references": "<any>",
                      "refs": "<any>",
                      "steps": "<any>",
                      "timeout": "<any>",
                      "triggers": "<any>",
                      "updated_at": "<any>"
                    }
                  ],
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "id": "<string>",
                  "name": "<string>",
                  "status": "<string>",
                  "status_description": "<string>",
                  "updated_at": "<string>"
                },
                "action_workflow_id": "<string>",
                "created_at": "<string>",
                "created_by_id": "<string>",
                "id": "<string>",
                "install_id": "<string>",
                "runs": [
                  {}
                ],
                "status": "<string>",
                "updated_at": "<string>"
              },
              "install_action_workflow_id": "<string>",
              "install_id": "<string>",
              "install_workflow_id": "<string>",
              "log_stream": {
                "attrs": "<any>",
                "created_at": "<any>",
                "created_by_id": "<any>",
                "id": "<any>",
                "open": "<any>",
                "org_id": "<any>",
                "owner_id": "<any>",
                "owner_type": "<any>",
                "runner_api_url": "<any>",
                "updated_at": "<any>",
                "write_token": "<any>"
              },
              "outputs": {},
              "run_env_vars": {},
              "runner_job": {
                "available_timeout": 123,
                "created_at": "<string>",
                "created_by_id": "<string>",
                "execution_count": 123,
                "execution_time": 123,
                "execution_timeout": 123,
                "executions": [
                  {}
                ],
                "final_runner_job_execution_id": "<string>",
                "finished_at": "<string>",
                "group": "health-checks",
                "id": "<string>",
                "log_stream_id": "<string>",
                "max_executions": 123,
                "metadata": {},
                "operation": "exec",
                "org_id": "<string>",
                "outputs": {},
                "outputs_json": "<string>",
                "overall_timeout": 123,
                "owner_id": "<string>",
                "owner_type": "<string>",
                "queue_timeout": 123,
                "runner_id": "<string>",
                "started_at": "<string>",
                "status": "queued",
                "status_description": "<string>",
                "type": "health-check",
                "updated_at": "<string>"
              },
              "status": "<string>",
              "status_description": "<string>",
              "status_v2": {
                "created_at_ts": "<any>",
                "created_by_id": "<any>",
                "history": "<any>",
                "metadata": "<any>",
                "status": "<any>",
                "status_human_description": "<any>"
              },
              "steps": [
                {
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "execution_duration": 123,
                  "id": "<string>",
                  "install_action_workflow_run_id": "<string>",
                  "status": "finished",
                  "step_id": "<string>",
                  "updated_at": "<string>"
                }
              ],
              "trigger_type": "manual",
              "triggered_by_id": "<string>",
              "triggered_by_type": "<string>",
              "updated_at": "<string>",
              "workflow": {
                "approval_option": "approve-all",
                "created_at": "<string>",
                "created_by": {
                  "account_type": "<any>",
                  "created_at": "<any>",
                  "email": "<any>",
                  "id": "<any>",
                  "org_ids": "<any>",
                  "permissions": "<any>",
                  "roles": "<any>",
                  "subject": "<any>",
                  "updated_at": "<any>",
                  "user_journeys": "<any>"
                },
                "created_by_id": "<string>",
                "execution_time": 123,
                "finished": true,
                "finished_at": "<string>",
                "id": "<string>",
                "install_action_workflow_runs": [
                  {}
                ],
                "install_deploys": [
                  {}
                ],
                "install_sandbox_runs": [
                  {
                    "action_workflow_runs": [
                      "<any>"
                    ],
                    "app_sandbox_config": {},
                    "created_at": "<string>",
                    "created_by": {},
                    "created_by_id": "<string>",
                    "id": "<string>",
                    "install_id": "<string>",
                    "install_sandbox_id": "<string>",
                    "install_workflow_id": "<string>",
                    "log_stream": {},
                    "outputs": {},
                    "run_type": "provision",
                    "runner_jobs": [
                      "<any>"
                    ],
                    "status": "<string>",
                    "status_description": "<string>",
                    "status_v2": {},
                    "updated_at": "<string>",
                    "workflow": {},
                    "workflow_id": "<string>"
                  }
                ],
                "links": {},
                "metadata": {},
                "name": "<string>",
                "owner_id": "<string>",
                "owner_type": "<string>",
                "plan_only": true,
                "started_at": "<string>",
                "status": {
                  "created_at_ts": "<any>",
                  "created_by_id": "<any>",
                  "history": "<any>",
                  "metadata": "<any>",
                  "status": "<any>",
                  "status_human_description": "<any>"
                },
                "step_error_behavior": "abort",
                "steps": [
                  {
                    "approval": {},
                    "created_at": "<string>",
                    "created_by": {},
                    "created_by_id": "<string>",
                    "execution_time": 123,
                    "execution_type": "system",
                    "finished": true,
                    "finished_at": "<string>",
                    "group_idx": 123,
                    "group_retry_idx": 123,
                    "id": "<string>",
                    "idx": 123,
                    "install_workflow_id": "<string>",
                    "links": {},
                    "metadata": {},
                    "name": "<string>",
                    "owner_id": "<string>",
                    "owner_type": "<string>",
                    "policy_validation": {},
                    "retried": true,
                    "retryable": true,
                    "skippable": true,
                    "started_at": "<string>",
                    "status": {},
                    "step_target_id": "<string>",
                    "step_target_type": "<string>",
                    "updated_at": "<string>",
                    "workflow_id": "<string>"
                  }
                ],
                "type": "provision",
                "updated_at": "<string>"
              },
              "workflow_id": "<string>"
            }
          ],
          "build_id": "<string>",
          "component_build": {
            "checksum": "<string>",
            "component_config_connection": {
              "app_config_id": "<string>",
              "app_config_version": 123,
              "checksum": "<string>",
              "component_dependency_ids": [
                "<string>"
              ],
              "component_id": "<string>",
              "component_name": "<string>",
              "created_at": "<string>",
              "created_by_id": "<string>",
              "docker_build": {
                "build_args": [
                  "<string>"
                ],
                "component_config_connection_id": "<string>",
                "connected_github_vcs_config": {
                  "branch": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "directory": "<string>",
                  "id": "<string>",
                  "repo": "<string>",
                  "repo_name": "<string>",
                  "repo_owner": "<string>",
                  "updated_at": "<string>",
                  "vcs_connection": {},
                  "vcs_connection_id": "<string>"
                },
                "created_at": "<string>",
                "created_by_id": "<string>",
                "dockerfile": "<string>",
                "env_vars": {},
                "id": "<string>",
                "public_git_vcs_config": {
                  "branch": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "directory": "<string>",
                  "id": "<string>",
                  "repo": "<string>",
                  "updated_at": "<string>"
                },
                "target": "<string>",
                "updated_at": "<string>"
              },
              "drift_schedule": "<string>",
              "external_image": {
                "aws_ecr_image_config": {
                  "aws_region": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "iam_role_arn": "<string>",
                  "id": "<string>",
                  "updated_at": "<string>"
                },
                "component_config_connection_id": "<string>",
                "created_at": "<string>",
                "created_by_id": "<string>",
                "id": "<string>",
                "image_url": "<string>",
                "tag": "<string>",
                "updated_at": "<string>"
              },
              "helm": {
                "chart_name": "<string>",
                "component_config_connection_id": "<string>",
                "connected_github_vcs_config": {
                  "branch": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "directory": "<string>",
                  "id": "<string>",
                  "repo": "<string>",
                  "repo_name": "<string>",
                  "repo_owner": "<string>",
                  "updated_at": "<string>",
                  "vcs_connection": {},
                  "vcs_connection_id": "<string>"
                },
                "created_at": "<string>",
                "created_by_id": "<string>",
                "helm_config_json": {
                  "chart_name": "<string>",
                  "namespace": "<string>",
                  "storage_driver": "<string>",
                  "take_ownership": true,
                  "values": {},
                  "values_files": [
                    "<string>"
                  ]
                },
                "id": "<string>",
                "namespace": "<string>",
                "public_git_vcs_config": {
                  "branch": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "directory": "<string>",
                  "id": "<string>",
                  "repo": "<string>",
                  "updated_at": "<string>"
                },
                "storage_driver": "<string>",
                "take_ownership": true,
                "updated_at": "<string>",
                "values": {},
                "values_files": [
                  "<string>"
                ]
              },
              "id": "<string>",
              "job": {
                "args": [
                  "<string>"
                ],
                "cmd": [
                  "<string>"
                ],
                "component_config_connection_id": "<string>",
                "created_at": "<string>",
                "created_by_id": "<string>",
                "env_vars": {},
                "id": "<string>",
                "image_url": "<string>",
                "tag": "<string>",
                "updated_at": "<string>"
              },
              "kubernetes_manifest": {
                "component_config_connection_id": "<string>",
                "created_at": "<string>",
                "created_by_id": "<string>",
                "id": "<string>",
                "manifest": "<string>",
                "namespace": "<string>",
                "updated_at": "<string>"
              },
              "references": [
                "<string>"
              ],
              "refs": [
                {
                  "input": "<string>",
                  "name": "<string>",
                  "type": "sandbox",
                  "value": "<string>"
                }
              ],
              "terraform_module": {
                "component_config_connection_id": "<string>",
                "connected_github_vcs_config": {
                  "branch": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "directory": "<string>",
                  "id": "<string>",
                  "repo": "<string>",
                  "repo_name": "<string>",
                  "repo_owner": "<string>",
                  "updated_at": "<string>",
                  "vcs_connection": {},
                  "vcs_connection_id": "<string>"
                },
                "created_at": "<string>",
                "created_by_id": "<string>",
                "env_vars": {},
                "id": "<string>",
                "public_git_vcs_config": {
                  "branch": "<string>",
                  "component_config_id": "<string>",
                  "component_config_type": "<string>",
                  "created_at": "<string>",
                  "created_by_id": "<string>",
                  "directory": "<string>",
                  "id": "<string>",
                  "repo": "<string>",
                  "updated_at": "<string>"
                },
                "updated_at": "<string>",
                "variables": {},
                "variables_files": [
                  "<string>"
                ],
                "version": "<string>"
              },
              "type": "terraform_module",
              "updated_at": "<string>",
              "version": 123
            },
            "component_config_connection_id": "<string>",
            "component_config_version": 123,
            "component_id": "<string>",
            "component_name": "<string>",
            "created_at": "<string>",
            "created_by": {
              "account_type": "<any>",
              "created_at": "<any>",
              "email": "<any>",
              "id": "<any>",
              "org_ids": "<any>",
              "permissions": "<any>",
              "roles": "<any>",
              "subject": "<any>",
              "updated_at": "<any>",
              "user_journeys": "<any>"
            },
            "created_by_id": "<string>",
            "git_ref": "<string>",
            "id": "<string>",
            "install_deploys": [
              {}
            ],
            "log_stream": {
              "attrs": "<any>",
              "created_at": "<any>",
              "created_by_id": "<any>",
              "id": "<any>",
              "open": "<any>",
              "org_id": "<any>",
              "owner_id": "<any>",
              "owner_type": "<any>",
              "runner_api_url": "<any>",
              "updated_at": "<any>",
              "write_token": "<any>"
            },
            "releases": [
              {}
            ],
            "runner_job": {
              "available_timeout": 123,
              "created_at": "<string>",
              "created_by_id": "<string>",
              "execution_count": 123,
              "execution_time": 123,
              "execution_timeout": 123,
              "executions": [
                {}
              ],
              "final_runner_job_execution_id": "<string>",
              "finished_at": "<string>",
              "group": "health-checks",
              "id": "<string>",
              "log_stream_id": "<string>",
              "max_executions": 123,
              "metadata": {},
              "operation": "exec",
              "org_id": "<string>",
              "outputs": {},
              "outputs_json": "<string>",
              "overall_timeout": 123,
              "owner_id": "<string>",
              "owner_type": "<string>",
              "queue_timeout": 123,
              "runner_id": "<string>",
              "started_at": "<string>",
              "status": "queued",
              "status_description": "<string>",
              "type": "health-check",
              "updated_at": "<string>"
            },
            "status": "<string>",
            "status_description": "<string>",
            "status_v2": {
              "created_at_ts": "<any>",
              "created_by_id": "<any>",
              "history": "<any>",
              "metadata": "<any>",
              "status": "<any>",
              "status_human_description": "<any>"
            },
            "updated_at": "<string>",
            "vcs_connection_commit": {
              "author_email": "<string>",
              "author_name": "<string>",
              "created_at": "<string>",
              "created_by_id": "<string>",
              "id": "<string>",
              "message": "<string>",
              "sha": "<string>",
              "updated_at": "<string>",
              "vcs_connection_id": "<string>"
            }
          },
          "component_config_version": 123,
          "component_id": "<string>",
          "component_name": "<string>",
          "created_at": "<string>",
          "created_by": {
            "account_type": "<any>",
            "created_at": "<any>",
            "email": "<any>",
            "id": "<any>",
            "org_ids": "<any>",
            "permissions": "<any>",
            "roles": "<any>",
            "subject": "<any>",
            "updated_at": "<any>",
            "user_journeys": "<any>"
          },
          "created_by_id": "<string>",
          "id": "<string>",
          "install_component_id": "<string>",
          "install_deploy_type": "sync-image",
          "install_id": "<string>",
          "install_workflow_id": "<string>",
          "log_stream": {
            "attrs": "<any>",
            "created_at": "<any>",
            "created_by_id": "<any>",
            "id": "<any>",
            "open": "<any>",
            "org_id": "<any>",
            "owner_id": "<any>",
            "owner_type": "<any>",
            "runner_api_url": "<any>",
            "updated_at": "<any>",
            "write_token": "<any>"
          },
          "oci_artifact": {
            "annotations": {},
            "architecture": "<string>",
            "artifact_type": "<string>",
            "created_at": "<string>",
            "created_by_id": "<string>",
            "digest": "<string>",
            "id": "<string>",
            "media_type": "<string>",
            "org_id": "<string>",
            "os": "<string>",
            "os_features": [
              "<string>"
            ],
            "os_version": "<string>",
            "owner_id": "<string>",
            "owner_type": "<string>",
            "repository": "<string>",
            "size": 123,
            "tag": "<string>",
            "updated_at": "<string>",
            "urls": [
              "<string>"
            ],
            "variant": "<string>"
          },
          "outputs": {},
          "plan_only": true,
          "release_id": "<string>",
          "runner_jobs": [
            {
              "available_timeout": 123,
              "created_at": "<string>",
              "created_by_id": "<string>",
              "execution_count": 123,
              "execution_time": 123,
              "execution_timeout": 123,
              "executions": [
                {}
              ],
              "final_runner_job_execution_id": "<string>",
              "finished_at": "<string>",
              "group": "health-checks",
              "id": "<string>",
              "log_stream_id": "<string>",
              "max_executions": 123,
              "metadata": {},
              "operation": "exec",
              "org_id": "<string>",
              "outputs": {},
              "outputs_json": "<string>",
              "overall_timeout": 123,
              "owner_id": "<string>",
              "owner_type": "<string>",
              "queue_timeout": 123,
              "runner_id": "<string>",
              "started_at": "<string>",
              "status": "queued",
              "status_description": "<string>",
              "type": "health-check",
              "updated_at": "<string>"
            }
          ],
          "status": "<string>",
          "status_description": "<string>",
          "status_v2": {
            "created_at_ts": "<any>",
            "created_by_id": "<any>",
            "history": "<any>",
            "metadata": "<any>",
            "status": "<any>",
            "status_human_description": "<any>"
          },
          "updated_at": "<string>",
          "workflow": {
            "approval_option": "approve-all",
            "created_at": "<string>",
            "created_by": {
              "account_type": "<any>",
              "created_at": "<any>",
              "email": "<any>",
              "id": "<any>",
              "org_ids": "<any>",
              "permissions": "<any>",
              "roles": "<any>",
              "subject": "<any>",
              "updated_at": "<any>",
              "user_journeys": "<any>"
            },
            "created_by_id": "<string>",
            "execution_time": 123,
            "finished": true,
            "finished_at": "<string>",
            "id": "<string>",
            "install_action_workflow_runs": [
              {}
            ],
            "install_deploys": [
              {}
            ],
            "install_sandbox_runs": [
              {
                "action_workflow_runs": [
                  "<any>"
                ],
                "app_sandbox_config": {},
                "created_at": "<string>",
                "created_by": {},
                "created_by_id": "<string>",
                "id": "<string>",
                "install_id": "<string>",
                "install_sandbox_id": "<string>",
                "install_workflow_id": "<string>",
                "log_stream": {},
                "outputs": {},
                "run_type": "provision",
                "runner_jobs": [
                  "<any>"
                ],
                "status": "<string>",
                "status_description": "<string>",
                "status_v2": {},
                "updated_at": "<string>",
                "workflow": {},
                "workflow_id": "<string>"
              }
            ],
            "links": {},
            "metadata": {},
            "name": "<string>",
            "owner_id": "<string>",
            "owner_type": "<string>",
            "plan_only": true,
            "started_at": "<string>",
            "status": {
              "created_at_ts": "<any>",
              "created_by_id": "<any>",
              "history": "<any>",
              "metadata": "<any>",
              "status": "<any>",
              "status_human_description": "<any>"
            },
            "step_error_behavior": "abort",
            "steps": [
              {
                "approval": {},
                "created_at": "<string>",
                "created_by": {},
                "created_by_id": "<string>",
                "execution_time": 123,
                "execution_type": "system",
                "finished": true,
                "finished_at": "<string>",
                "group_idx": 123,
                "group_retry_idx": 123,
                "id": "<string>",
                "idx": 123,
                "install_workflow_id": "<string>",
                "links": {},
                "metadata": {},
                "name": "<string>",
                "owner_id": "<string>",
                "owner_type": "<string>",
                "policy_validation": {},
                "retried": true,
                "retryable": true,
                "skippable": true,
                "started_at": "<string>",
                "status": {},
                "step_target_id": "<string>",
                "step_target_type": "<string>",
                "updated_at": "<string>",
                "workflow_id": "<string>"
              }
            ],
            "type": "provision",
            "updated_at": "<string>"
          },
          "workflow_id": "<string>"
        }
      ],
      "requested_install_ids": [
        "<string>"
      ],
      "status": "<string>",
      "status_description": "<string>",
      "updated_at": "<string>"
    }
  ],
  "status": "<string>",
  "status_description": "<string>",
  "total_release_steps": 123,
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and token.

Path Parameters

release_id
string
required

release ID

Response

OK

build_id
string
created_at
string
created_by_id
string
id
string
release_steps
object[]
status
string
status_description
string
total_release_steps
integer
updated_at
string