Chapter 10. Namespace [v1]

Description: Namespace provides a scope for Names. Use of multiple namespaces is optional.
Type: object

10.1. Specification

Property	Type	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: https://git.k8s.io/community/contributors/devel/sig-architecture/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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	NamespaceSpec describes the attributes on a Namespace.
`status`	`object`	NamespaceStatus is information about the current status of a Namespace.

10.1.1. .spec

Description: NamespaceSpec describes the attributes on a Namespace.
Type: object

Property	Type	Description
`finalizers`	`array (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/

10.1.2. .status

Description: NamespaceStatus is information about the current status of a Namespace.
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array`	Represents the latest available observations of a namespace’s current state.
`conditions[]`	`object`	NamespaceCondition contains details about state of namespace.
`phase`	`string`	Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ Possible enum values: - `"Active"` means the namespace is available for use in the system - `"Terminating"` means the namespace is undergoing graceful termination

conditions

array

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

conditions[]

object

NamespaceCondition contains details about state of namespace.

phase

string

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

Possible enum values: - "Active" means the namespace is available for use in the system - "Terminating" means the namespace is undergoing graceful termination

10.1.3. .status.conditions

Description: Represents the latest available observations of a namespace’s current state.
Type: array

10.1.4. .status.conditions[]

Description

NamespaceCondition contains details about state of namespace.

Type

object

Required

type
status

Property	Type	Description
`lastTransitionTime`	`Time`
`message`	`string`
`reason`	`string`
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of namespace controller condition.

10.2. API endpoints

The following API endpoints are available:

/api/v1/namespaces
- GET: list or watch objects of kind Namespace
- POST: create a Namespace
/api/v1/watch/namespaces
- GET: watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.
/api/v1/namespaces/{name}
- DELETE: delete a Namespace
- GET: read the specified Namespace
- PATCH: partially update the specified Namespace
- PUT: replace the specified Namespace
/api/v1/watch/namespaces/{name}
- GET: watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
/api/v1/namespaces/{name}/status
- GET: read status of the specified Namespace
- PATCH: partially update status of the specified Namespace
- PUT: replace status of the specified Namespace
/api/v1/namespaces/{name}/finalize
- PUT: replace finalize of the specified Namespace

10.2.1. /api/v1/namespaces

HTTP method: GET
Description: list or watch objects of kind Namespace

Table 10.1. HTTP responses
HTTP code	Reponse body
200 - OK	`NamespaceList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a Namespace

Table 10.2. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 10.3. Body parameters
Parameter	Type	Description
`body`	`Namespace` schema

Table 10.4. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
201 - Created	`Namespace` schema
202 - Accepted	`Namespace` schema
401 - Unauthorized	Empty

10.2.2. /api/v1/watch/namespaces

HTTP method: GET
Description: watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.

Table 10.5. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

10.2.3. /api/v1/namespaces/{name}

Table 10.6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Namespace

HTTP method: DELETE
Description: delete a Namespace

Table 10.7. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 10.8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Namespace

Table 10.9. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Namespace

Table 10.10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 10.11. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
201 - Created	`Namespace` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Namespace

Table 10.12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 10.13. Body parameters
Parameter	Type	Description
`body`	`Namespace` schema

Table 10.14. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
201 - Created	`Namespace` schema
401 - Unauthorized	Empty

10.2.4. /api/v1/watch/namespaces/{name}

Table 10.15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Namespace

HTTP method: GET
Description: watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 10.16. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

10.2.5. /api/v1/namespaces/{name}/status

Table 10.17. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Namespace

HTTP method: GET
Description: read status of the specified Namespace

Table 10.18. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified Namespace

Table 10.19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 10.20. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
201 - Created	`Namespace` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified Namespace

Table 10.21. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 10.22. Body parameters
Parameter	Type	Description
`body`	`Namespace` schema

Table 10.23. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
201 - Created	`Namespace` schema
401 - Unauthorized	Empty

10.2.6. /api/v1/namespaces/{name}/finalize

Table 10.24. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Namespace

Table 10.25. Global query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP method: PUT
Description: replace finalize of the specified Namespace

Table 10.26. Body parameters
Parameter	Type	Description
`body`	`Namespace` schema

Table 10.27. HTTP responses
HTTP code	Reponse body
200 - OK	`Namespace` schema
201 - Created	`Namespace` schema
401 - Unauthorized	Empty

Chapter 10. Namespace [v1]

10.1. Specification

10.1.1. .spec

10.1.2. .status

10.1.3. .status.conditions

10.1.4. .status.conditions[]

10.2. API endpoints

10.2.1. /api/v1/namespaces

10.2.2. /api/v1/watch/namespaces

10.2.3. /api/v1/namespaces/{name}

10.2.4. /api/v1/watch/namespaces/{name}

10.2.5. /api/v1/namespaces/{name}/status

10.2.6. /api/v1/namespaces/{name}/finalize

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links