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 general API is one of 18 APIs that Nuon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

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

6 operations 6 paths 15 schemas 5 GET1 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 general 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 6

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

general 6

general

GET
/v1/general/cli-config
Get config for cli
GetCLIConfig → 200400401403404500
GET
/v1/general/cloud-platform/{cloud_platform}/regions
Get regions for a cloud platform
GetCloudPlatformRegions 1 param → 200400401403404500
GET
/v1/general/config-schema
Get jsonschema for config file (deprecated query form)
GetConfigSchema 2 params → 200400401403404500
GET
/v1/general/config-schema/{type}
Get jsonschema for a config file type
GetConfigSchemaByType 1 param → 200400401403404500
GET
/v1/general/current-user
Get current user
GetCurrentUser → 200400401403404500
POST
/v1/general/waitlist
Allow user to be added to an org waitlist.
CreateWaitlist 1 param → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are app.Account (10 properties), app.UserJourneyStep (7 properties), app.Role (7 properties), app.Policy (7 properties). Each schema is shown below with its type and property counts.

permissions.Permission
string
app.UserJourney
object
3 properties
app.UserJourneyStep
object
7 properties
app.Waitlist
object
5 properties
permissions.Set
object
service.WaitlistRequest
object
1 property 1 required
app.Account
object
10 properties
app.CloudPlatformRegion
object
4 properties
stderr.ErrResponse
object
3 properties
service.CLIConfig
object
6 properties
app.RoleType
string
app.Policy
object
7 properties
app.Role
object
7 properties
app.PolicyName
string
app.AccountType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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