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

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

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

This API exposes 35 operations across 24 paths, and defines 186 schemas. It is described by OpenAPI 2.0, at version 0.19.1074.

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

35 operations 24 paths 186 schemas 3 DELETE22 GET2 PATCH8 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
Resource Areas
1

Authentication & Security 2

Nuon actions 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 35

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

actions 35

actions

GET
/v1/action-workflows/configs/{action_workflow_config_id}deprecated
get an app action workflow config
GetActionWorkflowConfig 1 param → 200400401403404500
DELETE
/v1/action-workflows/{action_workflow_id}deprecated
delete an action workflow
DeleteActionWorkflow 1 param → 200400401403404500
GET
/v1/action-workflows/{action_workflow_id}deprecated
get an app action workflow by action workflow id
GetActionWorkflow 1 param → 200400401403404500
PATCH
/v1/action-workflows/{action_workflow_id}deprecated
patch an app
UpdateAppActionWorkflow 2 params → 201400401403404500
GET
/v1/action-workflows/{action_workflow_id}/configsdeprecated
get action workflow for an app
GetActionWorkflowConfigs 4 params → 200400401403404500
POST
/v1/action-workflows/{action_workflow_id}/configsdeprecated
create action workflow config
CreateActionWorkflowConfig 2 params → 201400401403404409500
GET
/v1/action-workflows/{action_workflow_id}/latest-configdeprecated
get an app action workflow's latest config
GetActionWorkflowLatestConfig 1 param → 200400401403404500
GET
/v1/apps/{app_id}/action-workflowsdeprecated
get action workflows for an app
GetActionWorkflows 7 params → 200400401403404500
POST
/v1/apps/{app_id}/action-workflowsdeprecated
create an app action workflow
CreateAppActionWorkflow 2 params → 201400401403404409500
GET
/v1/apps/{app_id}/action-workflows/{action_workflow_id}deprecated
get an app action workflow
GetAppActionWorkflow 2 params → 200400401403404500
GET
/v1/apps/{app_id}/actions
get action workflows for an app
GetAppActions 7 params → 200400401403404500
POST
/v1/apps/{app_id}/actionsdeprecated
create an app action
CreateAppAction 2 params → 201400401403404409500
GET
/v1/apps/{app_id}/actions/configs/{action_config_id}
get an app action config
GetAppActionConfig 2 params → 200400401403404500
GET
/v1/apps/{app_id}/actions/label-keys
get distinct label key:value pairs across all actions for an app
GetActionLabelKeys 1 param → 200
DELETE
/v1/apps/{app_id}/actions/{action_id}
delete an action
DeleteAction 2 params → 200400401403404500
GET
/v1/apps/{app_id}/actions/{action_id}
get an app action workflow by action workflow id
GetAppAction 2 params → 200400401403404500
PATCH
/v1/apps/{app_id}/actions/{action_id}deprecated
patch an app action
UpdateAppAction 3 params → 201400401403404500
GET
/v1/apps/{app_id}/actions/{action_id}/configs
get action workflow for an app
GetAppActionConfigs 5 params → 200400401403404500
POST
/v1/apps/{app_id}/actions/{action_id}/configs
create action config
CreateActionConfig 3 params → 201400401403404409500
DELETE
/v1/apps/{app_id}/actions/{action_id}/labels
remove labels from an action
RemoveAppActionLabels 3 params → 200400401403404500
POST
/v1/apps/{app_id}/actions/{action_id}/labels
add labels to an action
AddAppActionLabels 3 params → 200400401403404500
GET
/v1/apps/{app_id}/actions/{action_id}/latest-config
get an app action workflow's latest config
GetActionLatestConfig 2 params → 200400401403404500
GET
/v1/installs/{install_id}/action-workflows/latest-runsdeprecated
get latest runs for all action workflows by install id
GetInstallActionWorkflowsLatestRuns 8 params → 200400401403404500
GET
/v1/installs/{install_id}/action-workflows/runsdeprecated
get action workflow runs by install id
GetInstallActionWorkflowRuns 4 params → 200400401403404500
POST
/v1/installs/{install_id}/action-workflows/runsdeprecated
create an action workflow run for an install
CreateInstallActionWorkflowRun 2 params → 201400401403404409500
GET
/v1/installs/{install_id}/action-workflows/runs/{run_id}deprecated
get action workflow runs by install id and run id
GetInstallActionWorkflowRun 2 params → 200400401403404500
GET
/v1/installs/{install_id}/action-workflows/runs/{run_id}/steps/{step_id}deprecated
get action workflow run step by install id and step id
GetInstallActionWorkflowRunStep 3 params → 200400401403404500
GET
/v1/installs/{install_id}/action-workflows/{action_workflow_id}/recent-runsdeprecated
get recent runs for an action workflow by install id
GetInstallActionWorkflowRecentRuns 5 params → 200400401403404500
POST
/v1/installs/{install_id}/actions/adhoc-run
create an adhoc action run for an install
CreateAdHocAction 2 params → 201400401403404409500
GET
/v1/installs/{install_id}/actions/latest-runs
get latest runs for all action workflows by install id
GetInstallActionsLatestRuns 8 params → 200400401403404500
GET
/v1/installs/{install_id}/actions/runs
get action workflow runs by install id
GetInstallActionRuns 4 params → 200400401403404500
POST
/v1/installs/{install_id}/actions/runs
create an action run for an install
CreateInstallActionRun 2 params → 201400401403404409500
GET
/v1/installs/{install_id}/actions/runs/{run_id}
get action workflow runs by install id and run id
GetInstallActionRun 2 params → 200400401403404500
GET
/v1/installs/{install_id}/actions/runs/{run_id}/steps/{step_id}
get action workflow run step by install id and step id
GetInstallActionRunStep 3 params → 200400401403404500
GET
/v1/installs/{install_id}/actions/{action_id}/recent-runs
get recent runs for an action workflow by install id
GetInstallActionRecentRuns 5 params → 200400401403404500

Schemas 186

The contract defines 186 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
service.UpdateActionWorkflowRequest
object
2 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.CreateInstallActionWorkflowRunRequest
object
3 properties 1 required
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
plantypes.PulumiBackend
object
6 properties 3 required
compositeerrors.SectionKind
string
app.WorkflowStepPolicyValidation
object
8 properties
state.SandboxState
object
6 properties
service.ConnectedGithubVCSActionWorkflowConfigRequest
object
4 properties 2 required
app.SandboxRunType
string
app.InstallActionWorkflowRun
object
29 properties
app.InstallActionWorkflowRunStepStatus
string
app.ActionWorkflowConfig
object
17 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
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
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
service.CreateAdHocActionRequest
object
7 properties
app.QueueEmitterMode
string
app.WorkflowStepApprovalType
string
app.WorkflowResponse
object
1 property
app.InstallDeployType
string
app.WorkflowStepApproval
object
14 properties
service.CreateActionWorkflowConfigTriggerRequest
object
4 properties 1 required
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.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
credentials.StaticCredentials
object
3 properties 3 required
plantypes.OCISource
object
2 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
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
service.CreateAdHocActionResponse
object
7 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
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
service.AddActionLabelsRequest
object
1 property 1 required
app.InstallRoleUsage
object
13 properties
app.InstallActionWorkflowRunStatus
string
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
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
service.CreateAppActionWorkflowRequest
object
2 properties
app.Role
object
7 properties
app.InstallSandboxRun
object
24 properties
app.InstallApprovalOption
string
plantypes.SandboxRunPlan
object
21 properties
github_com_nuonco_nuon_pkg_types_state.State
object
16 properties
app.Policy
object
7 properties
service.RemoveActionLabelsRequest
object
1 property 1 required
plantypes.KustomizeBuildConfig
object
3 properties
state.GCPCloudAccount
object
2 properties
compositeerrors.Hints
object
app.RunnerJobOperationType
string
service.CreateActionWorkflowConfigRequest
object
10 properties 3 required
service.CreateAppActionRequest
object
1 property
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
app.ActionWorkflowTriggerConfig
object
12 properties
configs.OCIRegistryRepository
object
10 properties
plantypes.SandboxMode
object
6 properties
app.RunnerJobStatus
string
service.PublicGitVCSActionWorkflowConfigRequest
object
3 properties 3 required
service.CreateActionWorkflowConfigStepRequest
object
7 properties 1 required
plantypes.TerraformSandboxMode
object
4 properties
state.InstallStackState
object
7 properties
app.AppBranch
object
12 properties
app.InstallActionWorkflow
object
9 properties
app.HelmComponentConfig
object
15 properties
app.RunnerJobGroup
string
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-actions-api-openapi.yml Raw ↑

Other APIs Nuon publishes across the network.

Nuon accounts API
Nuon actions/runner API
Nuon apps 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