Nuon runners/runner API is one of 18 APIs that Nuon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include runners/runner. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 11 operations across 8 paths, and defines 173 schemas. It is described by OpenAPI 2.0, at version 0.19.1074.
Requests are made against the base URL https://api.nuon.co.
11 operations
8 paths
173 schemas
1 DELETE6 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Nuon runners/runner 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 11
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
runners/runner 11
runners/runner
GET
/v1/runner-jobs/{runner_job_id}deprecated
get runner job
GET
/v1/runner-jobs/{runner_job_id}/composite-plan
get runner job composite plan
GET
/v1/runner-jobs/{runner_job_id}/plandeprecated
get runner job plan
GET
/v1/terraform-backend
get current terraform
POST
/v1/terraform-backend
update terraform state
GET
/v1/terraform-workspaces
get terraform workspaces
POST
/v1/terraform-workspaces
create terraform workspace
DELETE
/v1/terraform-workspaces/{workspace_id}
delete terraform workspace
GET
/v1/terraform-workspaces/{workspace_id}
get terraform workspace
POST
/v1/terraform-workspaces/{workspace_id}/lock
lock terraform state
POST
/v1/terraform-workspaces/{workspace_id}/unlock
unlock terraform workspace
Schemas 173
The contract defines 173 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
plantypes.TerraformLocalArchive
object
1 property
app.Account
object
10 properties
app.PolicyResult
object
7 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
plantypes.PulumiBackend
object
6 properties
3 required
compositeerrors.SectionKind
string
app.WorkflowStepPolicyValidation
object
8 properties
state.SandboxState
object
6 properties
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
plantypes.FetchImageMetadataPlan
object
6 properties
2 required
app.RunnerJobExecutionOutputs
object
8 properties
credentials.AssumeRoleConfig
object
6 properties
2 required
plantypes.HelmSandboxMode
object
2 properties
app.PolicyName
string
app.HelmRepoConfig
object
3 properties
state.AzureCloudAccount
object
1 property
state.ActionWorkflowState
object
4 properties
app.RunnerJob
object
33 properties
app.AppBranchRunType
string
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
app.TerraformWorkspaceState
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
plantypes.TerraformBackend
object
1 property
1 required
sql.NullBool
object
2 properties
configs.OCIRegistryAuth
object
2 properties
compositeerrors.CompositeErrorData
object
9 properties
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
stderr.ErrResponse
object
3 properties
plantypes.SyncSecretsPlan
object
6 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
app.PolicyInputRef
object
3 properties
permissions.Permission
string
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
iam.TwoStepConfig
object
3 properties
app.Status
string
app.AccountType
string
app.TerraformWorkspace
object
7 properties
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
kube.ClusterInfo
object
10 properties
app.AppBranchRun
object
31 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
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
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
state.InputsState
object
2 properties
plantypes.ActionWorkflowRunPlan
object
12 properties
app.PublicGitVCSConfig
object
10 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.CreateTerraformWorkspaceRequest
object
2 properties
2 required
plantypes.TerraformSandboxMode
object
4 properties
state.InstallStackState
object
7 properties
app.AppBranch
object
12 properties
app.HelmComponentConfig
object
15 properties
app.InstallActionWorkflow
object
9 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
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 installs API
Nuon notebooks API
Nuon onboarding API
Nuon orgs API
Nuon policy-reports API
#runners/runner