-----------
# ConfigMap v1
Group | Version | Kind
------------ | ---------- | -----------
Core | v1 | ConfigMap
ConfigMap holds configuration data for pods to consume.
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
data
*object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
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](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
### ConfigMapList 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
*[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
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](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
## Write Operations
See supported operations below...
## Create
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
create a ConfigMap
### HTTP Request
`POST /api/v1/namespaces/{namespace}/configmaps`
### Path Parameters
Parameter | Description
------------ | -----------
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
pretty | If 'true', then the output is pretty printed.
### Body Parameters
Parameter | Description
------------ | -----------
body
*[ConfigMap](#configmap-v1)* |
### Response
Code | Description
------------ | -----------
200
*[ConfigMap](#configmap-v1)* | OK
## Replace
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
replace the specified ConfigMap
### HTTP Request
`PUT /api/v1/namespaces/{namespace}/configmaps/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the ConfigMap
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
pretty | If 'true', then the output is pretty printed.
### Body Parameters
Parameter | Description
------------ | -----------
body
*[ConfigMap](#configmap-v1)* |
### Response
Code | Description
------------ | -----------
200
*[ConfigMap](#configmap-v1)* | OK
## Patch
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
partially update the specified ConfigMap
### HTTP Request
`PATCH /api/v1/namespaces/{namespace}/configmaps/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the ConfigMap
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
pretty | If 'true', then the output is pretty printed.
### Body Parameters
Parameter | Description
------------ | -----------
body
*[Patch](#patch-unversioned)* |
### Response
Code | Description
------------ | -----------
200
*[ConfigMap](#configmap-v1)* | OK
## Delete
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
delete a ConfigMap
### HTTP Request
`DELETE /api/v1/namespaces/{namespace}/configmaps/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the ConfigMap
namespace | object name and auth scope, such as for teams and projects
### 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](#deleteoptions-v1)* |
### Response
Code | Description
------------ | -----------
200
*[Status](#status-unversioned)* | OK
## Delete Collection
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
delete collection of ConfigMap
### HTTP Request
`DELETE /api/v1/namespaces/{namespace}/configmaps`
### Path Parameters
Parameter | Description
------------ | -----------
namespace | object name and auth scope, such as for teams and projects
### 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](#status-unversioned)* | OK
## Read Operations
See supported operations below...
## Read
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
read the specified ConfigMap
### HTTP Request
`GET /api/v1/namespaces/{namespace}/configmaps/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the ConfigMap
namespace | object name and auth scope, such as for teams and projects
### 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
*[ConfigMap](#configmap-v1)* | OK
## List
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
list or watch objects of kind ConfigMap
### HTTP Request
`GET /api/v1/namespaces/{namespace}/configmaps`
### Path Parameters
Parameter | Description
------------ | -----------
namespace | object name and auth scope, such as for teams and projects
### 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
*[ConfigMapList](#configmaplist-v1)* | OK
## List All Namespaces
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
list or watch objects of kind ConfigMap
### HTTP Request
`GET /api/v1/configmaps`
### 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
*[ConfigMapList](#configmaplist-v1)* | OK
## Watch
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
watch changes to an object of kind ConfigMap
### HTTP Request
`GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the ConfigMap
namespace | object name and auth scope, such as for teams and projects
### 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](#event-versioned)* | OK
## Watch List All Namespaces
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
watch individual changes to a list of ConfigMap
### HTTP Request
`GET /api/v1/watch/configmaps`
### 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](#event-versioned)* | OK