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 logs
- GETget install deploy plan
- GETget an installs inputs
- POSTcreate install inputs
- GETget an installs current inputs
- GETget an installs sandbox runs
releases
general
orgs
installs
Create an app install from an installer
POST
/
v1
/
installer
/
{installer_slug}
/
installs
installer_slug
string
*
installer_slug
Required
string
installer slug or ID
object
*
aws_account
object
*
aws_account
Required
object
iam_role_arn
string
*
iam_role_arn
Required
string
region
string
region
string
inputs
object
inputs
object
name
string
*
name
Required
string
Path Parameters
installer slug or ID
Body
application/json
Response
201 - application/json
Available options:
aws-ecs, aws-eks 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_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.author_email
string
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.author_name
string
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.component_config_connection_id
string
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_at
string
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by
object
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by_id
string
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.message
string
app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit.updated_at
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 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 Available options:
release, install, teardown Fields that are de-nested at read time using AfterQuery
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"
Links are dynamically loaded using an after query
parent component
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.created_by.created_by_id
string
claim data
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.created_by.token_type
enum<string>
Available options:
auth0, integration, canary, admin install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.vcs_connection.created_at
string
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.vcs_connection.created_by
object
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.vcs_connection.created_by_id
string
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.vcs_connection.github_install_id
string
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.vcs_connection.updated_at
string
install_sandbox_runs.app_sandbox_config.connected_github_vcs_config.vcs_connection.vcs_connection_commit
object[]
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 Available options:
provision, reprovision, deprovision