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
installers
Render an app installer
GET
/
v1
/
installer
/
{installer_slug}
/
render
curl --request GET \
--url https://ctl.prod.nuon.co/v1/installer/{installer_slug}/render
{
"app": {
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
},
"app_inputs": {
"app_id": "<string>",
"app_inputs": [
{
"app_input_id": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"default": "<string>",
"description": "<string>",
"display_name": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"required": true,
"sensitive": true,
"updated_at": "<string>"
}
],
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"install_inputs": [
{
"app_input_config_id": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"install_id": "<string>",
"org_id": "<string>",
"updated_at": "<string>",
"values": {}
}
],
"org_id": "<string>",
"updated_at": "<string>"
},
"app_sandbox": {
"app_id": "<string>",
"artifacts": {
"cloudformation_stack_template": "<string>",
"deprovision_policy": "<string>",
"provision_policy": "<string>",
"trust_policy": "<string>"
},
"connected_github_vcs_config": {
"branch": "<string>",
"component_config_id": "<string>",
"component_config_type": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_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": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_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": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"sha": "<string>",
"updated_at": "<string>"
}
]
},
"vcs_connection_id": "<string>"
},
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_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": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"directory": "<string>",
"id": "<string>",
"repo": "<string>",
"updated_at": "<string>"
},
"sandbox_release": {
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"deprovision_policy_url": "<string>",
"id": "<string>",
"one_click_role_template_url": "<string>",
"provision_policy_url": "<string>",
"trust_policy_url": "<string>",
"updated_at": "<string>",
"version": "<string>"
},
"sandbox_release_id": "<string>",
"terraform_version": "<string>",
"updated_at": "<string>",
"variables": {}
},
"metadata": {
"app_installer_id": "<string>",
"community_url": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"demo_url": "<string>",
"description": "<string>",
"documentation_url": "<string>",
"formatted_demo_url": "<string>",
"github_url": "<string>",
"homepage_url": "<string>",
"id": "<string>",
"logo_url": "<string>",
"name": "<string>",
"post_install_markdown": "<string>",
"updated_at": "<string>"
},
"sandbox_mode": true
}
Path Parameters
installer slug or ID
Response
200
application/json
OK
claim data
Available options:
auth0
, integration
, canary
, admin
claim data
Available options:
auth0
, integration
, canary
, admin
claim data
Available options:
auth0
, integration
, canary
, admin
claim data
Available options:
auth0
, integration
, canary
, admin
TODO(jm): add this back, once we have migrated all existing app sandbox configs
gorm:"not null;default null"
parent component
claim data
Available options:
auth0
, integration
, canary
, admin
claim data
Available options:
auth0
, integration
, canary
, admin
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.component_config_connection_id
string
claim data
Available options:
auth0
, integration
, canary
, admin
claim data
Available options:
auth0
, integration
, canary
, admin
actual configuration
claim data
Available options:
auth0
, integration
, canary
, admin
claim data
Available options:
auth0
, integration
, canary
, admin
curl --request GET \
--url https://ctl.prod.nuon.co/v1/installer/{installer_slug}/render
{
"app": {
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
},
"app_inputs": {
"app_id": "<string>",
"app_inputs": [
{
"app_input_id": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"default": "<string>",
"description": "<string>",
"display_name": "<string>",
"id": "<string>",
"name": "<string>",
"org_id": "<string>",
"required": true,
"sensitive": true,
"updated_at": "<string>"
}
],
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"install_inputs": [
{
"app_input_config_id": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"install_id": "<string>",
"org_id": "<string>",
"updated_at": "<string>",
"values": {}
}
],
"org_id": "<string>",
"updated_at": "<string>"
},
"app_sandbox": {
"app_id": "<string>",
"artifacts": {
"cloudformation_stack_template": "<string>",
"deprovision_policy": "<string>",
"provision_policy": "<string>",
"trust_policy": "<string>"
},
"connected_github_vcs_config": {
"branch": "<string>",
"component_config_id": "<string>",
"component_config_type": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_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": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_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": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"id": "<string>",
"message": "<string>",
"sha": "<string>",
"updated_at": "<string>"
}
]
},
"vcs_connection_id": "<string>"
},
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_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": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"directory": "<string>",
"id": "<string>",
"repo": "<string>",
"updated_at": "<string>"
},
"sandbox_release": {
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"deprovision_policy_url": "<string>",
"id": "<string>",
"one_click_role_template_url": "<string>",
"provision_policy_url": "<string>",
"trust_policy_url": "<string>",
"updated_at": "<string>",
"version": "<string>"
},
"sandbox_release_id": "<string>",
"terraform_version": "<string>",
"updated_at": "<string>",
"variables": {}
},
"metadata": {
"app_installer_id": "<string>",
"community_url": "<string>",
"created_at": "<string>",
"created_by": {
"created_at": "<string>",
"created_by_id": "<string>",
"email": "<string>",
"expires_at": "<string>",
"id": "<string>",
"issued_at": "<string>",
"issuer": "<string>",
"subject": "<string>",
"token_type": "auth0",
"updated_at": "<string>"
},
"created_by_id": "<string>",
"demo_url": "<string>",
"description": "<string>",
"documentation_url": "<string>",
"formatted_demo_url": "<string>",
"github_url": "<string>",
"homepage_url": "<string>",
"id": "<string>",
"logo_url": "<string>",
"name": "<string>",
"post_install_markdown": "<string>",
"updated_at": "<string>"
},
"sandbox_mode": true
}