Nuon installs API is one of 18 APIs that Nuon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include installs. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 97 operations across 86 paths, and defines 270 schemas. It is described by OpenAPI 2.0, at version 0.19.1074.
Requests are made against the base URL https://api.nuon.co.
97 operations
86 paths
270 schemas
2 DELETE60 GET6 PATCH29 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Nuon installs 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 97
Across 86 paths, the API surfaces 97 operations — 2 DELETE, 60 GET, 6 PATCH, 29 POST. Each is listed below with its method, path, parameters, and response codes.
installs 97
installs
GET
/v1/apps/{app_id}/installs
get all installs for an app
POST
/v1/apps/{app_id}/installsdeprecated
create an app install
GET
/v1/install-workflows/{install_workflow_id}deprecated
get an install workflow
PATCH
/v1/install-workflows/{install_workflow_id}deprecated
update an install workflow
POST
/v1/install-workflows/{install_workflow_id}/canceldeprecated
cancel an ongoing install workflow
GET
/v1/install-workflows/{install_workflow_id}/stepsdeprecated
get all of the steps for a given install workflow
GET
/v1/install-workflows/{install_workflow_id}/steps/{install_workflow_step_id}deprecated
get an install workflow step
GET
/v1/install-workflows/{install_workflow_id}/steps/{install_workflow_step_id}/approvals/{approval_id}deprecated
get an install workflow step approval
GET
/v1/installs
get all installs for an org
POST
/v1/installs
create an app install
GET
/v1/installs/label-keys
get distinct label key:value pairs across all installs for an org
GET
/v1/installs/sandbox-runs/{run_id}deprecated
get an install sandbox run
GET
/v1/installs/stacks/{stack_id}
get an install stack by stack ID
DELETE
/v1/installs/{install_id}
delete an install
GET
/v1/installs/{install_id}
get an install
PATCH
/v1/installs/{install_id}
update an install
GET
/v1/installs/{install_id}/action-workflowsdeprecated
get an installs action workflows
GET
/v1/installs/{install_id}/action-workflows/{action_workflow_id}deprecated
get an install action workflow
GET
/v1/installs/{install_id}/actions
get an installs action workflows
GET
/v1/installs/{install_id}/actions/{action_id}
get an install action
GET
/v1/installs/{install_id}/actions/{action_id}/outputs
get an install action workflow outputs
POST
/v1/installs/{install_id}/app-config-updates
trigger an app config update for an install
GET
/v1/installs/{install_id}/app-config-versions
get app config versions for an install
GET
/v1/installs/{install_id}/app-config-versions/{version_id}/diff
get the diff for an install app config version
GET
/v1/installs/{install_id}/app-permissions-config
get app permissions config for an install with provisioning status
GET
/v1/installs/{install_id}/audit_logs
get install audit logs
GET
/v1/installs/{install_id}/available-roles
get available IAM roles for a specific operation
GET
/v1/installs/{install_id}/components
get an installs components
POST
/v1/installs/{install_id}/components/deploy-all
deploy all components on an install
GET
/v1/installs/{install_id}/components/deploysdeprecated
get all deploys to an install
POST
/v1/installs/{install_id}/components/teardown-all
teardown an install's components
GET
/v1/installs/{install_id}/components/{component_id}
get an install component
GET
/v1/installs/{install_id}/components/{component_id}/deploys
get an install components deploys
POST
/v1/installs/{install_id}/components/{component_id}/deploys
deploy a build to an install
GET
/v1/installs/{install_id}/components/{component_id}/deploys/latest
get the latest deploy for an install component
GET
/v1/installs/{install_id}/components/{component_id}/deploys/{deploy_id}deprecated
get an install deploy
POST
/v1/installs/{install_id}/components/{component_id}/forget
forget an install component
GET
/v1/installs/{install_id}/components/{component_id}/outputs
get an install component outputs
POST
/v1/installs/{install_id}/components/{component_id}/teardown
teardown an install component
POST
/v1/installs/{install_id}/components/{component_id}/toggle
toggle an install component on or off
POST
/v1/installs/{install_id}/configs
create an install config
PATCH
/v1/installs/{install_id}/configs/{config_id}
update an install config
GET
/v1/installs/{install_id}/deploysdeprecated
get all deploys to an install
POST
/v1/installs/{install_id}/deploysdeprecated
deploy a build to an install
GET
/v1/installs/{install_id}/deploys/latestdeprecated
get an install's latest deploy
GET
/v1/installs/{install_id}/deploys/{deploy_id}
get an install deploy
POST
/v1/installs/{install_id}/deprovision
deprovision an install
POST
/v1/installs/{install_id}/deprovision-sandbox
deprovision an install
GET
/v1/installs/{install_id}/drifted-objects
get drifted objects for an install
GET
/v1/installs/{install_id}/events
get events for an install
GET
/v1/installs/{install_id}/events/{event_id}
get an install event
POST
/v1/installs/{install_id}/forget
forget an install
GET
/v1/installs/{install_id}/generate-cli-install-config
generate an install config to be used with CLI
GET
/v1/installs/{install_id}/generate-terraform-installer-config
generate a Terraform installer config
GET
/v1/installs/{install_id}/inputs
get an installs inputs
PATCH
/v1/installs/{install_id}/inputs
Updates install input config for app
POST
/v1/installs/{install_id}/inputs
create install inputs
GET
/v1/installs/{install_id}/inputs/current
get an installs current inputs
DELETE
/v1/installs/{install_id}/labels
remove labels from an install
POST
/v1/installs/{install_id}/labels
add labels to an install
POST
/v1/installs/{install_id}/phone-home/{phone_home_id}
phone home for an install
GET
/v1/installs/{install_id}/readme
get install readme rendered with
POST
/v1/installs/{install_id}/reprovision
reprovision an install
POST
/v1/installs/{install_id}/reprovision-sandbox
reprovision an install sandbox
POST
/v1/installs/{install_id}/retry-workflowdeprecated
rerun the workflow steps starting from input step id, can be used to retry a failed step
GET
/v1/installs/{install_id}/roles
get install roles
GET
/v1/installs/{install_id}/roles/latest
get latest install roles
GET
/v1/installs/{install_id}/roles/usages
get install role usages
PATCH
/v1/installs/{install_id}/roles/{role_id}
update an install role
POST
/v1/installs/{install_id}/runner-bootstrap-token
create a bootstrap token for an install's runner
GET
/v1/installs/{install_id}/runner-group
Get an install's runner group
GET
/v1/installs/{install_id}/sandbox-runs
get an installs sandbox runs
GET
/v1/installs/{install_id}/sandbox-runs/{run_id}
get an install sandbox run
GET
/v1/installs/{install_id}/stack
get an install stack by install ID
GET
/v1/installs/{install_id}/stack-runs
get an install's stack runs
GET
/v1/installs/{install_id}/state
Get the current state of an install.
GET
/v1/installs/{install_id}/state-history
Get install state history.
POST
/v1/installs/{install_id}/sync-secrets
sync secrets install
GET
/v1/installs/{install_id}/workflows
get workflows
GET
/v1/workflows
get all workflows for the org
POST
/v1/workflows/cancel
cancel multiple workflows
GET
/v1/workflows/pending-approvals
get all pending workflow step approvals for the org
GET
/v1/workflows/{workflow_id}
get a workflow
PATCH
/v1/workflows/{workflow_id}
update a workflow
POST
/v1/workflows/{workflow_id}/cancel
cancel an ongoing workflow
GET
/v1/workflows/{workflow_id}/queue-position
get queue position for a workflow
GET
/v1/workflows/{workflow_id}/step-groups
get all step groups for a workflow
GET
/v1/workflows/{workflow_id}/step-groups/{step_group_id}
get a workflow step group
GET
/v1/workflows/{workflow_id}/steps
get all of the steps for a given workflow
GET
/v1/workflows/{workflow_id}/steps/{step_id}
get a workflow step
GET
/v1/workflows/{workflow_id}/steps/{step_id}/approvals/{approval_id}
get an workflow step approval
GET
/v1/workflows/{workflow_id}/steps/{step_id}/approvals/{approval_id}/contents
get a workflow step approval contents
POST
/v1/workflows/{workflow_id}/steps/{step_id}/approvals/{approval_id}/response
Create an approval response for a workflow step.
GET
/v1/workflows/{workflow_id}/steps/{step_id}/await
long-poll for workflow step completion
POST
/v1/workflows/{workflow_id}/steps/{step_id}/cancel
cancel an in-progress workflow step
POST
/v1/workflows/{workflow_id}/steps/{step_id}/retry
retry a failed or awaiting-approval workflow step
POST
/v1/workflows/{workflow_id}/steps/{step_id}/skip
skip a failed workflow step and continue the workflow
Schemas 270
The contract defines 270 schemas that model the data the API accepts and returns. The most detailed are app.Install (45 properties), app.WorkflowStep (36 properties), app.RunnerGroupSettings (35 properties), app.RunnerJob (33 properties). Each schema is shown below with its type and property counts.
configs.OCIRegistryType
string
plantypes.OCIArtifactReference
object
3 properties
service.UpdateInstallRequest
object
3 properties
plantypes.BuildPlan
object
12 properties
2 required
app.DockerBuildComponentConfig
object
11 properties
github_com_nuonco_nuon_pkg_labels.Labels
object
compositeerrors.Section
object
3 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
app.AppRunnerConfig
object
15 properties
service.RetryWorkflowResponse
object
1 property
plantypes.DeployPlan
object
16 properties
2 required
app.AzureStackOutputs
object
19 properties
app.ComponentRelease
object
9 properties
service.UpdateWorkflowRequest
object
1 property
1 required
app.Account
object
10 properties
app.PolicyResult
object
7 properties
plantypes.TerraformLocalArchive
object
1 property
service.ReprovisionInstallRequest
object
2 properties
app.AppBranchInstallGroup
object
12 properties
app.ComponentType
string
plantypes.HelmValue
object
3 properties
app.AdHocStepConfig
object
16 properties
app.RunnerJobType
string
plantypes.DockerBuildPlan
object
4 properties
state.AWSCloudAccount
object
1 property
service.DeprovisionInstallSandboxRequest
object
2 properties
plantypes.PulumiBackend
object
6 properties
3 required
compositeerrors.SectionKind
string
app.WorkflowStepPolicyValidation
object
8 properties
state.SandboxState
object
6 properties
service.ForgetInstallComponentRequest
object
app.SandboxRunType
string
service.CreateInstallV2Request
object
9 properties
2 required
app.InstallActionWorkflowRun
object
29 properties
app.InstallActionWorkflowRunStepStatus
string
service.Readme
object
3 properties
app.ActionWorkflowConfig
object
17 properties
app.InstallState
object
13 properties
plantypes.HelmDeployPlan
object
14 properties
app.AppRunnerType
string
plantypes.TerraformBuildPlan
object
3 properties
app.InstallRoles
object
12 properties
app.Runner
object
18 properties
config.HelmRepoConfig
object
3 properties
service.AvailableRole
object
4 properties
app.AWSECRImageConfig
object
8 properties
refs.Ref
object
4 properties
plantypes.NoopDeployPlan
object
blobstore.Blob
object
app.ComponentConfigConnection
object
32 properties
app.KubernetesManifestComponentConfig
object
10 properties
app.TerraformModuleComponentConfig
object
11 properties
service.RemoveInstallLabelsRequest
object
1 property
1 required
state.SecretsState
object
service.DeprovisionInstallRequest
object
1 property
app.RunnerJobExecutionResult
object
14 properties
app.RunnerJobExecutionOutputs
object
8 properties
app.PolicyName
string
app.HelmRepoConfig
object
3 properties
credentials.AssumeRoleConfig
object
6 properties
2 required
plantypes.HelmSandboxMode
object
2 properties
plantypes.FetchImageMetadataPlan
object
6 properties
2 required
generics.NullTime
object
2 properties
service.UpdateInstallRoleRequest
object
1 property
1 required
app.AppBranchRunType
string
app.RunnerJob
object
33 properties
state.ActionWorkflowState
object
4 properties
state.AzureCloudAccount
object
1 property
app.InstallSandbox
object
10 properties
app.AWSAccount
object
6 properties
app.RunnerJobExecutionStatus
string
service.InstallAppPermissionsConfigResponse
object
5 properties
app.PolicyReport
object
24 properties
plantypes.KubernetesSecretSyncTarget
object
3 properties
plantypes.PulumiBuildPlan
object
1 property
app.RoleType
string
app.OperationStatus
string
service.AvailableRolesResponse
object
1 property
plantypes.KubernetesManifestBuildPlan
object
5 properties
state.InstallState
object
7 properties
service.CreateInstallAppConfigUpdateRequest
object
2 properties
1 required
app.VCSConnection
object
10 properties
app.StackVersionRunInputDiff
object
3 properties
app.PolicyViolation
object
6 properties
app.InstallComponent
object
16 properties
app.QueueEmitterMode
string
app.WorkflowStepApprovalType
string
app.InstallConfig
object
12 properties
app.GCPAccount
object
6 properties
app.WorkflowResponse
object
1 property
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
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.WorkflowStepResponseType
string
state.PartialName
string
service.CreateRunnerBootstrapTokenResponse
object
2 properties
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
app.HelmRelease
object
14 properties
credentials.StaticCredentials
object
3 properties
3 required
plantypes.OCISource
object
2 properties
app.AppAWSIAMRoleConfig
object
18 properties
app.AppSandboxConfig
object
26 properties
signaldb.WorkflowRef
object
3 properties
service.InstallPermissionsRoleStatus
object
20 properties
app.ExternalImageComponentConfig
object
11 properties
service.CancelWorkflowsRequest
object
1 property
1 required
service.SyncSecretsRequest
object
1 property
service.RetryWorkflowRequest
object
3 properties
plantypes.SyncSecretsPlan
object
6 properties
app.InstallDeploy
object
32 properties
app.WorkflowStepExecutionType
string
stderr.ErrResponse
object
3 properties
service.DeployInstallComponentsRequest
object
2 properties
app.StackVersionRunRoleDiff
object
2 properties
service.WorkflowQueuePositionResponse
object
3 properties
app.RunnerGroup
object
11 properties
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
app.RunnerGroupType
string
signaldb.SignalData
object
1 property
github_com_nuonco_nuon_pkg_gcp_credentials.Config
object
3 properties
helpers.InstallMetadata
object
1 property
service.TeardownInstallComponentsRequest
object
2 properties
app.PolicyInputRef
object
3 properties
service.CancelWorkflowError
object
2 properties
app.InstallStack
object
8 properties
permissions.Permission
string
app.EmptyResponse
object
app.QueueSignal
object
20 properties
service.ReprovisionInstallSandboxRequest
object
3 properties
permissions.Set
object
app.Component
object
17 properties
app.WorkflowStepGroup
object
14 properties
plantypes.ContainerImagePullPlan
object
5 properties
app.ComponentDiffEntry
object
5 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
service.UpdateInstallConfigRequest
object
5 properties
service.CreateWorkflowStepApprovalResponseResponse
object
3 properties
app.AccountType
string
app.TerraformWorkspace
object
7 properties
plantypes.TerraformDeployHooks
object
3 properties
service.PatchInstallConfigParams
object
1 property
app.ActionWorkflowTriggerType
string
app.RunnerOperation
object
10 properties
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.InstallStackVersionRun
object
9 properties
service.ForgetInstallRequest
object
app.LogStream
object
11 properties
app.Install
object
45 properties
app.InstallAuditLog
object
4 properties
app.ComponentBuild
object
31 properties
app.InstallRoleSelectionRecord
object
5 properties
service.UpdateInstallInputsRequest
object
3 properties
1 required
service.CancelWorkflowStepResponse
object
1 property
app.UserJourneyStep
object
7 properties
app.InstallStackOutputs
object
12 properties
app.CloudPlatform
string
service.AddInstallLabelsRequest
object
1 property
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.DriftedObject
object
10 properties
app.ComponentReleaseStep
object
10 properties
app.GCPStackOutputs
object
14 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
app.AWSIAMRoleType
string
app.InstallEvent
object
10 properties
plantypes.SandboxRunPlan
object
21 properties
app.AzureAccount
object
9 properties
github_com_nuonco_nuon_pkg_types_state.State
object
16 properties
app.StackVersionRunType
string
app.Policy
object
7 properties
service.InstallPhoneHomeRequest
object
plantypes.KustomizeBuildConfig
object
3 properties
service.SkipWorkflowStepResponse
object
2 properties
state.GCPCloudAccount
object
2 properties
compositeerrors.Hints
object
app.RunnerJobOperationType
string
app.InstallConfigDiff
object
10 properties
service.CreateWorkflowStepApprovalResponseRequest
object
2 properties
state.CloudAccount
object
3 properties
app.PublicGitVCSConfig
object
10 properties
state.InputsState
object
2 properties
plantypes.ActionWorkflowRunPlan
object
12 properties
service.TeardownInstallComponentRequest
object
2 properties
app.InstallStateGenerateSource
string
plantypes.ActionWorkflowRunStepPlan
object
6 properties
service.CreateInstallComponentDeployRequest
object
5 properties
github_com_nuonco_nuon_pkg_labels.Selector
object
2 properties
plantypes.PulumiDeployPlan
object
14 properties
helpers.CreateInstallConfigParams
object
5 properties
app.InstallInputs
object
10 properties
app.ActionWorkflowTriggerConfig
object
12 properties
configs.OCIRegistryRepository
object
10 properties
app.InstallAppBranchConnection
object
10 properties
service.CreateInstallInputsRequest
object
1 property
1 required
service.CreateInstallRequest
object
8 properties
1 required
app.RunnerOperationType
string
plantypes.SandboxMode
object
6 properties
app.RunnerJobStatus
string
app.JSONMap
object
plantypes.TerraformSandboxMode
object
4 properties
service.CreateInstallConfigRequest
object
5 properties
state.InstallStackState
object
7 properties
app.AWSStackOutputs
object
13 properties
app.InstallStackVersion
object
21 properties
app.AppBranch
object
12 properties
app.AppAWSIAMPolicyConfig
object
15 properties
service.WorkflowQueueItem
object
5 properties
app.HelmComponentConfig
object
15 properties
app.InstallActionWorkflow
object
9 properties
app.RunnerJobGroup
string
service.ToggleInstallComponentRequest
object
2 properties
1 required
state.DomainState
object
3 properties
config.CustomNestedStackStatus
string
service.RetryWorkflowStepResponse
object
2 properties
app.RunnerGroupSettings
object
35 properties
service.CancelWorkflowsResponse
object
2 properties
app.HelmChart
object
8 properties
service.CreateInstallDeployRequest
object
5 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
More from Nuon 12
Other APIs Nuon publishes across the network.
Nuon accounts API
Nuon actions API
Nuon actions/runner API
Nuon apps API
Nuon auth API
Nuon components API
Nuon general API
Nuon notebooks API
Nuon onboarding API
Nuon orgs API
Nuon policy-reports API
Nuon queues API
#installs