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 onboarding API

onboarding

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

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

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

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

9 operations 8 paths 8 schemas 1 DELETE2 GET6 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 onboarding 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 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

onboarding 9

onboarding

POST
/v1/onboarding
Start a new onboarding session
CreateOnboarding → 201400401409500
DELETE
/v1/onboarding/current
Abandon onboarding session
AbandonOnboarding → 200401404500
GET
/v1/onboarding/current
Get current onboarding session
GetCurrentOnboarding → 200401404500
POST
/v1/onboarding/current/steps/deploy
Complete the deploy step
CompleteOnboardingDeployStep → 200400401500
POST
/v1/onboarding/current/steps/get-started
Complete onboarding
CompleteOnboardingGetStartedStep → 200400401500
POST
/v1/onboarding/current/steps/install
Complete the install step
CompleteOnboardingInstallStep 1 param → 200400401500
POST
/v1/onboarding/current/steps/organization
Complete the organization step
CompleteOnboardingOrganizationStep 1 param → 200400401500
POST
/v1/onboarding/current/steps/your-stack
Complete the your stack step
CompleteOnboardingYourStackStep 1 param → 200400401500
GET
/v1/onboarding/example-apps
Get example apps catalog
GetOnboardingExampleApps → 200401500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are app.Onboarding (21 properties), service.ExampleApp (8 properties), service.CompleteInstallStepRequest (6 properties), app.CompositeStatus (6 properties). Each schema is shown below with its type and property counts.

service.CompleteInstallStepRequest
object
6 properties 1 required
app.CompositeStatus
object
6 properties
service.CompleteYourStackStepRequest
object
4 properties 1 required
stderr.ErrResponse
object
3 properties
app.Status
string
service.ExampleApp
object
8 properties
app.Onboarding
object
21 properties
service.CompleteOrganizationStepRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuon-onboarding-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 orgs API
Nuon policy-reports API
Nuon queues API