components
create component build
- 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 app installer
- GETrender an 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
components
create component build
POST
/
v1
/
components
/
{component_id}
/
builds
Authorization
string
*
Authorization
Required
string
Type "Bearer" followed by a space and token.
component_id
string
*
component_id
Required
string
component ID
object
*
git_ref
string
git_ref
string
use_latest
boolean
use_latest
boolean
curl --request POST \
--url https://ctl.prod.nuon.co/v1/components/{component_id}/builds \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"git_ref": "<string>",
"use_latest": true
}'
{
"component_config_connection_id": "<string>",
"component_id": "<string>",
"component_name": "<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>",
"git_ref": "<string>",
"id": "<string>",
"install_deploys": [
{
"build_id": "<string>",
"component_id": "<string>",
"component_name": "<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_component_id": "<string>",
"install_deploy_type": "release",
"install_id": "<string>",
"release_id": "<string>",
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"releases": [
{
"build_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>",
"release_steps": [
{
"component_release_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>",
"delay": "<string>",
"id": "<string>",
"install_deploys": [
{
"build_id": "<string>",
"component_id": "<string>",
"component_name": "<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_component_id": "<string>",
"install_deploy_type": "release",
"install_id": "<string>",
"release_id": "<string>",
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"requested_install_ids": [
"<string>"
],
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"status": "<string>",
"status_description": "<string>",
"total_release_steps": 123,
"updated_at": "<string>"
}
],
"status": "<string>",
"status_description": "<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>"
}
}
Authorizations
Authorization
string
headerrequiredType "Bearer" followed by a space and token.
Path Parameters
component_id
string
requiredcomponent ID
Body
application/json
git_ref
string
use_latest
boolean
Response
201 - application/json
component_config_connection_id
string
component_id
string
Read-only fields set on the object to de-nest data
component_name
string
created_at
string
created_by
object
created_by.created_at
string
created_by.created_by_id
string
created_by.email
string
created_by.expires_at
string
created_by.id
string
created_by.issued_at
string
created_by.issuer
string
created_by.subject
string
claim data
created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
created_by.updated_at
string
created_by_id
string
git_ref
string
id
string
install_deploys
object[]
install_deploys.build_id
string
install_deploys.component_id
string
install_deploys.component_name
string
install_deploys.created_at
string
install_deploys.created_by
object
install_deploys.created_by.created_at
string
install_deploys.created_by.created_by_id
string
install_deploys.created_by.email
string
install_deploys.created_by.expires_at
string
install_deploys.created_by.id
string
install_deploys.created_by.issued_at
string
install_deploys.created_by.issuer
string
install_deploys.created_by.subject
string
claim data
install_deploys.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
install_deploys.created_by.updated_at
string
install_deploys.created_by_id
string
install_deploys.id
string
install_deploys.install_component_id
string
install_deploys.install_deploy_type
enum<string>
Available options:
release
, install
, teardown
install_deploys.install_id
string
Fields that are de-nested at read time using AfterQuery
install_deploys.release_id
string
install_deploys.status
string
install_deploys.status_description
string
install_deploys.updated_at
string
releases
object[]
releases.build_id
string
releases.created_at
string
releases.created_by
object
releases.created_by.created_at
string
releases.created_by.created_by_id
string
releases.created_by.email
string
releases.created_by.expires_at
string
releases.created_by.id
string
releases.created_by.issued_at
string
releases.created_by.issuer
string
releases.created_by.subject
string
claim data
releases.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
releases.created_by.updated_at
string
releases.created_by_id
string
releases.id
string
releases.release_steps
object[]
releases.release_steps.component_release_id
string
parent release ID
releases.release_steps.created_at
string
releases.release_steps.created_by
object
releases.release_steps.created_by.created_at
string
releases.release_steps.created_by.created_by_id
string
releases.release_steps.created_by.email
string
releases.release_steps.created_by.expires_at
string
releases.release_steps.created_by.id
string
releases.release_steps.created_by.issued_at
string
releases.release_steps.created_by.issuer
string
releases.release_steps.created_by.subject
string
claim data
releases.release_steps.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
releases.release_steps.created_by.updated_at
string
releases.release_steps.created_by_id
string
releases.release_steps.delay
string
fields to control the delay of the individual step, as this is set based on the parent strategy
releases.release_steps.id
string
releases.release_steps.install_deploys
object[]
releases.release_steps.install_deploys.build_id
string
releases.release_steps.install_deploys.component_id
string
releases.release_steps.install_deploys.component_name
string
releases.release_steps.install_deploys.created_at
string
releases.release_steps.install_deploys.created_by
object
releases.release_steps.install_deploys.created_by.created_at
string
releases.release_steps.install_deploys.created_by.created_by_id
string
releases.release_steps.install_deploys.created_by.email
string
releases.release_steps.install_deploys.created_by.expires_at
string
releases.release_steps.install_deploys.created_by.id
string
releases.release_steps.install_deploys.created_by.issued_at
string
releases.release_steps.install_deploys.created_by.issuer
string
releases.release_steps.install_deploys.created_by.subject
string
claim data
releases.release_steps.install_deploys.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
releases.release_steps.install_deploys.created_by.updated_at
string
releases.release_steps.install_deploys.created_by_id
string
releases.release_steps.install_deploys.id
string
releases.release_steps.install_deploys.install_component_id
string
releases.release_steps.install_deploys.install_deploy_type
enum<string>
Available options:
release
, install
, teardown
releases.release_steps.install_deploys.install_id
string
Fields that are de-nested at read time using AfterQuery
releases.release_steps.install_deploys.release_id
string
releases.release_steps.install_deploys.status
string
releases.release_steps.install_deploys.status_description
string
releases.release_steps.install_deploys.updated_at
string
releases.release_steps.requested_install_ids
string[]
When a step is created, a set of installs are targeted. However, by the time the release step goes out, the install might have been setup in any order of ways.
releases.release_steps.status
string
releases.release_steps.status_description
string
releases.release_steps.updated_at
string
releases.status
string
releases.status_description
string
releases.total_release_steps
integer
releases.updated_at
string
status
string
status_description
string
updated_at
string
vcs_connection_commit
object
vcs_connection_commit.author_email
string
vcs_connection_commit.author_name
string
vcs_connection_commit.component_config_connection_id
string
vcs_connection_commit.created_at
string
vcs_connection_commit.created_by
object
vcs_connection_commit.created_by.created_at
string
vcs_connection_commit.created_by.created_by_id
string
vcs_connection_commit.created_by.email
string
vcs_connection_commit.created_by.expires_at
string
vcs_connection_commit.created_by.id
string
vcs_connection_commit.created_by.issued_at
string
vcs_connection_commit.created_by.issuer
string
vcs_connection_commit.created_by.subject
string
claim data
vcs_connection_commit.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
vcs_connection_commit.created_by.updated_at
string
vcs_connection_commit.created_by_id
string
vcs_connection_commit.id
string
vcs_connection_commit.message
string
vcs_connection_commit.sha
string
vcs_connection_commit.updated_at
string
curl --request POST \
--url https://ctl.prod.nuon.co/v1/components/{component_id}/builds \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"git_ref": "<string>",
"use_latest": true
}'
{
"component_config_connection_id": "<string>",
"component_id": "<string>",
"component_name": "<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>",
"git_ref": "<string>",
"id": "<string>",
"install_deploys": [
{
"build_id": "<string>",
"component_id": "<string>",
"component_name": "<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_component_id": "<string>",
"install_deploy_type": "release",
"install_id": "<string>",
"release_id": "<string>",
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"releases": [
{
"build_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>",
"release_steps": [
{
"component_release_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>",
"delay": "<string>",
"id": "<string>",
"install_deploys": [
{
"build_id": "<string>",
"component_id": "<string>",
"component_name": "<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_component_id": "<string>",
"install_deploy_type": "release",
"install_id": "<string>",
"release_id": "<string>",
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"requested_install_ids": [
"<string>"
],
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"status": "<string>",
"status_description": "<string>",
"total_release_steps": 123,
"updated_at": "<string>"
}
],
"status": "<string>",
"status_description": "<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>"
}
}