12 KiB

Raw Blame History

Namespace v1

Group	Version	Kind
Core	v1	Namespace

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec NamespaceSpec	Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status NamespaceStatus	Status describes the current status of a Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

NamespaceSpec v1

Field	Description
finalizers string array	Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

NamespaceStatus v1

Field	Description
phase string	Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases

NamespaceList v1

Field	Description
apiVersion string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Namespace array	Items is the list of Namespace objects in the list. More info: http://kubernetes.io/docs/user-guide/namespaces
kind string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

create a Namespace

HTTP Request

POST /api/v1/namespaces

Query Parameters

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

Body Parameters

Parameter	Description
body Namespace

Response

Code	Description
200 Namespace	OK

Replace

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

replace the specified Namespace

HTTP Request

PUT /api/v1/namespaces/{name}

Path Parameters

Parameter	Description
name	name of the Namespace

Query Parameters

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

Body Parameters

Parameter	Description
body Namespace

Response

Code	Description
200 Namespace	OK

Patch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

partially update the specified Namespace

HTTP Request

PATCH /api/v1/namespaces/{name}

Path Parameters

Parameter	Description
name	name of the Namespace

Query Parameters

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

Body Parameters

Parameter	Description
body Patch

Response

Code	Description
200 Namespace	OK

Delete

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete a Namespace

HTTP Request

DELETE /api/v1/namespaces/{name}

Path Parameters

Parameter	Description
name	name of the Namespace

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	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.

Body Parameters

Parameter	Description
body DeleteOptions

Response

Code	Description
200 Status	OK

Delete Collection

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete collection of Namespace

HTTP Request

DELETE /api/v1/namespaces

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.
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.
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.

Response

Code	Description
200 Status	OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

read the specified Namespace

HTTP Request

GET /api/v1/namespaces/{name}

Path Parameters

Parameter	Description
name	name of the Namespace

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.

Response

Code	Description
200 Namespace	OK

List

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

list or watch objects of kind Namespace

HTTP Request

GET /api/v1/namespaces

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.
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.
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.

Response

Code	Description
200 NamespaceList	OK

Watch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

watch changes to an object of kind Namespace

HTTP Request

GET /api/v1/watch/namespaces/{name}

Path Parameters

Parameter	Description
name	name of the Namespace

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
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.

Response

Code	Description
200 Event	OK

12 KiB Raw Blame History

Namespace v1

NamespaceSpec v1

NamespaceStatus v1

NamespaceList v1

Write Operations

Create

HTTP Request

Query Parameters

Body Parameters

Response

Replace

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Patch

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Delete

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Delete Collection

HTTP Request

Query Parameters

Response

Read Operations

Read

HTTP Request

Path Parameters

Query Parameters

Response

List

HTTP Request

Query Parameters

Response

Watch

HTTP Request

Path Parameters

Query Parameters

Response

12 KiB

Raw Blame History