components
create an external image component config
- 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 an external image component config
POST
/
v1
/
components
/
{component_id}
/
configs
/
external-image
Authorization
string
*
Authorization
Required
string
Type "Bearer" followed by a space and token.
component_id
string
*
component_id
Required
string
component ID
object
*
aws_ecr_image_config
object
aws_ecr_image_config
object
aws_region
string
aws_region
string
iam_role_arn
string
iam_role_arn
string
image_url
string
*
image_url
Required
string
tag
string
*
tag
Required
string
curl --request POST \
--url https://ctl.prod.nuon.co/v1/components/{component_id}/configs/external-image \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"aws_ecr_image_config": {
"aws_region": "<string>",
"iam_role_arn": "<string>"
},
"image_url": "<string>",
"tag": "<string>"
}'
{
"aws_ecr_image_config": {
"aws_region": "<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>",
"iam_role_arn": "<string>",
"id": "<string>",
"updated_at": "<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>",
"image_url": "<string>",
"tag": "<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
aws_ecr_image_config
object
aws_ecr_image_config.aws_region
string
aws_ecr_image_config.iam_role_arn
string
image_url
string
requiredtag
string
requiredResponse
201 - application/json
aws_ecr_image_config
object
aws_ecr_image_config.aws_region
string
aws_ecr_image_config.component_config_id
string
connection to parent model
aws_ecr_image_config.component_config_type
string
aws_ecr_image_config.created_at
string
aws_ecr_image_config.created_by
object
aws_ecr_image_config.created_by.created_at
string
aws_ecr_image_config.created_by.created_by_id
string
aws_ecr_image_config.created_by.email
string
aws_ecr_image_config.created_by.expires_at
string
aws_ecr_image_config.created_by.id
string
aws_ecr_image_config.created_by.issued_at
string
aws_ecr_image_config.created_by.issuer
string
aws_ecr_image_config.created_by.subject
string
claim data
aws_ecr_image_config.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
aws_ecr_image_config.created_by.updated_at
string
aws_ecr_image_config.created_by_id
string
aws_ecr_image_config.iam_role_arn
string
actual configuration
aws_ecr_image_config.id
string
aws_ecr_image_config.updated_at
string
component_config_connection_id
string
value
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
id
string
image_url
string
tag
string
updated_at
string
curl --request POST \
--url https://ctl.prod.nuon.co/v1/components/{component_id}/configs/external-image \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"aws_ecr_image_config": {
"aws_region": "<string>",
"iam_role_arn": "<string>"
},
"image_url": "<string>",
"tag": "<string>"
}'
{
"aws_ecr_image_config": {
"aws_region": "<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>",
"iam_role_arn": "<string>",
"id": "<string>",
"updated_at": "<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>",
"image_url": "<string>",
"tag": "<string>",
"updated_at": "<string>"
}