website/content/en/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md

api_metadata	content_type	description	title	weight	auto_generated
apiVersion import kind v1 k8s.io/api/core/v1 Namespace	api_reference	Namespace provides a scope for Names.	Namespace	2	true

apiVersion: v1

import "k8s.io/api/core/v1"

Namespace

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

---

• apiVersion: v1

• kind: Namespace

• metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• spec (<a href="{{< ref "../cluster-resources/namespace-v1#NamespaceSpec" >}}">NamespaceSpec)

  Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

• status (<a href="{{< ref "../cluster-resources/namespace-v1#NamespaceStatus" >}}">NamespaceStatus)

  Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.

---

• finalizers ([]string)

  Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.

---

• conditions ([]NamespaceCondition)

  Patch strategy: merge on key type

  Represents the latest available observations of a namespace's current state.

  NamespaceCondition contains details about state of namespace.

  • conditions.status (string), required

    Status of the condition, one of True, False, Unknown.

  • conditions.type (string), required

    Type of namespace controller condition.

  • conditions.lastTransitionTime (Time)

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • conditions.message (string)

  • conditions.reason (string)

• phase (string)

  Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

NamespaceList

NamespaceList is a list of Namespaces.

---

• apiVersion: v1

• kind: NamespaceList

• metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• items ([]<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace), required

  Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Operations

---

get read the specified Namespace

HTTP Request

GET /api/v1/namespaces/{name}

Parameters

• name (in path): string, required

  name of the Namespace

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

401: Unauthorized

get read status of the specified Namespace

HTTP Request

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

Parameters

• name (in path): string, required

  name of the Namespace

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

401: Unauthorized

list list or watch objects of kind Namespace

HTTP Request

GET /api/v1/namespaces

Parameters

• allowWatchBookmarks (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks

• continue (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• fieldSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• labelSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• resourceVersion (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

• watch (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#NamespaceList" >}}">NamespaceList): OK

401: Unauthorized

create create a Namespace

HTTP Request

POST /api/v1/namespaces

Parameters

• body: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): Created

202 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): Accepted

401: Unauthorized

update replace the specified Namespace

HTTP Request

PUT /api/v1/namespaces/{name}

Parameters

• name (in path): string, required

  name of the Namespace

• body: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): Created

401: Unauthorized

update replace finalize of the specified Namespace

HTTP Request

PUT /api/v1/namespaces/{name}/finalize

Parameters

• name (in path): string, required

  name of the Namespace

• body: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): Created

401: Unauthorized

update replace status of the specified Namespace

HTTP Request

PUT /api/v1/namespaces/{name}/status

Parameters

• name (in path): string, required

  name of the Namespace

• body: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): Created

401: Unauthorized

patch partially update the specified Namespace

HTTP Request

PATCH /api/v1/namespaces/{name}

Parameters

• name (in path): string, required

  name of the Namespace

• body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• force (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

401: Unauthorized

patch partially update status of the specified Namespace

HTTP Request

PATCH /api/v1/namespaces/{name}/status

Parameters

• name (in path): string, required

  name of the Namespace

• body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch, required

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• fieldManager (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager

• force (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace): OK

401: Unauthorized

delete delete a Namespace

HTTP Request

DELETE /api/v1/namespaces/{name}

Parameters

• name (in path): string, required

  name of the Namespace

• body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions

• dryRun (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun

• gracePeriodSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• propagationPolicy (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

Response

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted

401: Unauthorized