Nuon apps API is one of 18 APIs that Nuon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include apps. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 73 operations across 57 paths, and defines 261 schemas. It is described by OpenAPI 2.0, at version 0.19.1074.
Requests are made against the base URL https://api.nuon.co.
73 operations
57 paths
261 schemas
4 DELETE42 GET4 PATCH23 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Nuon apps API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (APIKey).
An API key is passed in the header as X-Nuon-Org-ID (OrgID).
APIKey— Type "Bearer" followed by a space and token.OrgID— Nuon org ID
Paths & Operations 73
Across 57 paths, the API surfaces 73 operations — 4 DELETE, 42 GET, 4 PATCH, 23 POST. Each is listed below with its method, path, parameters, and response codes.
apps 73
apps
GET
/v1/apps
get all apps for the current org
POST
/v1/apps
create an app
DELETE
/v1/apps/{app_id}
delete an app
GET
/v1/apps/{app_id}
get an app
PATCH
/v1/apps/{app_id}
update an app
GET
/v1/apps/{app_id}/branches
get app branches
POST
/v1/apps/{app_id}/branches
Cancel a runner job.
DELETE
/v1/apps/{app_id}/branches/{app_branch_id}
delete an app branch
GET
/v1/apps/{app_id}/branches/{app_branch_id}
get an app branch
PATCH
/v1/apps/{app_id}/branches/{app_branch_id}
update app branch metadata
GET
/v1/apps/{app_id}/branches/{app_branch_id}/configs
get app branch app configs
POST
/v1/apps/{app_id}/branches/{app_branch_id}/configs
create an app branch config
GET
/v1/apps/{app_id}/branches/{app_branch_id}/latest-config
get latest app branch config
GET
/v1/apps/{app_id}/branches/{app_branch_id}/runs
get app branch workflow runs
POST
/v1/apps/{app_id}/branches/{app_branch_id}/runs
trigger app branch workflow run
GET
/v1/apps/{app_id}/branches/{app_branch_id}/runs/{run_id}/builds
get builds for an app branch run
GET
/v1/apps/{app_id}/branches/{app_branch_id}/runs/{run_id}/install-group-runs
list install group runs for an app branch run
GET
/v1/apps/{app_id}/branches/{app_branch_id}/runs/{run_id}/install-group-runs/{install_group_run_id}
get a specific install group run
GET
/v1/apps/{app_id}/branches/{app_branch_id}/runs/{run_id}/install-groups
get install group deployments for an app branch run
POST
/v1/apps/{app_id}/break-glass-configs
Create a break glass config for an app.
GET
/v1/apps/{app_id}/break-glass-configs/{config_id}
get app breakglass config
POST
/v1/apps/{app_id}/configdeprecated
Create an app config, by pushing the contents of a config file. The API will automatically configure the app according to the config file in the background.
GET
/v1/apps/{app_id}/config/{app_config_id}deprecated
get an app config
PATCH
/v1/apps/{app_id}/config/{app_config_id}deprecated
Update an app config, setting status and state.
GET
/v1/apps/{app_id}/config/{app_config_id}/graphdeprecated
get an app config graph
POST
/v1/apps/{app_id}/config/{app_config_id}/update-installsdeprecated
Update app configuration across multiple installs.
GET
/v1/apps/{app_id}/configs
get app configs
POST
/v1/apps/{app_id}/configs
Create an app config, by pushing the contents of a config file. The API will automatically configure the app according to the config file in the background.
GET
/v1/apps/{app_id}/configs/{config_id}
get an app config
PATCH
/v1/apps/{app_id}/configs/{config_id}
Update an app config, setting status and state.
POST
/v1/apps/{app_id}/configs/{config_id}/build
Build all components for an app config
GET
/v1/apps/{app_id}/configs/{config_id}/diff
diff two app configs
GET
/v1/apps/{app_id}/configs/{config_id}/graph
get an app config graph
POST
/v1/apps/{app_id}/configs/{config_id}/update-installs
Update app configuration across multiple installs.
POST
/v1/apps/{app_id}/input-config
App input configs allow you to declare the inputs for your application, and do things such as require customer inputs or expose configuration knobs in your application.
GET
/v1/apps/{app_id}/input-configs
get app input configs
GET
/v1/apps/{app_id}/input-configs/{input_config_id}
get app input config
GET
/v1/apps/{app_id}/input-latest-config
get latest app input config
POST
/v1/apps/{app_id}/kubernetes-contexts-configs
create a kubernetes contexts config
GET
/v1/apps/{app_id}/labels
get all labels used across an app
GET
/v1/apps/{app_id}/latest-break-glass-config
get latest app break glass config
GET
/v1/apps/{app_id}/latest-config
get latest app config
GET
/v1/apps/{app_id}/latest-permissions-config
get latest app permissions config
GET
/v1/apps/{app_id}/latest-policies-config
get latest app policies config
GET
/v1/apps/{app_id}/latest-secrets-config
get latest app secrets config
POST
/v1/apps/{app_id}/operation-role-configs
create operation role config
GET
/v1/apps/{app_id}/operation-role-configs/{operation_role_config_id}
get operation role configs
POST
/v1/apps/{app_id}/permissions-configs
Create app permissions config.
GET
/v1/apps/{app_id}/permissions-configs/{config_id}
get app permissions config
GET
/v1/apps/{app_id}/policies-configs
get app policies configs
POST
/v1/apps/{app_id}/policies-configs
Create app policies config.
GET
/v1/apps/{app_id}/policies-configs/{config_id}
get app policies config
GET
/v1/apps/{app_id}/policy-config/{policy_config_id}
get app policy config
GET
/v1/apps/{app_id}/runner-configs
get app runner configs
POST
/v1/apps/{app_id}/runner-configs
create an app runner config
GET
/v1/apps/{app_id}/runner-latest-config
get latest app runner config
POST
/v1/apps/{app_id}/sandbox-configdeprecated
create an app sandbox config
GET
/v1/apps/{app_id}/sandbox-configs
get app sandbox configs
POST
/v1/apps/{app_id}/sandbox-configs
create an app sandbox config
GET
/v1/apps/{app_id}/sandbox-latest-config
get latest app sandbox config
GET
/v1/apps/{app_id}/sandbox/builds
get app sandbox builds
POST
/v1/apps/{app_id}/sandbox/builds
create app sandbox build
GET
/v1/apps/{app_id}/sandbox/builds/{build_id}
get app sandbox build
POST
/v1/apps/{app_id}/secretdeprecated
create an app secret
DELETE
/v1/apps/{app_id}/secret/{secret_id}deprecated
delete an app secret
GET
/v1/apps/{app_id}/secrets
get app secrets
POST
/v1/apps/{app_id}/secrets
create an app secret
POST
/v1/apps/{app_id}/secrets-configs
Create an app secrets config.
GET
/v1/apps/{app_id}/secrets-configs/{config_id}
get app secrets config
DELETE
/v1/apps/{app_id}/secrets/{secret_id}
delete an app secret
POST
/v1/apps/{app_id}/stack-configs
create an app stack config
GET
/v1/apps/{app_id}/stack-configs/{config_id}
get app stack config
GET
/v1/apps/{app_id}/template-config
get an app config template
Schemas 261
The contract defines 261 schemas that model the data the API accepts and returns. The most detailed are app.WorkflowStep (36 properties), app.RunnerGroupSettings (35 properties), app.RunnerJob (33 properties), app.AppConfig (33 properties). Each schema is shown below with its type and property counts.
app.AppConfigStatus
string
configs.OCIRegistryType
string
plantypes.OCIArtifactReference
object
3 properties
app.AppInputGroup
object
11 properties
plantypes.BuildPlan
object
12 properties
2 required
compositeerrors.Section
object
3 properties
github_com_nuonco_nuon_pkg_labels.Labels
object
app.DockerBuildComponentConfig
object
11 properties
app.CompositeStatus
object
6 properties
service.CreateAppPoliciesConfigRequest
object
2 properties
1 required
app.ConnectedGithubVCSConfig
object
14 properties
state.RunnerState
object
4 properties
plantypes.SyncOCIPlan
object
5 properties
4 required
app.Queue
object
16 properties
app.OCIArtifact
object
20 properties
app.AppRunnerConfig
object
15 properties
plantypes.DeployPlan
object
16 properties
2 required
service.UpdateAppConfigRequest
object
4 properties
app.ComponentRelease
object
9 properties
app.Account
object
10 properties
app.PolicyResult
object
7 properties
plantypes.TerraformLocalArchive
object
1 property
app.AppBranchInstallGroup
object
12 properties
app.ComponentType
string
plantypes.HelmValue
object
3 properties
app.AppSecretConfig
object
21 properties
app.AdHocStepConfig
object
16 properties
app.RunnerJobType
string
plantypes.DockerBuildPlan
object
4 properties
state.AWSCloudAccount
object
1 property
plantypes.PulumiBackend
object
6 properties
3 required
compositeerrors.SectionKind
string
app.WorkflowStepPolicyValidation
object
8 properties
service.AppKubernetesContext
object
2 properties
2 required
state.SandboxState
object
6 properties
app.SandboxRunType
string
service.CreateAppRunnerConfigRequest
object
8 properties
1 required
service.CreateAppBranchRequest
object
2 properties
1 required
app.InstallActionWorkflowRun
object
29 properties
app.InstallActionWorkflowRunStepStatus
string
app.AppOperationRoleRule
object
11 properties
app.ActionWorkflowConfig
object
17 properties
plantypes.HelmDeployPlan
object
14 properties
helpers.ConnectedGithubVCSConfigRequest
object
5 properties
2 required
app.AppRunnerType
string
plantypes.TerraformBuildPlan
object
3 properties
app.Runner
object
18 properties
config.HelmRepoConfig
object
3 properties
app.AWSECRImageConfig
object
8 properties
refs.Ref
object
4 properties
plantypes.NoopDeployPlan
object
blobstore.Blob
object
app.ComponentConfigConnection
object
32 properties
service.CreateAppBranchConfigRequest
object
3 properties
app.KubernetesManifestComponentConfig
object
10 properties
app.TerraformModuleComponentConfig
object
11 properties
state.SecretsState
object
plantypes.FetchImageMetadataPlan
object
6 properties
2 required
app.RunnerJobExecutionOutputs
object
8 properties
credentials.AssumeRoleConfig
object
6 properties
2 required
app.RunnerJobExecutionResult
object
14 properties
app.PolicyName
string
plantypes.HelmSandboxMode
object
2 properties
app.HelmRepoConfig
object
3 properties
service.CreateAppSecretRequest
object
2 properties
2 required
app.AppSecret
object
8 properties
app.AppInputConfig
object
10 properties
state.AzureCloudAccount
object
1 property
app.RunnerJob
object
33 properties
state.ActionWorkflowState
object
4 properties
app.AppBranchRunType
string
app.RunnerJobExecutionStatus
string
app.PolicyReport
object
24 properties
service.AppLabelsResponse
object
3 properties
plantypes.KubernetesSecretSyncTarget
object
3 properties
plantypes.PulumiBuildPlan
object
1 property
app.RoleType
string
plantypes.KubernetesManifestBuildPlan
object
5 properties
state.InstallState
object
7 properties
config.AppPolicyEngine
string
app.VCSConnection
object
10 properties
app.PolicyViolation
object
6 properties
app.QueueEmitterMode
string
app.WorkflowStepApprovalType
string
service.AppGroupRequest
object
3 properties
3 required
service.CreateAppInputConfigRequest
object
3 properties
2 required
app.InstallDeployType
string
app.WorkflowStepApproval
object
14 properties
config.CustomNestedStack
object
7 properties
app.Workflow
object
30 properties
app.PulumiComponentConfig
object
11 properties
plantypes.KubernetesSandboxMode
object
2 properties
app.WorkflowRun
object
11 properties
app.AppPoliciesConfig
object
8 properties
cctx.SignalContext
object
4 properties
github_com_nuonco_nuon_pkg_aws_credentials.Config
object
6 properties
compositeerrors.Severity
string
plantypes.CompositePlan
object
7 properties
app.AppStackConfig
object
13 properties
app.JobComponentConfig
object
10 properties
app.AppConfigVersion
string
app.AppKubernetesContextsConfig
object
8 properties
sql.NullBool
object
2 properties
plantypes.TerraformBackend
object
1 property
1 required
configs.OCIRegistryAuth
object
2 properties
compositeerrors.CompositeErrorData
object
9 properties
service.CreateAppRequest
object
4 properties
1 required
app.AppSandboxBuild
object
15 properties
app.WorkflowType
string
credentials.StaticCredentials
object
3 properties
3 required
plantypes.OCISource
object
2 properties
app.AppAWSIAMRoleConfig
object
18 properties
diff.Diff
object
3 properties
diff.DiffKey
object
4 properties
app.AppSandboxConfig
object
26 properties
signaldb.WorkflowRef
object
3 properties
app.ExternalImageComponentConfig
object
11 properties
plantypes.SyncSecretsPlan
object
6 properties
stderr.ErrResponse
object
3 properties
app.InstallDeploy
object
32 properties
app.WorkflowStepExecutionType
string
service.AppAWSIAMRoleConfig
object
7 properties
3 required
helpers.PublicGitVCSConfigRequest
object
4 properties
3 required
app.RunnerGroup
object
11 properties
app.RunnerJobPlan
object
8 properties
diff.DiffSummary
object
5 properties
plantypes.KubernetesManifestDeployPlan
object
8 properties
state.ActionsState
object
2 properties
service.AppPolicyConfig
object
6 properties
2 required
iam.StaticCredentials
object
3 properties
service.CreateAppPermissionsConfigRequest
object
6 properties
4 required
service.CreateAppKubernetesContextsConfigRequest
object
2 properties
1 required
app.RunnerJobExecution
object
11 properties
app.RunnerGroupType
string
app.App
object
25 properties
signaldb.SignalData
object
1 property
service.CreateAppConfigRequest
object
6 properties
github_com_nuonco_nuon_pkg_gcp_credentials.Config
object
3 properties
service.UpdateAppConfigInstallsRequest
object
2 properties
service.AppConfigDiffResponse
object
5 properties
service.AppConfigTemplateType
string
app.PolicyInputRef
object
3 properties
permissions.Permission
string
app.EmptyResponse
object
app.QueueSignal
object
20 properties
app.AppRunnerConfigHelmDriverType
string
service.CreateAppOperationRoleConfigRequest
object
2 properties
2 required
permissions.Set
object
app.Component
object
17 properties
app.WorkflowStepGroup
object
14 properties
plantypes.ContainerImagePullPlan
object
5 properties
app.AppBreakGlassConfig
object
8 properties
credentials.ServicePrincipalCredentials
object
2 properties
state.OrgState
object
4 properties
plantypes.HelmBuildPlan
object
4 properties
app.InstallAppConfigVersion
object
15 properties
plantypes.GitSource
object
4 properties
3 required
app.Status
string
iam.TwoStepConfig
object
3 properties
app.InstallGroupRunInstall
object
3 properties
app.AppInput
object
20 properties
app.AccountType
string
service.OperationRoleRuleRequest
object
3 properties
3 required
plantypes.TerraformDeployHooks
object
3 properties
app.ActionWorkflowTriggerType
string
app.RunnerOperation
object
10 properties
app.WorkflowRunType
string
app.WorkflowStep
object
36 properties
app.AppPolicyConfig
object
14 properties
app.AzureACRImageConfig
object
9 properties
callback.Ref
object
3 properties
app.ActionWorkflow
object
12 properties
service.InstallGroupRequest
object
5 properties
1 required
service.UpdateAppBranchRequest
object
1 property
1 required
app.InstallActionWorkflowRunStep
object
10 properties
kube.ClusterInfo
object
10 properties
app.AppBranchRun
object
31 properties
app.AppInputSource
string
plantypes.TerraformDeployPlan
object
12 properties
app.PolicyReportOwnerType
string
app.UserJourney
object
3 properties
service.TriggerAppBranchRunRequest
object
5 properties
app.InstallRoleUsage
object
13 properties
app.LogStream
object
11 properties
app.ComponentBuild
object
31 properties
app.InstallRoleSelectionRecord
object
5 properties
app.AppSecretsConfig
object
8 properties
app.UserJourneyStep
object
7 properties
app.OperationType
string
service.KubernetesSyncTarget
object
3 properties
3 required
app.CloudPlatform
string
service.CreateAppSecretsConfigRequest
object
2 properties
1 required
app.VCSConnectionCommit
object
11 properties
github_com_nuonco_nuon_pkg_azure_credentials.Config
object
3 properties
app.QueueEmitter
object
21 properties
app.ActionWorkflowStepConfig
object
16 properties
app.ComponentReleaseStep
object
10 properties
app.InstallInputs
object
10 properties
plantypes.PulumiSandboxMode
object
3 properties
plantypes.KubernetesSecretSync
object
9 properties
app.KustomizeConfig
object
4 properties
app.HelmConfig
object
8 properties
state.AppState
object
5 properties
outputs.SecretSyncOutput
object
10 properties
app.Role
object
7 properties
app.InstallApprovalOption
string
app.InstallSandboxRun
object
24 properties
service.CreateAppSandboxConfigRequest
object
17 properties
2 required
types.StringBoolMap
object
app.AppOperationRoleConfig
object
8 properties
app.AWSIAMRoleType
string
app.AppConfig
object
33 properties
plantypes.SandboxRunPlan
object
21 properties
github_com_nuonco_nuon_pkg_types_state.State
object
16 properties
app.InstallGroupRun
object
16 properties
service.CreateAppBreakGlassConfigRequest
object
2 properties
2 required
service.AppSecretConfig
object
11 properties
3 required
service.AppInputRequest
object
9 properties
4 required
service.AppLabelKeySummary
object
7 properties
app.Policy
object
7 properties
app.AppPermissionsConfig
object
13 properties
plantypes.KustomizeBuildConfig
object
3 properties
state.GCPCloudAccount
object
2 properties
compositeerrors.Hints
object
app.RunnerJobOperationType
string
state.CloudAccount
object
3 properties
app.PublicGitVCSConfig
object
10 properties
state.InputsState
object
2 properties
plantypes.ActionWorkflowRunPlan
object
12 properties
app.NotificationsConfig
object
8 properties
app.AppKubernetesContextConfig
object
11 properties
plantypes.ActionWorkflowRunStepPlan
object
6 properties
github_com_nuonco_nuon_pkg_labels.Selector
object
2 properties
plantypes.PulumiDeployPlan
object
14 properties
service.AppAWSIAMPolicyConfig
object
7 properties
app.StackType
string
app.ActionWorkflowTriggerConfig
object
12 properties
configs.OCIRegistryRepository
object
10 properties
diff.Op
string
app.RunnerOperationType
string
plantypes.SandboxMode
object
6 properties
app.RunnerJobStatus
string
app.Org
object
19 properties
service.AppConfigTemplate
object
4 properties
plantypes.TerraformSandboxMode
object
4 properties
state.InstallStackState
object
7 properties
app.AppAWSIAMPolicyConfig
object
15 properties
app.AppBranch
object
12 properties
app.AppSecretKubernetesSyncTarget
object
9 properties
app.HelmComponentConfig
object
15 properties
app.InstallActionWorkflow
object
9 properties
app.RunnerJobGroup
string
service.CreateAppStackConfigRequest
object
7 properties
4 required
state.DomainState
object
3 properties
config.CustomNestedStackStatus
string
app.RunnerGroupSettings
object
35 properties
config.AppPolicyType
string
app.GCPGARImageConfig
object
10 properties
refs.RefType
string
service.UpdateAppRequest
object
7 properties
app.AppBranchConfig
object
13 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nuon 12
Other APIs Nuon publishes across the network.
Nuon accounts API
Nuon actions API
Nuon actions/runner API
Nuon auth API
Nuon components API
Nuon general API
Nuon installs API
Nuon notebooks API
Nuon onboarding API
Nuon orgs API
Nuon policy-reports API
Nuon queues API
#apps