How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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

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

This API exposes 12 operations across 8 paths, and defines 184 schemas. It is described by OpenAPI 3.2.0, at version 0.19.1074.

Requests are made against a single base URL, https://api.nuon.co/.

12 operations 8 paths 184 schemas 1 DELETE7 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 runbooks 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 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 7 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

runbooks 12

runbooks

GET
/v1/apps/{app_id}/runbooks
get runbooks for an app
GetRunbooks 4 params → 200400401403404500
POST
/v1/apps/{app_id}/runbooks
create a runbook for an app
CreateRunbook 1 param body → 201400401403404500
DELETE
/v1/apps/{app_id}/runbooks/{runbook_id}
delete a runbook
DeleteRunbook 2 params → 200400401403404500
GET
/v1/apps/{app_id}/runbooks/{runbook_id}
get a runbook
GetRunbook 2 params → 200400401403404500
PATCH
/v1/apps/{app_id}/runbooks/{runbook_id}
update a runbook
UpdateRunbook 2 params body → 200400401403404500
GET
/v1/apps/{app_id}/runbooks/{runbook_id}/configs
get runbook configs
GetRunbookConfigs 4 params → 200400401403404500
POST
/v1/apps/{app_id}/runbooks/{runbook_id}/configs
create a runbook config
CreateRunbookConfig 2 params body → 201400401403404500
GET
/v1/installs/{install_id}/runbook-runs
get runbook runs for an install
GetInstallRunbookRuns 4 params → 200400401403404500
GET
/v1/installs/{install_id}/runbook-runs/{run_id}
get a runbook run
GetInstallRunbookRun 2 params → 200400401403404500
GET
/v1/installs/{install_id}/runbooks
get runbooks for an install
GetInstallRunbooks 5 params → 200400401403404500
GET
/v1/installs/{install_id}/runbooks/{runbook_id}
get an install runbook
GetInstallRunbook 2 params → 200400401403404500
POST
/v1/installs/{install_id}/runbooks/{runbook_id}/runs
run a runbook on an install
CreateRunbookRun 2 params body → 201400401403404500

Schemas 184

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

github_com_nuonco_nuon_pkg_labels.Labels
object
state.InputsState
object
2 properties
plantypes.SyncSecretsPlan
object
6 properties
state.RunnerState
object
4 properties
app.VCSConnectionCommit
object
11 properties
compositeerrors.CompositeErrorData
object
9 properties
signaldb.SignalData
object
1 property
app.Role
object
7 properties
app.PulumiComponentConfig
object
11 properties
app.InstallRunbook
object
9 properties
plantypes.TerraformBackend
object
1 property 1 required
state.AzureCloudAccount
object
1 property
outputs.SecretSyncOutput
object
10 properties
iam.StaticCredentials
object
3 properties
plantypes.KubernetesManifestDeployPlan
object
8 properties
configs.OCIRegistryAuth
object
2 properties
app.ComponentType
string
state.ActionWorkflowState
object
4 properties
plantypes.BuildPlan
object
12 properties 2 required
app.QueueSignal
object
20 properties
app.WorkflowStepPolicyValidation
object
8 properties
app.InstallRoleUsage
object
13 properties
state.AWSCloudAccount
object
1 property
app.QueueEmitter
object
21 properties
github_com_nuonco_nuon_pkg_labels.Selector
object
2 properties
app.Status
string
plantypes.FetchImageMetadataPlan
object
6 properties 2 required
app.InstallRunbookRun
object
20 properties
app.RunnerJobPlan
object
8 properties
compositeerrors.SectionKind
string
app.ComponentBuild
object
31 properties
compositeerrors.Hints
object
plantypes.SandboxMode
object
6 properties
app.JobComponentConfig
object
10 properties
plantypes.TerraformDeployPlan
object
12 properties
plantypes.OCIArtifactReference
object
3 properties
plantypes.OCISource
object
2 properties
service.CreateRunbookRunStepSelection
object
2 properties 1 required
plantypes.TerraformSandboxMode
object
4 properties
app.AppBranch
object
12 properties
app.HelmConfig
object
8 properties
credentials.StaticCredentials
object
3 properties 3 required
callback.Ref
object
3 properties
configs.OCIRegistryRepository
object
10 properties
app.PolicyReportOwnerType
string
app.PolicyName
string
plantypes.SyncOCIPlan
object
5 properties 4 required
plantypes.CompositePlan
object
7 properties
state.DomainState
object
3 properties
app.AccountType
string
app.AppBranchRunType
string
app.UserJourneyStep
object
7 properties
credentials.AssumeRoleConfig
object
6 properties 2 required
permissions.Permission
string
refs.Ref
object
4 properties
app.Account
object
10 properties
credentials.ServicePrincipalCredentials
object
2 properties
app.InstallActionWorkflowRunStep
object
10 properties
plantypes.PulumiSandboxMode
object
3 properties
plantypes.PulumiDeployPlan
object
14 properties
state.SecretsState
object
app.AppBranchConfig
object
13 properties
plantypes.NoopDeployPlan
object
app.DockerBuildComponentConfig
object
11 properties
app.AppBranchRun
object
31 properties
plantypes.DeployPlan
object
16 properties 2 required
state.OrgState
object
4 properties
service.CreateRunbookStepConfigRequest
object
13 properties 2 required
app.WorkflowRun
object
11 properties
plantypes.ActionWorkflowRunStepPlan
object
6 properties
app.RunnerJob
object
33 properties
app.InstallActionWorkflow
object
9 properties
app.Component
object
17 properties
app.Policy
object
7 properties
service.CreateRunbookRequest
object
3 properties 1 required
app.ConnectedGithubVCSConfig
object
14 properties
app.KustomizeConfig
object
4 properties
app.WorkflowStepGroup
object
14 properties
app.ExternalImageComponentConfig
object
11 properties
app.RunnerJobStatus
string
plantypes.ContainerImagePullPlan
object
5 properties
app.AzureACRImageConfig
object
9 properties
app.ActionWorkflowStepConfig
object
16 properties
plantypes.HelmDeployPlan
object
14 properties
app.RunbookConfig
object
10 properties
plantypes.KubernetesSecretSyncTarget
object
3 properties
app.WorkflowRunType
string
state.CloudAccount
object
3 properties
app.AWSECRImageConfig
object
8 properties
plantypes.ActionWorkflowRunPlan
object
12 properties
state.ActionsState
object
2 properties
app.WorkflowStepApproval
object
14 properties
app.WorkflowStepApprovalType
string
plantypes.SandboxRunPlan
object
21 properties
app.RunbookStepSelection
object
3 properties
app.PublicGitVCSConfig
object
10 properties
app.WorkflowStepExecutionType
string
cctx.SignalContext
object
4 properties
app.InstallRoleSelectionRecord
object
5 properties
app.WorkflowStep
object
36 properties
app.WorkflowType
string
plantypes.GitSource
object
4 properties 3 required
plantypes.TerraformDeployHooks
object
3 properties
app.InstallDeployType
string
app.AdHocStepConfig
object
16 properties
plantypes.KubernetesSandboxMode
object
2 properties
config.HelmRepoConfig
object
3 properties
state.SandboxState
object
6 properties
app.GCPGARImageConfig
object
10 properties
app.QueueEmitterMode
string
app.ActionWorkflowConfig
object
17 properties
state.InstallStackState
object
7 properties
app.PolicyInputRef
object
3 properties
plantypes.HelmSandboxMode
object
2 properties
service.CreateRunbookInputRequest
object
7 properties 1 required
app.RunnerJobGroup
string
app.AppBranchInstallGroup
object
12 properties
github_com_nuonco_nuon_pkg_aws_credentials.Config
object
6 properties
app.VCSConnection
object
10 properties
app.LogStream
object
11 properties
app.OCIArtifact
object
20 properties
app.Runbook
object
13 properties
service.CreateRunbookRunRequest
object
2 properties
service.UpdateRunbookRequest
object
3 properties
github_com_nuonco_nuon_pkg_azure_credentials.Config
object
3 properties
app.TerraformModuleComponentConfig
object
11 properties
app.RunnerJobExecution
object
11 properties
app.UserJourney
object
3 properties
app.PolicyResult
object
7 properties
github_com_nuonco_nuon_pkg_types_state.State
object
16 properties
app.PolicyViolation
object
6 properties
app.ActionWorkflowTriggerType
string
iam.TwoStepConfig
object
3 properties
app.InstallActionWorkflowRunStepStatus
string
state.GCPCloudAccount
object
2 properties
app.HelmComponentConfig
object
15 properties
plantypes.HelmValue
object
3 properties
plantypes.HelmBuildPlan
object
4 properties
app.ComponentReleaseStep
object
10 properties
app.RunnerJobOperationType
string
app.RunnerJobType
string
plantypes.TerraformBuildPlan
object
3 properties
app.InstallDeploy
object
32 properties
app.RunnerJobExecutionResult
object
14 properties
configs.OCIRegistryType
string
plantypes.TerraformLocalArchive
object
1 property
app.HelmRepoConfig
object
3 properties
compositeerrors.Severity
string
app.AppSandboxConfig
object
26 properties
app.ComponentRelease
object
9 properties
github_com_nuonco_nuon_pkg_gcp_credentials.Config
object
3 properties
kube.ClusterInfo
object
10 properties
state.AppState
object
5 properties
app.InstallApprovalOption
string
app.RunbookStepConfig
object
18 properties
plantypes.KustomizeBuildConfig
object
3 properties
app.KubernetesManifestComponentConfig
object
10 properties
plantypes.KubernetesSecretSync
object
9 properties
app.RoleType
string
app.InstallSandboxRun
object
24 properties
app.RunnerJobExecutionOutputs
object
8 properties
app.InstallActionWorkflowRun
object
29 properties
plantypes.PulumiBuildPlan
object
1 property
app.ComponentConfigConnection
object
32 properties
app.CompositeStatus
object
6 properties
refs.RefType
string
plantypes.PulumiBackend
object
6 properties 3 required
app.ActionWorkflowTriggerConfig
object
12 properties
app.RunnerJobExecutionStatus
string
plantypes.DockerBuildPlan
object
4 properties
state.InstallState
object
7 properties
app.Queue
object
16 properties
signaldb.WorkflowRef
object
3 properties
permissions.Set
object
stderr.ErrResponse
object
3 properties
sql.NullBool
object
2 properties
app.RunbookInput
object
13 properties
app.Workflow
object
30 properties
app.ActionWorkflow
object
12 properties
plantypes.KubernetesManifestBuildPlan
object
5 properties
compositeerrors.Section
object
3 properties
app.SandboxRunType
string
app.PolicyReport
object
24 properties
service.CreateRunbookConfigRequest
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuon-runbooks-api-openapi.yml Raw ↑

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 installs API
Nuon notebooks API
Nuon onboarding API
Nuon orgs API
Nuon policy-reports API
Where this information came from

This is an independent, third-party profile of Nuon runbooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.