installs
deploy a build to an install
API Reference
apps
components
- GETget all components for an app
- GETget all components for an org
- GETget a component
- PATCHupdate a component
- GETGet all builds for a component
- POSTcreate component build
- GETget latest build for a component
- GETget a build for a component
- GETGet component build plan
- GETget all configs for a component
- POSTcreate a docker build component config
- POSTcreate an external image component config
- POSTcreate a helm component config
- GETget latest config for a component
- POSTcreate a terraform component config
installers
installs
- GETget all installs for an app
- POSTcreate an app install
- GETget an install
- POSTCreate an app install from an installer
- GETget all installs for an org
- DELdelete an install
- PATCHupdate an install
- GETget an install component
- GETget an installs components
- GETget an install components deploys
- GETget the latest deploy for an install component
- POSTdeploy a build to an install
- GETget an install deploy
- GETget install deploy plan
- GETget an installs inputs
- POSTcreate install inputs
- PATCHUpdates install input config for app
- GETget an installs current inputs
- GETget an installs sandbox runs
releases
general
orgs
installs
deploy a build to an install
POST
/
v1
/
installs
/
{install_id}
/
deploys
curl --request POST \
--url https://api.nuon.co/v1/installs/{install_id}/deploys \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"build_id": "<string>"
}'{
"action_workflow_runs": [
{
"action_workflow_config_id": "<string>",
"config": {
"action_workflow_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"steps": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"command": "<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": {
"created_at": "<string>",
"created_by_id": "<string>",
"github_install_id": "<string>",
"id": "<string>",
"updated_at": "<string>",
"vcs_connection_commit": [
{
"author_email": "<string>",
"author_name": "<string>",
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"sha": "<string>",
"updated_at": "<string>"
}
]
},
"vcs_connection_id": "<string>"
},
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"idx": 123,
"name": "<string>",
"previous_step_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>"
}
],
"timeout": 123,
"triggers": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"cron_schedule": "<string>",
"id": "<string>",
"type": "<string>",
"updated_at": "<string>"
}
],
"updated_at": "<string>"
},
"created_at": "<string>",
"created_by_id": "<string>",
"execution_time": 123,
"id": "<string>",
"install_action_workflow": {
"action_workflow": {
"app_id": "<string>",
"config_count": 123,
"configs": [
{
"action_workflow_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"steps": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"command": "<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": {
"created_at": "<string>",
"created_by_id": "<string>",
"github_install_id": "<string>",
"id": "<string>",
"updated_at": "<string>",
"vcs_connection_commit": [
{
"author_email": "<string>",
"author_name": "<string>",
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"sha": "<string>",
"updated_at": "<string>"
}
]
},
"vcs_connection_id": "<string>"
},
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"idx": 123,
"name": "<string>",
"previous_step_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>"
}
],
"timeout": 123,
"triggers": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"cron_schedule": "<string>",
"id": "<string>",
"type": "<string>",
"updated_at": "<string>"
}
],
"updated_at": "<string>"
}
],
"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>",
"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>"
},
"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": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {},
"outputs_json": "<string>",
"runner_job_execution_id": "<string>",
"updated_at": "<string>"
},
"result": {
"created_at": "<string>",
"created_by_id": "<string>",
"error_code": 123,
"error_metadata": {},
"id": "<string>",
"org_id": "<string>",
"runner_job_execution_id": "<string>",
"success": true,
"updated_at": "<string>"
},
"runner_job_id": "<string>",
"status": "pending",
"updated_at": "<string>"
}
],
"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>",
"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>"
}
],
"build_id": "<string>",
"component_config_version": 123,
"component_id": "<string>",
"component_name": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"install_component_id": "<string>",
"install_deploy_type": "release",
"install_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>"
},
"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": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {},
"outputs_json": "<string>",
"runner_job_execution_id": "<string>",
"updated_at": "<string>"
},
"result": {
"created_at": "<string>",
"created_by_id": "<string>",
"error_code": 123,
"error_metadata": {},
"id": "<string>",
"org_id": "<string>",
"runner_job_execution_id": "<string>",
"success": true,
"updated_at": "<string>"
},
"runner_job_id": "<string>",
"status": "pending",
"updated_at": "<string>"
}
],
"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>",
"updated_at": "<string>"
}Authorizations
Type "Bearer" followed by a space and token.
Path Parameters
install ID
Body
application/json
Input
Response
201
application/json
Created
this belongs to an app config id
parent component
metadata
all the details needed for a step
actual configuration
this belongs to an app config id
metadata
TODO: change to default null after migration & after initial pr
action_workflow_runs.install_action_workflow.runs.install_action_workflow.action_workflow_id
string
after query fields filled in after querying
available timeout is how long a job can be marked as "available" before being requeued
execution timeout is how long a job can be marked as "exeucuting" before being requeued
Available options:
health-checks, sync, build, deploy, sandbox, runner, operations, actions, any Available options:
exec, apply, destroy, plan-only, build, unknown overall timeout is how long a job can be attempted, before being cancelled
queue timeout is how long a job can be queued, before being made available
Available options:
queued, available, in-progress, finished, failed, timed-out, not-attempted, cancelled, unknown Available options:
health-check, docker-build, container-image-build, terraform-module-build, helm-chart-build, noop-build, oci-sync, noop-sync, terraform-deploy, helm-chart-deploy, job-deploy, noop-deploy, shut-down, update-version, noop, sandbox-terraform, runner-helm, runner-terraform, runner-local, actions-workflow Available options:
finished, pending, in-progress, error Available options:
manual, cron, pre-sandbox-run, post-sandbox-run, pre-deploy, post-deploy after query fields filled in after querying
available timeout is how long a job can be marked as "available" before being requeued
execution timeout is how long a job can be marked as "exeucuting" before being requeued
Available options:
pending, initializing, in-progress, cleaning-up, finished, failed, timed-out, not-attempted, cancelled, unknown Available options:
health-checks, sync, build, deploy, sandbox, runner, operations, actions, any Available options:
exec, apply, destroy, plan-only, build, unknown overall timeout is how long a job can be attempted, before being cancelled
queue timeout is how long a job can be queued, before being made available
Available options:
queued, available, in-progress, finished, failed, timed-out, not-attempted, cancelled, unknown Available options:
health-check, docker-build, container-image-build, terraform-module-build, helm-chart-build, noop-build, oci-sync, noop-sync, terraform-deploy, helm-chart-deploy, job-deploy, noop-deploy, shut-down, update-version, noop, sandbox-terraform, runner-helm, runner-terraform, runner-local, actions-workflow Available options:
finished, pending, in-progress, error Available options:
manual, cron, pre-sandbox-run, post-sandbox-run, pre-deploy, post-deploy Available options:
release, install, teardown, plan-only Fields that are de-nested at read time using AfterQuery
runner details
available timeout is how long a job can be marked as "available" before being requeued
execution timeout is how long a job can be marked as "exeucuting" before being requeued
Available options:
pending, initializing, in-progress, cleaning-up, finished, failed, timed-out, not-attempted, cancelled, unknown Available options:
health-checks, sync, build, deploy, sandbox, runner, operations, actions, any Available options:
exec, apply, destroy, plan-only, build, unknown overall timeout is how long a job can be attempted, before being cancelled
queue timeout is how long a job can be queued, before being made available
Available options:
queued, available, in-progress, finished, failed, timed-out, not-attempted, cancelled, unknown Available options:
health-check, docker-build, container-image-build, terraform-module-build, helm-chart-build, noop-build, oci-sync, noop-sync, terraform-deploy, helm-chart-deploy, job-deploy, noop-deploy, shut-down, update-version, noop, sandbox-terraform, runner-helm, runner-terraform, runner-local, actions-workflow curl --request POST \
--url https://api.nuon.co/v1/installs/{install_id}/deploys \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"build_id": "<string>"
}'{
"action_workflow_runs": [
{
"action_workflow_config_id": "<string>",
"config": {
"action_workflow_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"steps": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"command": "<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": {
"created_at": "<string>",
"created_by_id": "<string>",
"github_install_id": "<string>",
"id": "<string>",
"updated_at": "<string>",
"vcs_connection_commit": [
{
"author_email": "<string>",
"author_name": "<string>",
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"sha": "<string>",
"updated_at": "<string>"
}
]
},
"vcs_connection_id": "<string>"
},
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"idx": 123,
"name": "<string>",
"previous_step_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>"
}
],
"timeout": 123,
"triggers": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"cron_schedule": "<string>",
"id": "<string>",
"type": "<string>",
"updated_at": "<string>"
}
],
"updated_at": "<string>"
},
"created_at": "<string>",
"created_by_id": "<string>",
"execution_time": 123,
"id": "<string>",
"install_action_workflow": {
"action_workflow": {
"app_id": "<string>",
"config_count": 123,
"configs": [
{
"action_workflow_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"steps": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"command": "<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": {
"created_at": "<string>",
"created_by_id": "<string>",
"github_install_id": "<string>",
"id": "<string>",
"updated_at": "<string>",
"vcs_connection_commit": [
{
"author_email": "<string>",
"author_name": "<string>",
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"sha": "<string>",
"updated_at": "<string>"
}
]
},
"vcs_connection_id": "<string>"
},
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"idx": 123,
"name": "<string>",
"previous_step_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>"
}
],
"timeout": 123,
"triggers": [
{
"action_workflow_config_id": "<string>",
"app_config_id": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"cron_schedule": "<string>",
"id": "<string>",
"type": "<string>",
"updated_at": "<string>"
}
],
"updated_at": "<string>"
}
],
"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>",
"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>"
},
"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": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {},
"outputs_json": "<string>",
"runner_job_execution_id": "<string>",
"updated_at": "<string>"
},
"result": {
"created_at": "<string>",
"created_by_id": "<string>",
"error_code": 123,
"error_metadata": {},
"id": "<string>",
"org_id": "<string>",
"runner_job_execution_id": "<string>",
"success": true,
"updated_at": "<string>"
},
"runner_job_id": "<string>",
"status": "pending",
"updated_at": "<string>"
}
],
"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>",
"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>"
}
],
"build_id": "<string>",
"component_config_version": 123,
"component_id": "<string>",
"component_name": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"install_component_id": "<string>",
"install_deploy_type": "release",
"install_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>"
},
"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": [
{
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"outputs": {},
"outputs_json": "<string>",
"runner_job_execution_id": "<string>",
"updated_at": "<string>"
},
"result": {
"created_at": "<string>",
"created_by_id": "<string>",
"error_code": 123,
"error_metadata": {},
"id": "<string>",
"org_id": "<string>",
"runner_job_execution_id": "<string>",
"success": true,
"updated_at": "<string>"
},
"runner_job_id": "<string>",
"status": "pending",
"updated_at": "<string>"
}
],
"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>",
"updated_at": "<string>"
}