Nuon vcs 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 9 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
vcs 12
vcs
POST
/v1/vcs/connection-callback
public connection to create a vcs connection via a callback
Write a VCS webhook event (shared per subscription)
WriteWebhookEvent1 param→ 200400401404500
POST
/v1/vcs/{vcs_connection_id}/events
Write a VCS webhook event
WriteVCSEvent1 param→ 200400404500
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are github.User (44 properties), app.QueueEmitter (21 properties), app.QueueSignal (20 properties), app.Queue (16 properties). Each schema is shown below with its type and property counts.
github.Match
object
2 properties
app.VCSConnectionCommit
object
11 properties
app.QueueEmitter
object
21 properties
signaldb.SignalData
object
1 property
app.VCSWebhookSubscription
object
9 properties
app.CompositeStatus
object
6 properties
app.Queue
object
16 properties
app.GithubEvent
object
8 properties
app.QueueSignal
object
20 properties
app.VCSConnection
object
10 properties
service.VCSConnectionAccount
object
3 properties
app.QueueEmitterMode
string
app.Status
string
github.TextMatch
object
5 properties
service.VCSConnectionRepo
object
9 properties
cctx.SignalContext
object
4 properties
github.User
object
44 properties
callback.Ref
object
3 properties
service.VCSConnectionReposResponse
object
2 properties
service.VCSConnectionStatusResponse
object
9 properties
service.CreateConnectionRequest
object
1 property1 required
signaldb.WorkflowRef
object
3 properties
blobstore.Blob
object
stderr.ErrResponse
object
3 properties
service.Branch
object
1 property
github.Timestamp
object
1 property
github.Plan
object
6 properties
service.CreateConnectionCallbackRequest
object
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
