Skip to content

Queue a fixed-profile native grant or return; Owner/Admin only

POST
/apis/nodus.dev/v1/nodes/{name}/native-access
curl --request POST \
--url https://example.com/apis/nodus.dev/v1/nodes/example/native-access \
--header 'Content-Type: application/json' \
--data '{ "action": "example", "generation": 1, "image": "example", "requestID": "example", "sshPublicKeys": [ "example" ], "version": 1 }'
name
required
string

The object’s name.

Media type application/json

NativeAccessRequest begins one operator-authorized native lifecycle operation. Images are approved aliases; physical identity and reprovisioning policy are server-owned.

object
action
required

Action is begin-grant or begin-return; advancement belongs to the normal controller.

string
generation
required

Generation is the exact current return generation or the advertised next grant generation.

integer format: int64
image

Image is an approved alias for a grant, omitted on return.

string
requestID
required

RequestID is an immutable UUID; an identical retry reuses it.

string
sshPublicKeys

SSHPublicKeys supplies at most 16 public keys for a grant, omitted on return.

Array<string>
nullable
version
required

Version is 1 for this fixed-profile operator contract.

integer format: int64
Example generated
{
"action": "example",
"generation": 1,
"image": "example",
"requestID": "example",
"sshPublicKeys": [
"example"
],
"version": 1
}

Accepted

Media type application/json

NativeAccessStatus contains no external provisioning identity or credential.

object
approvedImages
required

ApprovedImages contains sorted configured aliases, never image URLs or external identifiers.

Array<string>
nullable
customerAccessReady
required

CustomerAccessReady requires the exact current external association to be verified.

boolean
generation
required

Generation is the stored customer generation, or zero before the first grant.

integer format: int64
nextAction
required

NextAction is a provider-free operator hint; it never authorizes an override.

string
nextGeneration

NextGeneration is present when a new grant may be requested after normal retirement.

integer format: int64
node
required

Node is the Nodus Node addressed by the operator.

string
phase
required

Phase describes preparation, access, return, verification or quarantine.

string
returnedNode

ReturnedNode identifies the newly enrolled successor after verified return.

string
version
required

Version is 1 for this projection.

integer format: int64
Example generated
{
"approvedImages": [
"example"
],
"customerAccessReady": true,
"generation": 1,
"nextAction": "example",
"nextGeneration": 1,
"node": "example",
"phase": "example",
"returnedNode": "example",
"version": 1
}

An error: a metav1.Status whose reason is a registered code.

Media type application/json

Status is the error body of every API response: a Kubernetes metav1.Status (so kubectl and client-go understand it) plus three top-level extensions that those clients ignore (ADR-028).

object
apiVersion
string
code
integer format: int32
details
object
causes
Array<object>
nullable
object
field
string
message
string
reason
string
group
string
kind
string
name
string
retryAfterSeconds
integer format: int32
uid
string
docs

Docs is the URL of the code’s docs page.

string
fix

Fix says what to do next, for example a CLI command or the field to change.

string
kind
string
message
string
metadata
object
continue
string
remainingItemCount
integer format: int64
resourceVersion
string
selfLink
string
shardInfo
object
selector
required
string
reason
string
requestId

RequestID identifies the request in logs and support tickets.

string
status
string
Example generated
{
"apiVersion": "example",
"code": 1,
"details": {
"causes": [
{
"field": "example",
"message": "example",
"reason": "example"
}
],
"group": "example",
"kind": "example",
"name": "example",
"retryAfterSeconds": 1,
"uid": "example"
},
"docs": "example",
"fix": "example",
"kind": "example",
"message": "example",
"metadata": {
"continue": "example",
"remainingItemCount": 1,
"resourceVersion": "example",
"selfLink": "example",
"shardInfo": {
"selector": "example"
}
},
"reason": "example",
"requestId": "example",
"status": "example"
}