- Github
- Blog
- Community
- Youtube
- GETget all apps for the current org
- POSTcreate an app
- GETget an app
- DELdelete an app
- PATCHupdate an app
- POSTCreate app input configs
- GETget app input configs
- GETget latest app input config
- POSTcreate an app sandbox config
- GETget app sandbox configs
- GETget latest app sandbox config
- 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
- POSTcreate an installer
- GETRender an app installer
- GETget an installer
- DELdelete an installer
- 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 logs
- GETget install deploy plan
- GETget an installs inputs
- POSTcreate install inputs
- GETget an installs current inputs
- GETget an installs sandbox runs
- GETget all releases for an app
- GETget all releases for a component
- POSTcreate a release
- POSTCreate a release 1
- GETget a release
- GETget a release
- GETGet config for cli
- GETGet current user
- POSTPublish a metric from different Nuon clients for telemetry purposes.
apps
components
installers
installs
releases
general
installers
Render an app installer
GET
/
v1
/
installer
/
{installer_slug}
/
render
installer_slug
string
*
installer_slug
Required
string
installer slug or ID
Path Parameters
installer_slug
string
requiredinstaller slug or ID
Response
200 - application/json
app
object
app.created_at
string
app.created_by
object
app.created_by.created_at
string
app.created_by.created_by_id
string
app.created_by.email
string
app.created_by.expires_at
string
app.created_by.id
string
app.created_by.issued_at
string
app.created_by.issuer
string
app.created_by.subject
string
claim data
app.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app.created_by.updated_at
string
app.created_by_id
string
app.id
string
app.name
string
app.org_id
string
app.status
string
app.status_description
string
app.updated_at
string
app_inputs
object
app_inputs.app_id
string
app_inputs.app_inputs
object[]
app_inputs.app_inputs.app_input_id
string
app_inputs.app_inputs.created_at
string
app_inputs.app_inputs.created_by
object
app_inputs.app_inputs.created_by.created_at
string
app_inputs.app_inputs.created_by.created_by_id
string
app_inputs.app_inputs.created_by.email
string
app_inputs.app_inputs.created_by.expires_at
string
app_inputs.app_inputs.created_by.id
string
app_inputs.app_inputs.created_by.issued_at
string
app_inputs.app_inputs.created_by.issuer
string
app_inputs.app_inputs.created_by.subject
string
claim data
app_inputs.app_inputs.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_inputs.app_inputs.created_by.updated_at
string
app_inputs.app_inputs.created_by_id
string
app_inputs.app_inputs.default
string
app_inputs.app_inputs.description
string
app_inputs.app_inputs.display_name
string
app_inputs.app_inputs.id
string
app_inputs.app_inputs.name
string
app_inputs.app_inputs.org_id
string
app_inputs.app_inputs.required
boolean
app_inputs.app_inputs.sensitive
boolean
app_inputs.app_inputs.updated_at
string
app_inputs.created_at
string
app_inputs.created_by
object
app_inputs.created_by.created_at
string
app_inputs.created_by.created_by_id
string
app_inputs.created_by.email
string
app_inputs.created_by.expires_at
string
app_inputs.created_by.id
string
app_inputs.created_by.issued_at
string
app_inputs.created_by.issuer
string
app_inputs.created_by.subject
string
claim data
app_inputs.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_inputs.created_by.updated_at
string
app_inputs.created_by_id
string
app_inputs.id
string
app_inputs.install_inputs
object[]
app_inputs.install_inputs.app_input_config_id
string
app_inputs.install_inputs.created_at
string
app_inputs.install_inputs.created_by
object
app_inputs.install_inputs.created_by.created_at
string
app_inputs.install_inputs.created_by.created_by_id
string
app_inputs.install_inputs.created_by.email
string
app_inputs.install_inputs.created_by.expires_at
string
app_inputs.install_inputs.created_by.id
string
app_inputs.install_inputs.created_by.issued_at
string
app_inputs.install_inputs.created_by.issuer
string
app_inputs.install_inputs.created_by.subject
string
claim data
app_inputs.install_inputs.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_inputs.install_inputs.created_by.updated_at
string
app_inputs.install_inputs.created_by_id
string
app_inputs.install_inputs.id
string
app_inputs.install_inputs.install_id
string
app_inputs.install_inputs.org_id
string
app_inputs.install_inputs.updated_at
string
app_inputs.install_inputs.values
object
app_inputs.org_id
string
app_inputs.updated_at
string
app_sandbox
object
app_sandbox.app_id
string
TODO(jm): add this back, once we have migrated all existing app sandbox configs
gorm:"not null;default null"
app_sandbox.artifacts
object
Links are dynamically loaded using an after query
app_sandbox.artifacts.cloudformation_stack_template
string
app_sandbox.artifacts.deprovision_policy
string
app_sandbox.artifacts.provision_policy
string
app_sandbox.artifacts.trust_policy
string
app_sandbox.connected_github_vcs_config
object
app_sandbox.connected_github_vcs_config.branch
string
app_sandbox.connected_github_vcs_config.component_config_id
string
parent component
app_sandbox.connected_github_vcs_config.component_config_type
string
app_sandbox.connected_github_vcs_config.created_at
string
app_sandbox.connected_github_vcs_config.created_by
object
app_sandbox.connected_github_vcs_config.created_by.created_at
string
app_sandbox.connected_github_vcs_config.created_by.created_by_id
string
app_sandbox.connected_github_vcs_config.created_by.email
string
app_sandbox.connected_github_vcs_config.created_by.expires_at
string
app_sandbox.connected_github_vcs_config.created_by.id
string
app_sandbox.connected_github_vcs_config.created_by.issued_at
string
app_sandbox.connected_github_vcs_config.created_by.issuer
string
app_sandbox.connected_github_vcs_config.created_by.subject
string
claim data
app_sandbox.connected_github_vcs_config.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_sandbox.connected_github_vcs_config.created_by.updated_at
string
app_sandbox.connected_github_vcs_config.created_by_id
string
app_sandbox.connected_github_vcs_config.directory
string
app_sandbox.connected_github_vcs_config.id
string
app_sandbox.connected_github_vcs_config.repo
string
app_sandbox.connected_github_vcs_config.repo_name
string
app_sandbox.connected_github_vcs_config.repo_owner
string
app_sandbox.connected_github_vcs_config.updated_at
string
app_sandbox.connected_github_vcs_config.vcs_connection
object
app_sandbox.connected_github_vcs_config.vcs_connection.created_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by
object
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.created_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.created_by_id
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.email
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.expires_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.id
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.issued_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.issuer
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.subject
string
claim data
app_sandbox.connected_github_vcs_config.vcs_connection.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_sandbox.connected_github_vcs_config.vcs_connection.created_by.updated_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.created_by_id
string
app_sandbox.connected_github_vcs_config.vcs_connection.github_install_id
string
app_sandbox.connected_github_vcs_config.vcs_connection.id
string
app_sandbox.connected_github_vcs_config.vcs_connection.updated_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit
object[]
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.author_email
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.author_name
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.component_config_connection_id
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by
object
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.created_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.created_by_id
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.email
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.expires_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.id
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.issued_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.issuer
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.subject
string
claim data
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by.updated_at
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by_id
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.id
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.message
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.sha
string
app_sandbox.connected_github_vcs_config.vcs_connection.vcs_connection_commit.updated_at
string
app_sandbox.connected_github_vcs_config.vcs_connection_id
string
app_sandbox.created_at
string
app_sandbox.created_by
object
app_sandbox.created_by.created_at
string
app_sandbox.created_by.created_by_id
string
app_sandbox.created_by.email
string
app_sandbox.created_by.expires_at
string
app_sandbox.created_by.id
string
app_sandbox.created_by.issued_at
string
app_sandbox.created_by.issuer
string
app_sandbox.created_by.subject
string
claim data
app_sandbox.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_sandbox.created_by.updated_at
string
app_sandbox.created_by_id
string
app_sandbox.id
string
app_sandbox.org_id
string
app_sandbox.public_git_vcs_config
object
app_sandbox.public_git_vcs_config.branch
string
app_sandbox.public_git_vcs_config.component_config_id
string
app_sandbox.public_git_vcs_config.component_config_type
string
app_sandbox.public_git_vcs_config.created_at
string
app_sandbox.public_git_vcs_config.created_by
object
app_sandbox.public_git_vcs_config.created_by.created_at
string
app_sandbox.public_git_vcs_config.created_by.created_by_id
string
app_sandbox.public_git_vcs_config.created_by.email
string
app_sandbox.public_git_vcs_config.created_by.expires_at
string
app_sandbox.public_git_vcs_config.created_by.id
string
app_sandbox.public_git_vcs_config.created_by.issued_at
string
app_sandbox.public_git_vcs_config.created_by.issuer
string
app_sandbox.public_git_vcs_config.created_by.subject
string
claim data
app_sandbox.public_git_vcs_config.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_sandbox.public_git_vcs_config.created_by.updated_at
string
app_sandbox.public_git_vcs_config.created_by_id
string
app_sandbox.public_git_vcs_config.directory
string
app_sandbox.public_git_vcs_config.id
string
app_sandbox.public_git_vcs_config.repo
string
actual configuration
app_sandbox.public_git_vcs_config.updated_at
string
app_sandbox.sandbox_release
object
app_sandbox.sandbox_release.created_at
string
app_sandbox.sandbox_release.created_by
object
app_sandbox.sandbox_release.created_by.created_at
string
app_sandbox.sandbox_release.created_by.created_by_id
string
app_sandbox.sandbox_release.created_by.email
string
app_sandbox.sandbox_release.created_by.expires_at
string
app_sandbox.sandbox_release.created_by.id
string
app_sandbox.sandbox_release.created_by.issued_at
string
app_sandbox.sandbox_release.created_by.issuer
string
app_sandbox.sandbox_release.created_by.subject
string
claim data
app_sandbox.sandbox_release.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin app_sandbox.sandbox_release.created_by.updated_at
string
app_sandbox.sandbox_release.created_by_id
string
app_sandbox.sandbox_release.deprovision_policy_url
string
app_sandbox.sandbox_release.id
string
app_sandbox.sandbox_release.one_click_role_template_url
string
app_sandbox.sandbox_release.provision_policy_url
string
app_sandbox.sandbox_release.trust_policy_url
string
app_sandbox.sandbox_release.updated_at
string
app_sandbox.sandbox_release.version
string
app_sandbox.sandbox_release_id
string
app_sandbox.terraform_version
string
app_sandbox.updated_at
string
app_sandbox.variables
object
metadata
object
metadata.app_installer_id
string
metadata.community_url
string
metadata.created_at
string
metadata.created_by
object
metadata.created_by.created_at
string
metadata.created_by.created_by_id
string
metadata.created_by.email
string
metadata.created_by.expires_at
string
metadata.created_by.id
string
metadata.created_by.issued_at
string
metadata.created_by.issuer
string
metadata.created_by.subject
string
claim data
metadata.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin metadata.created_by.updated_at
string
metadata.created_by_id
string
metadata.demo_url
string
metadata.description
string
metadata.documentation_url
string
metadata.formatted_demo_url
string
metadata.github_url
string
metadata.homepage_url
string
metadata.id
string
metadata.logo_url
string
metadata.name
string
metadata.post_install_markdown
string
metadata.updated_at
string
sandbox_mode
boolean