Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nuon

Nuon components API

components

Documentation Provider Profile APIs.io OpenAPI GitHub

Nuon components API is one of 18 APIs that Nuon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include components. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 47 operations across 41 paths, and defines 192 schemas. It is described by OpenAPI 2.0, at version 0.19.1074.

Requests are made against the base URL https://api.nuon.co.

47 operations 41 paths 192 schemas 3 DELETE22 GET2 PATCH20 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.19.1074
Base URL
https://api.nuon.co
Authentication
API Key, API Key
Contact
Nuon Support
Resource Areas
1

Authentication & Security 2

Nuon components 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 47

Across 41 paths, the API surfaces 47 operations — 3 DELETE, 22 GET, 2 PATCH, 20 POST. Each is listed below with its method, path, parameters, and response codes.

components 47

components

GET
/v1/apps/{app_id}/component/{component_name_or_id}
get a components for a specific app
GetAppComponent 2 params → 200400401403404500
GET
/v1/apps/{app_id}/components
get all components for an app
GetAppComponents 8 params → 200400401403404500
POST
/v1/apps/{app_id}/components
create a component
CreateComponent 2 params → 201400401403404409500
POST
/v1/apps/{app_id}/components/build-all
create component build
BuildAllComponents 2 params → 201400401403404500
GET
/v1/apps/{app_id}/components/label-keys
get distinct label key:value pairs across all components for an app
GetComponentLabelKeys 1 param → 200
DELETE
/v1/apps/{app_id}/components/{component_id}
delete a component
DeleteAppComponent 2 params → 200400401403404500
PATCH
/v1/apps/{app_id}/components/{component_id}
update a component
UpdateAppComponent 3 params → 200400401403404500
GET
/v1/apps/{app_id}/components/{component_id}/builds
get builds for components
GetAppComponentBuilds 5 params → 200400401403404500
POST
/v1/apps/{app_id}/components/{component_id}/builds
create component build
CreateAppComponentBuild 3 params → 201400401403404409500
GET
/v1/apps/{app_id}/components/{component_id}/builds/latest
get latest build for a component
GetAppComponentLatestBuild 2 params → 200400401403404500
GET
/v1/apps/{app_id}/components/{component_id}/builds/{build_id}
get a build for a component
GetAppComponentBuild 3 params → 200400401403404500
POST
/v1/apps/{app_id}/components/{component_id}/builds/{build_id}/cancel
cancel component build
CancelAppComponentBuild 3 params → 202400401403404500
GET
/v1/apps/{app_id}/components/{component_id}/configs
get all configs for a component
GetAppComponentConfigs 5 params → 200400401403404500
POST
/v1/apps/{app_id}/components/{component_id}/configs/docker-build
create a docker build component config
CreateAppDockerBuildComponentConfig 3 params → 201400401403404409500
POST
/v1/apps/{app_id}/components/{component_id}/configs/external-image
create an external image component config
CreateAppExternalImageComponentConfig 3 params → 201400401403404409500
POST
/v1/apps/{app_id}/components/{component_id}/configs/helm
create a helm component config
CreateAppHelmComponentConfig 3 params → 201400401403404409500
POST
/v1/apps/{app_id}/components/{component_id}/configs/job
create a job component config
CreateAppJobComponentConfig 3 params → 201400401403404409500
POST
/v1/apps/{app_id}/components/{component_id}/configs/kubernetes-manifest
create a kubernetes manifest component config
CreateAppKubernetesManifestComponentConfig 3 params → 201400401403404409500
GET
/v1/apps/{app_id}/components/{component_id}/configs/latest
get latest config for a component
GetAppComponentLatestConfig 2 params → 200400401403404500
POST
/v1/apps/{app_id}/components/{component_id}/configs/pulumi
create a pulumi component config
CreateAppPulumiComponentConfig 3 params → 201400401403404409500
POST
/v1/apps/{app_id}/components/{component_id}/configs/terraform-module
create a terraform component config
CreateAppTerraformModuleComponentConfig 3 params → 201400401403404409500
GET
/v1/apps/{app_id}/components/{component_id}/configs/{config_id}
get a config for a component
GetAppComponentConfig 3 params → 200400401403404500
GET
/v1/apps/{app_id}/components/{component_id}/dependenciesdeprecated
get a component's dependencies
GetAppComponentDependencies 2 params → 200400401403404500
GET
/v1/apps/{app_id}/components/{component_id}/dependents
get a component's children
GetAppComponentDependents 2 params → 200400401403404500
DELETE
/v1/apps/{app_id}/components/{component_id}/labels
remove labels from a component
RemoveAppComponentLabels 3 params → 200400401403404500
POST
/v1/apps/{app_id}/components/{component_id}/labels
add labels to a component
AddAppComponentLabels 3 params → 200400401403404500
GET
/v1/buildsdeprecated
get builds for components
GetComponentBuilds 5 params → 200400401403404500
GET
/v1/components
get all components for an org
GetOrgComponents 4 params → 200400401403404500
GET
/v1/components/builds/{build_id}deprecated
get a build
GetBuild 1 param → 200400401403404500
DELETE
/v1/components/{component_id}deprecated
delete a component
DeleteComponent 1 param → 200400401403404500
GET
/v1/components/{component_id}deprecated
get a component
GetComponent 1 param → 200400401403404500
PATCH
/v1/components/{component_id}deprecated
update a component
UpdateComponent 2 params → 200400401403404500
POST
/v1/components/{component_id}/buildsdeprecated
create component build
CreateComponentBuild 2 params → 201400401403404409500
GET
/v1/components/{component_id}/builds/latestdeprecated
get latest build for a component
GetComponentLatestBuild 1 param → 200400401403404500
GET
/v1/components/{component_id}/builds/{build_id}deprecated
get a build for a component
GetComponentBuild 2 params → 200400401403404500
GET
/v1/components/{component_id}/configsdeprecated
get all configs for a component
GetComponentConfigs 4 params → 200400401403404500
POST
/v1/components/{component_id}/configs/docker-builddeprecated
create a docker build component config
CreateDockerBuildComponentConfig 2 params → 201400401403404409500
POST
/v1/components/{component_id}/configs/external-imagedeprecated
create an external image component config
CreateExternalImageComponentConfig 2 params → 201400401403404409500
POST
/v1/components/{component_id}/configs/helmdeprecated
create a helm component config
CreateHelmComponentConfig 2 params → 201400401403404409500
POST
/v1/components/{component_id}/configs/jobdeprecated
create a job component config
CreateJobComponentConfig 2 params → 201400401403404409500
POST
/v1/components/{component_id}/configs/kubernetes-manifestdeprecated
create a kubernetes manifest component config
CreateKubernetesManifestComponentConfig 2 params → 201400401403404409500
GET
/v1/components/{component_id}/configs/latestdeprecated
get latest config for a component
GetComponentLatestConfig 1 param → 200400401403404500
POST
/v1/components/{component_id}/configs/pulumideprecated
create a pulumi component config
CreatePulumiComponentConfig 2 params → 201400401403404409500
POST
/v1/components/{component_id}/configs/terraform-moduledeprecated
create a terraform component config
CreateTerraformModuleComponentConfig 2 params → 201400401403404409500
GET
/v1/components/{component_id}/configs/{config_id}deprecated
get a config for a component
GetComponentConfig 2 params → 200400401403404500
GET
/v1/components/{component_id}/dependenciesdeprecated
get a component's dependencies
GetComponentDependencies 1 param → 200400401403404500
GET
/v1/components/{component_id}/dependents
get a component's children
GetComponentDependents 1 param → 200400401403404500

Schemas 192

The contract defines 192 schemas that model the data the API accepts and returns. The most detailed are app.WorkflowStep (36 properties), app.RunnerJob (33 properties), app.InstallDeploy (32 properties), app.ComponentConfigConnection (32 properties). Each schema is shown below with its type and property counts.

configs.OCIRegistryType
string
plantypes.OCIArtifactReference
object
3 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
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
plantypes.DeployPlan
object
16 properties 2 required
app.ComponentRelease
object
9 properties
app.Account
object
10 properties
app.PolicyResult
object
7 properties
plantypes.TerraformLocalArchive
object
1 property
service.CreateComponentRequest
object
4 properties 1 required
app.AppBranchInstallGroup
object
12 properties
app.ComponentType
string
plantypes.HelmValue
object
3 properties
app.AdHocStepConfig
object
16 properties
app.RunnerJobType
string
service.gcpGARImageConfigRequest
object
6 properties
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
state.SandboxState
object
6 properties
service.CreateKubernetesManifestComponentConfigRequest
object
19 properties
app.SandboxRunType
string
service.ComponentChildren
object
1 property
app.InstallActionWorkflowRun
object
29 properties
app.InstallActionWorkflowRunStepStatus
string
app.ActionWorkflowConfig
object
17 properties
service.KustomizeConfigRequest
object
4 properties
plantypes.HelmDeployPlan
object
14 properties
plantypes.TerraformBuildPlan
object
3 properties
config.HelmRepoConfig
object
3 properties
app.AWSECRImageConfig
object
8 properties
refs.Ref
object
4 properties
plantypes.NoopDeployPlan
object
app.ComponentConfigConnection
object
32 properties
app.KubernetesManifestComponentConfig
object
10 properties
app.TerraformModuleComponentConfig
object
11 properties
service.CreateDockerBuildComponentConfigRequest
object
18 properties 1 required
state.SecretsState
object
app.RunnerJobExecutionResult
object
14 properties
app.RunnerJobExecutionOutputs
object
8 properties
app.PolicyName
string
credentials.AssumeRoleConfig
object
6 properties 2 required
plantypes.HelmSandboxMode
object
2 properties
plantypes.FetchImageMetadataPlan
object
6 properties 2 required
app.HelmRepoConfig
object
3 properties
service.CreateComponentBuildRequest
object
2 properties
service.HelmRepoConfigRequest
object
3 properties 2 required
app.AppBranchRunType
string
app.RunnerJob
object
33 properties
state.ActionWorkflowState
object
4 properties
state.AzureCloudAccount
object
1 property
app.RunnerJobExecutionStatus
string
app.PolicyReport
object
24 properties
plantypes.KubernetesSecretSyncTarget
object
3 properties
plantypes.PulumiBuildPlan
object
1 property
app.RoleType
string
plantypes.KubernetesManifestBuildPlan
object
5 properties
state.InstallState
object
7 properties
app.VCSConnection
object
10 properties
app.PolicyViolation
object
6 properties
app.QueueEmitterMode
string
app.WorkflowStepApprovalType
string
app.InstallDeployType
string
app.WorkflowStepApproval
object
14 properties
app.Workflow
object
30 properties
app.PulumiComponentConfig
object
11 properties
plantypes.KubernetesSandboxMode
object
2 properties
app.WorkflowRun
object
11 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
service.CreateJobComponentConfigRequest
object
16 properties 2 required
service.CreateHelmComponentConfigRequest
object
24 properties 2 required
app.JobComponentConfig
object
10 properties
sql.NullBool
object
2 properties
compositeerrors.CompositeErrorData
object
9 properties
configs.OCIRegistryAuth
object
2 properties
plantypes.TerraformBackend
object
1 property 1 required
app.WorkflowType
string
service.PublicGitVCSConfigRequest
object
3 properties 3 required
credentials.StaticCredentials
object
3 properties 3 required
plantypes.OCISource
object
2 properties
service.awsECRImageConfigRequest
object
2 properties
app.AppSandboxConfig
object
26 properties
signaldb.WorkflowRef
object
3 properties
app.ExternalImageComponentConfig
object
11 properties
stderr.ErrResponse
object
3 properties
plantypes.SyncSecretsPlan
object
6 properties
app.InstallDeploy
object
32 properties
app.WorkflowStepExecutionType
string
service.RemoveComponentLabelsRequest
object
1 property 1 required
app.RunnerJobPlan
object
8 properties
plantypes.KubernetesManifestDeployPlan
object
8 properties
state.ActionsState
object
2 properties
iam.StaticCredentials
object
3 properties
app.RunnerJobExecution
object
11 properties
signaldb.SignalData
object
1 property
github_com_nuonco_nuon_pkg_gcp_credentials.Config
object
3 properties
app.PolicyInputRef
object
3 properties
permissions.Permission
string
app.EmptyResponse
object
app.QueueSignal
object
20 properties
permissions.Set
object
app.Component
object
17 properties
app.WorkflowStepGroup
object
14 properties
plantypes.ContainerImagePullPlan
object
5 properties
credentials.ServicePrincipalCredentials
object
2 properties
state.OrgState
object
4 properties
plantypes.HelmBuildPlan
object
4 properties
plantypes.GitSource
object
4 properties 3 required
app.Status
string
iam.TwoStepConfig
object
3 properties
app.AccountType
string
service.CreatePulumiComponentConfigRequest
object
20 properties 3 required
plantypes.TerraformDeployHooks
object
3 properties
app.ActionWorkflowTriggerType
string
app.WorkflowRunType
string
app.WorkflowStep
object
36 properties
app.AzureACRImageConfig
object
9 properties
callback.Ref
object
3 properties
app.ActionWorkflow
object
12 properties
app.InstallActionWorkflowRunStep
object
10 properties
app.AppBranchRun
object
31 properties
kube.ClusterInfo
object
10 properties
plantypes.TerraformDeployPlan
object
12 properties
app.PolicyReportOwnerType
string
app.UserJourney
object
3 properties
app.InstallRoleUsage
object
13 properties
app.LogStream
object
11 properties
app.ComponentBuild
object
31 properties
app.InstallRoleSelectionRecord
object
5 properties
app.UserJourneyStep
object
7 properties
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
plantypes.PulumiSandboxMode
object
3 properties
app.KustomizeConfig
object
4 properties
plantypes.KubernetesSecretSync
object
9 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.BuildAllComponentsRequest
object
service.CreateExternalImageComponentConfigRequest
object
18 properties 1 required
service.ConnectedGithubVCSConfigRequest
object
4 properties 2 required
plantypes.SandboxRunPlan
object
21 properties
github_com_nuonco_nuon_pkg_types_state.State
object
16 properties
app.Policy
object
7 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
plantypes.ActionWorkflowRunStepPlan
object
6 properties
github_com_nuonco_nuon_pkg_labels.Selector
object
2 properties
plantypes.PulumiDeployPlan
object
14 properties
service.AddComponentLabelsRequest
object
1 property 1 required
app.ActionWorkflowTriggerConfig
object
12 properties
configs.OCIRegistryRepository
object
10 properties
plantypes.SandboxMode
object
6 properties
app.RunnerJobStatus
string
service.CreateTerraformModuleComponentConfigRequest
object
20 properties 2 required
plantypes.TerraformSandboxMode
object
4 properties
state.InstallStackState
object
7 properties
app.AppBranch
object
12 properties
service.azureACRImageConfigRequest
object
3 properties
app.InstallActionWorkflow
object
9 properties
app.HelmComponentConfig
object
15 properties
app.RunnerJobGroup
string
service.UpdateComponentRequest
object
4 properties 1 required
state.DomainState
object
3 properties
app.GCPGARImageConfig
object
10 properties
refs.RefType
string
app.AppBranchConfig
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuon-components-api-openapi.yml Raw ↑

Other APIs Nuon publishes across the network.

Nuon accounts API
AE Profile APIs.io
Nuon actions API
AE Profile APIs.io
Nuon actions/runner API
AE Profile APIs.io
Nuon apps API
AE Profile APIs.io
Nuon auth API
AE Profile APIs.io
Nuon general API
AE Profile APIs.io
Nuon installs API
AE Profile APIs.io
Nuon notebooks API
AE Profile APIs.io
Nuon onboarding API
AE Profile APIs.io
Nuon orgs API
AE Profile APIs.io
Nuon policy-reports API
AE Profile APIs.io
Nuon queues API
AE Profile APIs.io
#components
← Back to N APIs
API Details
ID
nuon:nuon-components-api
Base URL
https://api.nuon.co
Docs
https://docs.nuon.co/nuon-api
Provider
Nuon
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network