components
get all configs for a component
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
components
get all configs for a component
GET
/
v1
/
components
/
{component_id}
/
configs
curl --request GET \
--url https://api.nuon.co/v1/components/{component_id}/configs \
--header 'Authorization: <api-key>'
[
{
"component_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"docker_build": {
"build_args": [
"<string>"
],
"component_config_connection_id": "<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>",
"dockerfile": "<string>",
"env_vars": {},
"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>"
},
"target": "<string>",
"updated_at": "<string>"
},
"external_image": {
"aws_ecr_image_config": {
"aws_region": "<string>",
"component_config_id": "<string>",
"component_config_type": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"iam_role_arn": "<string>",
"id": "<string>",
"updated_at": "<string>"
},
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"updated_at": "<string>"
},
"helm": {
"chart_name": "<string>",
"component_config_connection_id": "<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>",
"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>",
"values": {},
"values_files": [
"<string>"
]
},
"id": "<string>",
"job": {
"args": [
"<string>"
],
"cmd": [
"<string>"
],
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"updated_at": "<string>"
},
"terraform_module": {
"component_config_connection_id": "<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>",
"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>",
"variables": {},
"version": "<string>"
},
"type": "terraform_module",
"updated_at": "<string>",
"version": 123
}
]
Authorizations
Type "Bearer" followed by a space and token.
Path Parameters
component ID
Response
200
application/json
OK
value
parent component
docker_build.connected_github_vcs_config.vcs_connection.vcs_connection_commit.component_config_connection_id
string
docker_build.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by_id
string
actual configuration
connection to parent model
actual configuration
value
Helm specific configurations
parent reference
parent component
helm.connected_github_vcs_config.vcs_connection.vcs_connection_commit.component_config_connection_id
string
actual configuration
value
Image attributes, copied from a docker_buid or external_image component.
parent reference
parent component
terraform_module.connected_github_vcs_config.vcs_connection.vcs_connection_commit.author_email
string
terraform_module.connected_github_vcs_config.vcs_connection.vcs_connection_commit.author_name
string
terraform_module.connected_github_vcs_config.vcs_connection.vcs_connection_commit.component_config_connection_id
string
terraform_module.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_at
string
terraform_module.connected_github_vcs_config.vcs_connection.vcs_connection_commit.created_by_id
string
terraform_module.connected_github_vcs_config.vcs_connection.vcs_connection_commit.updated_at
string
actual configuration
terraform configuration values
Available options:
terraform_module
, helm_chart
, docker_build
, external_image
, job
, unknown
curl --request GET \
--url https://api.nuon.co/v1/components/{component_id}/configs \
--header 'Authorization: <api-key>'
[
{
"component_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"docker_build": {
"build_args": [
"<string>"
],
"component_config_connection_id": "<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>",
"dockerfile": "<string>",
"env_vars": {},
"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>"
},
"target": "<string>",
"updated_at": "<string>"
},
"external_image": {
"aws_ecr_image_config": {
"aws_region": "<string>",
"component_config_id": "<string>",
"component_config_type": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"iam_role_arn": "<string>",
"id": "<string>",
"updated_at": "<string>"
},
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"updated_at": "<string>"
},
"helm": {
"chart_name": "<string>",
"component_config_connection_id": "<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>",
"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>",
"values": {},
"values_files": [
"<string>"
]
},
"id": "<string>",
"job": {
"args": [
"<string>"
],
"cmd": [
"<string>"
],
"component_config_connection_id": "<string>",
"created_at": "<string>",
"created_by_id": "<string>",
"env_vars": {},
"id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"updated_at": "<string>"
},
"terraform_module": {
"component_config_connection_id": "<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>",
"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>",
"variables": {},
"version": "<string>"
},
"type": "terraform_module",
"updated_at": "<string>",
"version": 123
}
]