v1.Node

Expand or mouse-over a field for more information about it.

Create a Node

HTTP request


Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Node",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/nodes <<'EOF'
{
  "kind": "Node",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get a Node

Read the specified Node

HTTP request

GET /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.
exact	Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’.
export	Should this value be exported. Export strips fields that a user can not specify.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get all Nodes

List or watch objects of kind Node

HTTP request

GET /api/v1/nodes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized	If true, partially initialized resources are included in the response.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code	Schema
200 OK	v1.NodeList
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Watch a Node

Watch changes to an object of kind Node

HTTP request

GET /api/v1/watch/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/nodes/$NAME

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized	If true, partially initialized resources are included in the response.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If ‘true’, then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code	Schema
200 OK	v1.WatchEvent
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Watch all Nodes

Watch individual changes to a list of Node

HTTP request

GET /api/v1/watch/nodes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/nodes

Query parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized	If true, partially initialized resources are included in the response.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If ‘true’, then the output is pretty printed.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code	Schema
200 OK	v1.WatchEvent
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Update a Node

Replace the specified Node

HTTP request

PUT /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Node",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME <<'EOF'
{
  "kind": "Node",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Node

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

Produces

application/json
application/yaml

Patch a Node

Partially update the specified Node

HTTP request

PATCH /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/api/v1/nodes/$NAME <<'EOF'
{
}
EOF

HTTP body

Parameter	Schema
body	v1.Patch

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Delete a Node

HTTP request

DELETE /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  ...
}

Curl request

$ curl -k \
    -X DELETE \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.DeleteOptions

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.
gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicy	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Responses

HTTP Code	Schema
200 OK	v1.Status
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Delete collection of Node

HTTP request

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized	If true, partially initialized resources are included in the response.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get status of a Node

Read status of the specified Node

HTTP request

GET /api/v1/nodes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/status

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

Produces

application/json
application/yaml

Update status of a Node

Replace status of the specified Node

HTTP request

PUT /api/v1/nodes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Node",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/status <<'EOF'
{
  "kind": "Node",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Node

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Patch status of a Node

Partially update status of the specified Node

HTTP request

PATCH /api/v1/nodes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Patch

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
pretty	If ‘true’, then the output is pretty printed.

Responses

HTTP Code	Schema
200 OK	v1.Node
401 Unauthorized

Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Proxy OPTIONS request to a Node

Connect OPTIONS requests to proxy of Node

HTTP request

OPTIONS /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X OPTIONS \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy POST request to a Node

Connect POST requests to proxy of Node

HTTP request

POST /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK
401 Unauthorized

Consumes

Produces

Proxy HEAD request to a Node

Connect HEAD requests to proxy of Node

HTTP request

HEAD /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X HEAD \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy GET request to a Node

Connect GET requests to proxy of Node

HTTP request

GET /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Connect PUT requests to proxy of Node

HTTP request

PUT /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

Consumes

Produces

Proxy PATCH request to a Node

Connect PATCH requests to proxy of Node

HTTP request

PATCH /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PATCH \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy DELETE request to a Node

Connect DELETE requests to proxy of Node

HTTP request

DELETE /api/v1/nodes/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy

Path parameters

Parameter	Description
name	name of the Node

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy OPTIONS request to a Node (with path)

Connect OPTIONS requests to proxy of Node

HTTP request

OPTIONS /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X OPTIONS \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy POST request to a Node (with path)

Connect POST requests to proxy of Node

HTTP request

POST /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy HEAD request to a Node (with path)

Connect HEAD requests to proxy of Node

HTTP request

HEAD /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X HEAD \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy GET request to a Node (with path)

Connect GET requests to proxy of Node

HTTP request

GET /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy PUT request to a Node (with path)

Connect PUT requests to proxy of Node

HTTP request

PUT /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PUT \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Connect PATCH requests to proxy of Node

HTTP request

PATCH /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PATCH \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to node.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy DELETE request to a Node (with path)

Connect DELETE requests to proxy of Node

HTTP request

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \

Path parameters

Parameter	Description
name	name of the Node
path	path to the resource

Query parameters

Responses

HTTP Code	Schema
200 OK	string