orgs
Update current org
- 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
orgs
Update current org
PATCH
/
v1
/
orgs
/
current
Authorization
string
*
Authorization
Required
string
Type "Bearer" followed by a space and token.
object
*
name
string
*
name
Required
string
curl --request PATCH \
--url https://ctl.prod.nuon.co/v1/orgs/current \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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>",
"custom_cert": true,
"health_checks": [
{
"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>",
"orgID": "<string>",
"status": "ok",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"id": "<string>",
"latest_health_check": {
"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>",
"orgID": "<string>",
"status": "ok",
"status_description": "<string>",
"updated_at": "<string>"
},
"name": "<string>",
"sandbox_mode": true,
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>",
"users": [
{
"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>",
"orgID": "<string>",
"updated_at": "<string>",
"userID": "<string>"
}
],
"vcs_connections": [
{
"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>",
"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": {
"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.
Body
application/json
name
string
requiredResponse
200 - application/json
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
custom_cert
boolean
health_checks
object[]
health_checks.created_at
string
health_checks.created_by
object
health_checks.created_by.created_at
string
health_checks.created_by.created_by_id
string
health_checks.created_by.email
string
health_checks.created_by.expires_at
string
health_checks.created_by.id
string
health_checks.created_by.issued_at
string
health_checks.created_by.issuer
string
health_checks.created_by.subject
string
claim data
health_checks.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
health_checks.created_by.updated_at
string
health_checks.created_by_id
string
health_checks.id
string
health_checks.orgID
string
health_checks.status
enum<string>
Available options:
ok
, error
, in-progress
, provisioning
, deprovisioning
health_checks.status_description
string
health_checks.updated_at
string
id
string
latest_health_check
object
Filled in at read time
latest_health_check.created_at
string
latest_health_check.created_by
object
latest_health_check.created_by.created_at
string
latest_health_check.created_by.created_by_id
string
latest_health_check.created_by.email
string
latest_health_check.created_by.expires_at
string
latest_health_check.created_by.id
string
latest_health_check.created_by.issued_at
string
latest_health_check.created_by.issuer
string
latest_health_check.created_by.subject
string
claim data
latest_health_check.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
latest_health_check.created_by.updated_at
string
latest_health_check.created_by_id
string
latest_health_check.id
string
latest_health_check.orgID
string
latest_health_check.status
enum<string>
Available options:
ok
, error
, in-progress
, provisioning
, deprovisioning
latest_health_check.status_description
string
latest_health_check.updated_at
string
name
string
sandbox_mode
boolean
These fields are used to control the behaviour of the org NOTE: these are starting as nullable, so we can update stage/prod before resetting locally.
status
string
status_description
string
updated_at
string
users
object[]
users.created_at
string
users.created_by
object
users.created_by.created_at
string
users.created_by.created_by_id
string
users.created_by.email
string
users.created_by.expires_at
string
users.created_by.id
string
users.created_by.issued_at
string
users.created_by.issuer
string
users.created_by.subject
string
claim data
users.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
users.created_by.updated_at
string
users.created_by_id
string
users.id
string
users.orgID
string
parent relationship
users.updated_at
string
users.userID
string
vcs_connections
object[]
vcs_connections.created_at
string
vcs_connections.created_by
object
vcs_connections.created_by.created_at
string
vcs_connections.created_by.created_by_id
string
vcs_connections.created_by.email
string
vcs_connections.created_by.expires_at
string
vcs_connections.created_by.id
string
vcs_connections.created_by.issued_at
string
vcs_connections.created_by.issuer
string
vcs_connections.created_by.subject
string
claim data
vcs_connections.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
vcs_connections.created_by.updated_at
string
vcs_connections.created_by_id
string
vcs_connections.github_install_id
string
vcs_connections.id
string
vcs_connections.updated_at
string
vcs_connections.vcs_connection_commit
object[]
vcs_connections.vcs_connection_commit.author_email
string
vcs_connections.vcs_connection_commit.author_name
string
vcs_connections.vcs_connection_commit.component_config_connection_id
string
vcs_connections.vcs_connection_commit.created_at
string
vcs_connections.vcs_connection_commit.created_by
object
vcs_connections.vcs_connection_commit.created_by.created_at
string
vcs_connections.vcs_connection_commit.created_by.created_by_id
string
vcs_connections.vcs_connection_commit.created_by.email
string
vcs_connections.vcs_connection_commit.created_by.expires_at
string
vcs_connections.vcs_connection_commit.created_by.id
string
vcs_connections.vcs_connection_commit.created_by.issued_at
string
vcs_connections.vcs_connection_commit.created_by.issuer
string
vcs_connections.vcs_connection_commit.created_by.subject
string
claim data
vcs_connections.vcs_connection_commit.created_by.token_type
enum<string>
Available options:
auth0
, admin
, static
, integration
, canary
vcs_connections.vcs_connection_commit.created_by.updated_at
string
vcs_connections.vcs_connection_commit.created_by_id
string
vcs_connections.vcs_connection_commit.id
string
vcs_connections.vcs_connection_commit.message
string
vcs_connections.vcs_connection_commit.sha
string
vcs_connections.vcs_connection_commit.updated_at
string
curl --request PATCH \
--url https://ctl.prod.nuon.co/v1/orgs/current \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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>",
"custom_cert": true,
"health_checks": [
{
"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>",
"orgID": "<string>",
"status": "ok",
"status_description": "<string>",
"updated_at": "<string>"
}
],
"id": "<string>",
"latest_health_check": {
"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>",
"orgID": "<string>",
"status": "ok",
"status_description": "<string>",
"updated_at": "<string>"
},
"name": "<string>",
"sandbox_mode": true,
"status": "<string>",
"status_description": "<string>",
"updated_at": "<string>",
"users": [
{
"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>",
"orgID": "<string>",
"updated_at": "<string>",
"userID": "<string>"
}
],
"vcs_connections": [
{
"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>",
"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": {
"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>"
}
]
}
]
}