installers
get an installer
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
- POSTcreate a job 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
installers
get an installer
GET
/
v1
/
installers
/
{installer_id}
curl --request GET \
--url https://api.nuon.co/v1/installers/{installer_id} \
--header 'Authorization: <api-key>'
{
"apps": [
{
"cloud_platform": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"description": "<string>",
"display_name": "<string>",
"id": "<string>",
"input_config": {
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"input_groups": [
{
"app_input_id": "<string>",
"app_inputs": [
{
"app_input_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"default": "<string>",
"description": "<string>",
"display_name": "<string>",
"group": {},
"group_id": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"required": true,
"sensitive": true,
"updated_at": "<string>"
}
],
"created_at": "<string>",
"created_by_id": "<string>",
"description": "<string>",
"display_name": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"updated_at": "<string>"
}
],
"inputs": [
{
"app_input_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"default": "<string>",
"description": "<string>",
"display_name": "<string>",
"group": {},
"group_id": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"required": true,
"sensitive": true,
"updated_at": "<string>"
}
],
"install_inputs": [
{
"app_input_config_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"install_id": "<string>",
"org_id": "<string>",
"redacted_values": {},
"updated_at": "<string>",
"values": {}
}
],
"org_id": "<string>",
"updated_at": "<string>"
},
"name": "<string>",
"notifications_config": {
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"slack_webhook_url": "<string>",
"updated_at": "<string>"
},
"org_id": "<string>",
"runner_config": {
"app_id": "<string>",
"app_runner_type": "aws-ecs",
"cloud_platform": "aws",
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"org_id": "<string>",
"updated_at": "<string>"
},
"sandbox_config": {
"app_id": "<string>",
"artifacts": {
"cloudformation_stack_template": "<string>",
"deprovision_policy": "<string>",
"provision_policy": "<string>",
"trust_policy": "<string>"
},
"aws_delegation_config": {
"app_sandbox_config_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"iam_role_arn": "<string>",
"id": "<string>",
"org_id": "<string>",
"updated_at": "<string>"
},
"aws_region_type": "<string>",
"cloud_platform": "<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>",
"id": "<string>",
"org_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>"
},
"terraform_version": "<string>",
"updated_at": "<string>",
"variables": {}
},
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"metadata": {
"community_url": "<string>",
"copyright_markdown": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"demo_url": "<string>",
"description": "<string>",
"documentation_url": "<string>",
"favicon_url": "<string>",
"footer_markdown": "<string>",
"formatted_demo_url": "<string>",
"github_url": "<string>",
"homepage_url": "<string>",
"id": "<string>",
"installer_id": "<string>",
"logo_url": "<string>",
"name": "<string>",
"og_image_url": "<string>",
"post_install_markdown": "<string>",
"updated_at": "<string>"
},
"org_id": "<string>",
"type": "self_hosted",
"updated_at": "<string>"
}
Authorizations
Type "Bearer" followed by a space and token.
Path Parameters
installer ID
Response
200
application/json
OK
fields set via after query
Available options:
aws-ecs
, aws-eks
, azure-aks
, azure-acs
, local
Available options:
aws
, azure
, unknown
cloud specific fields
fields set via after query
parent component
actual configuration
Available options:
self_hosted
curl --request GET \
--url https://api.nuon.co/v1/installers/{installer_id} \
--header 'Authorization: <api-key>'
{
"apps": [
{
"cloud_platform": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"description": "<string>",
"display_name": "<string>",
"id": "<string>",
"input_config": {
"app_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"input_groups": [
{
"app_input_id": "<string>",
"app_inputs": [
{
"app_input_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"default": "<string>",
"description": "<string>",
"display_name": "<string>",
"group": {},
"group_id": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"required": true,
"sensitive": true,
"updated_at": "<string>"
}
],
"created_at": "<string>",
"created_by_id": "<string>",
"description": "<string>",
"display_name": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"updated_at": "<string>"
}
],
"inputs": [
{
"app_input_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"default": "<string>",
"description": "<string>",
"display_name": "<string>",
"group": {},
"group_id": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"required": true,
"sensitive": true,
"updated_at": "<string>"
}
],
"install_inputs": [
{
"app_input_config_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"install_id": "<string>",
"org_id": "<string>",
"redacted_values": {},
"updated_at": "<string>",
"values": {}
}
],
"org_id": "<string>",
"updated_at": "<string>"
},
"name": "<string>",
"notifications_config": {
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"org_id": "<string>",
"owner_id": "<string>",
"owner_type": "<string>",
"slack_webhook_url": "<string>",
"updated_at": "<string>"
},
"org_id": "<string>",
"runner_config": {
"app_id": "<string>",
"app_runner_type": "aws-ecs",
"cloud_platform": "aws",
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"org_id": "<string>",
"updated_at": "<string>"
},
"sandbox_config": {
"app_id": "<string>",
"artifacts": {
"cloudformation_stack_template": "<string>",
"deprovision_policy": "<string>",
"provision_policy": "<string>",
"trust_policy": "<string>"
},
"aws_delegation_config": {
"app_sandbox_config_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"iam_role_arn": "<string>",
"id": "<string>",
"org_id": "<string>",
"updated_at": "<string>"
},
"aws_region_type": "<string>",
"cloud_platform": "<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>",
"id": "<string>",
"org_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>"
},
"terraform_version": "<string>",
"updated_at": "<string>",
"variables": {}
},
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"metadata": {
"community_url": "<string>",
"copyright_markdown": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"demo_url": "<string>",
"description": "<string>",
"documentation_url": "<string>",
"favicon_url": "<string>",
"footer_markdown": "<string>",
"formatted_demo_url": "<string>",
"github_url": "<string>",
"homepage_url": "<string>",
"id": "<string>",
"installer_id": "<string>",
"logo_url": "<string>",
"name": "<string>",
"og_image_url": "<string>",
"post_install_markdown": "<string>",
"updated_at": "<string>"
},
"org_id": "<string>",
"type": "self_hosted",
"updated_at": "<string>"
}