Authorizations
Type "Bearer" followed by a space and token.
Path Parameters
component ID
Body
application/json
Input
The body is of type object
.
Response
Created
The response is of type object
.
curl --request POST \
--url https://api.nuon.co/v1/components/{component_id}/builds \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"git_ref": "<string>",
"use_latest": true
}'
{
"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": "auth0",
"created_at": "<string>",
"email": "<string>",
"id": "<string>",
"org_ids": [
"<any>"
],
"permissions": {},
"roles": [
"<any>"
],
"subject": "<string>",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"git_ref": "<string>",
"id": "<string>",
"install_deploys": [
{
"action_workflow_runs": [
{
"action_workflow_config_id": "<any>",
"config": "<any>",
"created_at": "<any>",
"created_by": "<any>",
"created_by_id": "<any>",
"execution_time": "<any>",
"id": "<any>",
"install_action_workflow": "<any>",
"install_action_workflow_id": "<any>",
"install_id": "<any>",
"install_workflow_id": "<any>",
"log_stream": "<any>",
"outputs": "<any>",
"run_env_vars": "<any>",
"runner_job": "<any>",
"status": "<any>",
"status_description": "<any>",
"status_v2": "<any>",
"steps": "<any>",
"trigger_type": "<any>",
"triggered_by_id": "<any>",
"triggered_by_type": "<any>",
"updated_at": "<any>",
"workflow": "<any>",
"workflow_id": "<any>"
}
],
"build_id": "<string>",
"component_build": {},
"component_config_version": 123,
"component_id": "<string>",
"component_name": "<string>",
"created_at": "<string>",
"created_by": {
"account_type": "auth0",
"created_at": "<string>",
"email": "<string>",
"id": "<string>",
"org_ids": [
"<any>"
],
"permissions": {},
"roles": [
"<any>"
],
"subject": "<string>",
"updated_at": "<string>"
},
"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": {},
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"open": true,
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"runner_api_url": "<string>",
"updated_at": "<string>",
"write_token": "<string>"
},
"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": [
"<any>"
],
"os_version": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"repository": "<string>",
"size": 123,
"tag": "<string>",
"updated_at": "<string>",
"urls": [
"<any>"
],
"variant": "<string>"
},
"outputs": {},
"plan_only": true,
"release_id": "<string>",
"runner_jobs": [
{
"available_timeout": "<any>",
"created_at": "<any>",
"created_by_id": "<any>",
"execution_count": "<any>",
"execution_time": "<any>",
"execution_timeout": "<any>",
"executions": "<any>",
"final_runner_job_execution_id": "<any>",
"finished_at": "<any>",
"group": "<any>",
"id": "<any>",
"log_stream_id": "<any>",
"max_executions": "<any>",
"metadata": "<any>",
"operation": "<any>",
"org_id": "<any>",
"outputs": "<any>",
"outputs_json": "<any>",
"overall_timeout": "<any>",
"owner_id": "<any>",
"owner_type": "<any>",
"queue_timeout": "<any>",
"runner_id": "<any>",
"started_at": "<any>",
"status": "<any>",
"status_description": "<any>",
"type": "<any>",
"updated_at": "<any>"
}
],
"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>"
},
"created_by_id": "<string>",
"execution_time": 123,
"finished": true,
"finished_at": "<string>",
"id": "<string>",
"install_action_workflow_runs": [
"<any>"
],
"install_deploys": [
"<any>"
],
"install_sandbox_runs": [
"<any>"
],
"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": [
"<any>"
],
"type": "provision",
"updated_at": "<string>"
},
"workflow_id": "<string>"
}
],
"log_stream": {
"attrs": {},
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"open": true,
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"runner_api_url": "<string>",
"updated_at": "<string>",
"write_token": "<string>"
},
"releases": [
{
"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": "<any>",
"config": "<any>",
"created_at": "<any>",
"created_by": "<any>",
"created_by_id": "<any>",
"execution_time": "<any>",
"id": "<any>",
"install_action_workflow": "<any>",
"install_action_workflow_id": "<any>",
"install_id": "<any>",
"install_workflow_id": "<any>",
"log_stream": "<any>",
"outputs": "<any>",
"run_env_vars": "<any>",
"runner_job": "<any>",
"status": "<any>",
"status_description": "<any>",
"status_v2": "<any>",
"steps": "<any>",
"trigger_type": "<any>",
"triggered_by_id": "<any>",
"triggered_by_type": "<any>",
"updated_at": "<any>",
"workflow": "<any>",
"workflow_id": "<any>"
}
],
"build_id": "<string>",
"component_build": {},
"component_config_version": 123,
"component_id": "<string>",
"component_name": "<string>",
"created_at": "<string>",
"created_by": {
"account_type": "auth0",
"created_at": "<string>",
"email": "<string>",
"id": "<string>",
"org_ids": [
"<any>"
],
"permissions": {},
"roles": [
"<any>"
],
"subject": "<string>",
"updated_at": "<string>"
},
"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": {},
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"open": true,
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"runner_api_url": "<string>",
"updated_at": "<string>",
"write_token": "<string>"
},
"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": [
"<any>"
],
"os_version": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"repository": "<string>",
"size": 123,
"tag": "<string>",
"updated_at": "<string>",
"urls": [
"<any>"
],
"variant": "<string>"
},
"outputs": {},
"plan_only": true,
"release_id": "<string>",
"runner_jobs": [
{
"available_timeout": "<any>",
"created_at": "<any>",
"created_by_id": "<any>",
"execution_count": "<any>",
"execution_time": "<any>",
"execution_timeout": "<any>",
"executions": "<any>",
"final_runner_job_execution_id": "<any>",
"finished_at": "<any>",
"group": "<any>",
"id": "<any>",
"log_stream_id": "<any>",
"max_executions": "<any>",
"metadata": "<any>",
"operation": "<any>",
"org_id": "<any>",
"outputs": "<any>",
"outputs_json": "<any>",
"overall_timeout": "<any>",
"owner_id": "<any>",
"owner_type": "<any>",
"queue_timeout": "<any>",
"runner_id": "<any>",
"started_at": "<any>",
"status": "<any>",
"status_description": "<any>",
"type": "<any>",
"updated_at": "<any>"
}
],
"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>"
},
"created_by_id": "<string>",
"execution_time": 123,
"finished": true,
"finished_at": "<string>",
"id": "<string>",
"install_action_workflow_runs": [
"<any>"
],
"install_deploys": [
"<any>"
],
"install_sandbox_runs": [
"<any>"
],
"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": [
"<any>"
],
"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>"
}
],
"runner_job": {
"available_timeout": "<any>",
"created_at": "<any>",
"created_by_id": "<any>",
"execution_count": "<any>",
"execution_time": "<any>",
"execution_timeout": "<any>",
"executions": "<any>",
"final_runner_job_execution_id": "<any>",
"finished_at": "<any>",
"group": "<any>",
"id": "<any>",
"log_stream_id": "<any>",
"max_executions": "<any>",
"metadata": "<any>",
"operation": "<any>",
"org_id": "<any>",
"outputs": "<any>",
"outputs_json": "<any>",
"overall_timeout": "<any>",
"owner_id": "<any>",
"owner_type": "<any>",
"queue_timeout": "<any>",
"runner_id": "<any>",
"started_at": "<any>",
"status": "<any>",
"status_description": "<any>",
"type": "<any>",
"updated_at": "<any>"
},
"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>"
}
}
curl --request POST \
--url https://api.nuon.co/v1/components/{component_id}/builds \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"git_ref": "<string>",
"use_latest": true
}'
{
"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": "auth0",
"created_at": "<string>",
"email": "<string>",
"id": "<string>",
"org_ids": [
"<any>"
],
"permissions": {},
"roles": [
"<any>"
],
"subject": "<string>",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"git_ref": "<string>",
"id": "<string>",
"install_deploys": [
{
"action_workflow_runs": [
{
"action_workflow_config_id": "<any>",
"config": "<any>",
"created_at": "<any>",
"created_by": "<any>",
"created_by_id": "<any>",
"execution_time": "<any>",
"id": "<any>",
"install_action_workflow": "<any>",
"install_action_workflow_id": "<any>",
"install_id": "<any>",
"install_workflow_id": "<any>",
"log_stream": "<any>",
"outputs": "<any>",
"run_env_vars": "<any>",
"runner_job": "<any>",
"status": "<any>",
"status_description": "<any>",
"status_v2": "<any>",
"steps": "<any>",
"trigger_type": "<any>",
"triggered_by_id": "<any>",
"triggered_by_type": "<any>",
"updated_at": "<any>",
"workflow": "<any>",
"workflow_id": "<any>"
}
],
"build_id": "<string>",
"component_build": {},
"component_config_version": 123,
"component_id": "<string>",
"component_name": "<string>",
"created_at": "<string>",
"created_by": {
"account_type": "auth0",
"created_at": "<string>",
"email": "<string>",
"id": "<string>",
"org_ids": [
"<any>"
],
"permissions": {},
"roles": [
"<any>"
],
"subject": "<string>",
"updated_at": "<string>"
},
"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": {},
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"open": true,
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"runner_api_url": "<string>",
"updated_at": "<string>",
"write_token": "<string>"
},
"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": [
"<any>"
],
"os_version": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"repository": "<string>",
"size": 123,
"tag": "<string>",
"updated_at": "<string>",
"urls": [
"<any>"
],
"variant": "<string>"
},
"outputs": {},
"plan_only": true,
"release_id": "<string>",
"runner_jobs": [
{
"available_timeout": "<any>",
"created_at": "<any>",
"created_by_id": "<any>",
"execution_count": "<any>",
"execution_time": "<any>",
"execution_timeout": "<any>",
"executions": "<any>",
"final_runner_job_execution_id": "<any>",
"finished_at": "<any>",
"group": "<any>",
"id": "<any>",
"log_stream_id": "<any>",
"max_executions": "<any>",
"metadata": "<any>",
"operation": "<any>",
"org_id": "<any>",
"outputs": "<any>",
"outputs_json": "<any>",
"overall_timeout": "<any>",
"owner_id": "<any>",
"owner_type": "<any>",
"queue_timeout": "<any>",
"runner_id": "<any>",
"started_at": "<any>",
"status": "<any>",
"status_description": "<any>",
"type": "<any>",
"updated_at": "<any>"
}
],
"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>"
},
"created_by_id": "<string>",
"execution_time": 123,
"finished": true,
"finished_at": "<string>",
"id": "<string>",
"install_action_workflow_runs": [
"<any>"
],
"install_deploys": [
"<any>"
],
"install_sandbox_runs": [
"<any>"
],
"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": [
"<any>"
],
"type": "provision",
"updated_at": "<string>"
},
"workflow_id": "<string>"
}
],
"log_stream": {
"attrs": {},
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"open": true,
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"runner_api_url": "<string>",
"updated_at": "<string>",
"write_token": "<string>"
},
"releases": [
{
"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": "<any>",
"config": "<any>",
"created_at": "<any>",
"created_by": "<any>",
"created_by_id": "<any>",
"execution_time": "<any>",
"id": "<any>",
"install_action_workflow": "<any>",
"install_action_workflow_id": "<any>",
"install_id": "<any>",
"install_workflow_id": "<any>",
"log_stream": "<any>",
"outputs": "<any>",
"run_env_vars": "<any>",
"runner_job": "<any>",
"status": "<any>",
"status_description": "<any>",
"status_v2": "<any>",
"steps": "<any>",
"trigger_type": "<any>",
"triggered_by_id": "<any>",
"triggered_by_type": "<any>",
"updated_at": "<any>",
"workflow": "<any>",
"workflow_id": "<any>"
}
],
"build_id": "<string>",
"component_build": {},
"component_config_version": 123,
"component_id": "<string>",
"component_name": "<string>",
"created_at": "<string>",
"created_by": {
"account_type": "auth0",
"created_at": "<string>",
"email": "<string>",
"id": "<string>",
"org_ids": [
"<any>"
],
"permissions": {},
"roles": [
"<any>"
],
"subject": "<string>",
"updated_at": "<string>"
},
"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": {},
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"open": true,
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"runner_api_url": "<string>",
"updated_at": "<string>",
"write_token": "<string>"
},
"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": [
"<any>"
],
"os_version": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"repository": "<string>",
"size": 123,
"tag": "<string>",
"updated_at": "<string>",
"urls": [
"<any>"
],
"variant": "<string>"
},
"outputs": {},
"plan_only": true,
"release_id": "<string>",
"runner_jobs": [
{
"available_timeout": "<any>",
"created_at": "<any>",
"created_by_id": "<any>",
"execution_count": "<any>",
"execution_time": "<any>",
"execution_timeout": "<any>",
"executions": "<any>",
"final_runner_job_execution_id": "<any>",
"finished_at": "<any>",
"group": "<any>",
"id": "<any>",
"log_stream_id": "<any>",
"max_executions": "<any>",
"metadata": "<any>",
"operation": "<any>",
"org_id": "<any>",
"outputs": "<any>",
"outputs_json": "<any>",
"overall_timeout": "<any>",
"owner_id": "<any>",
"owner_type": "<any>",
"queue_timeout": "<any>",
"runner_id": "<any>",
"started_at": "<any>",
"status": "<any>",
"status_description": "<any>",
"type": "<any>",
"updated_at": "<any>"
}
],
"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>"
},
"created_by_id": "<string>",
"execution_time": 123,
"finished": true,
"finished_at": "<string>",
"id": "<string>",
"install_action_workflow_runs": [
"<any>"
],
"install_deploys": [
"<any>"
],
"install_sandbox_runs": [
"<any>"
],
"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": [
"<any>"
],
"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>"
}
],
"runner_job": {
"available_timeout": "<any>",
"created_at": "<any>",
"created_by_id": "<any>",
"execution_count": "<any>",
"execution_time": "<any>",
"execution_timeout": "<any>",
"executions": "<any>",
"final_runner_job_execution_id": "<any>",
"finished_at": "<any>",
"group": "<any>",
"id": "<any>",
"log_stream_id": "<any>",
"max_executions": "<any>",
"metadata": "<any>",
"operation": "<any>",
"org_id": "<any>",
"outputs": "<any>",
"outputs_json": "<any>",
"overall_timeout": "<any>",
"owner_id": "<any>",
"owner_type": "<any>",
"queue_timeout": "<any>",
"runner_id": "<any>",
"started_at": "<any>",
"status": "<any>",
"status_description": "<any>",
"type": "<any>",
"updated_at": "<any>"
},
"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>"
}
}
Type "Bearer" followed by a space and token.
component ID
Input
The body is of type object
.
Created
The response is of type object
.