ConfigMap [v1]

Description

ConfigMap holds configuration data for pods to consume.

Type

`object`

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
binaryData	object (string)	BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
data	object (string)	Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
immutable	boolean	Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
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

API endpoints

The following API endpoints are available:

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

/api/v1/configmaps

HTTP method

`GET`

Description

list or watch objects of kind ConfigMap

HTTP responses

HTTP code	Reponse body
200 - OK	ConfigMapList schema
401 - Unauthorized	Empty

/api/v1/watch/configmaps

HTTP method

`GET`

Description

watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/configmaps

HTTP method

`DELETE`

Description

delete collection of ConfigMap

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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list or watch objects of kind ConfigMap

HTTP responses

HTTP code	Reponse body
200 - OK	ConfigMapList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a ConfigMap

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.

Body parameters

Parameter	Type	Description
body	ConfigMap schema

HTTP responses

HTTP code	Reponse body
200 - OK	ConfigMap schema
201 - Created	ConfigMap schema
202 - Accepted	ConfigMap schema
401 - Unauthorized	Empty

/api/v1/watch/namespaces/{namespace}/configmaps

HTTP method

`GET`

Description

watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/configmaps/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the ConfigMap

HTTP method

`DELETE`

Description

delete a ConfigMap

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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified ConfigMap

HTTP responses

HTTP code	Reponse body
200 - OK	ConfigMap schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified ConfigMap

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 responses

HTTP code	Reponse body
200 - OK	ConfigMap schema
201 - Created	ConfigMap schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified ConfigMap

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.

Body parameters

Parameter	Type	Description
body	ConfigMap schema

HTTP responses

HTTP code	Reponse body
200 - OK	ConfigMap schema
201 - Created	ConfigMap schema
401 - Unauthorized	Empty

/api/v1/watch/namespaces/{namespace}/configmaps/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the ConfigMap

HTTP method

`GET`

Description

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

HTTP responses

HTTP code	Reponse body
200 - OK	WatchEvent schema
401 - Unauthorized	Empty