1. Documentation
×

ControllerRevision [apps/v1]

Description

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Type

object

Required

  • revision

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

data

RawExtension

Data is the serialized representation of the state.

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

revision

integer

Revision indicates the revision of the state represented by Data.

API endpoints

The following API endpoints are available:

  • /apis/apps/v1/controllerrevisions

    • GET: list or watch objects of kind ControllerRevision

  • /apis/apps/v1/watch/controllerrevisions

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

  • /apis/apps/v1/namespaces/{namespace}/controllerrevisions

    • DELETE: delete collection of ControllerRevision

    • GET: list or watch objects of kind ControllerRevision

    • POST: create a ControllerRevision

  • /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions

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

  • /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

    • DELETE: delete a ControllerRevision

    • GET: read the specified ControllerRevision

    • PATCH: partially update the specified ControllerRevision

    • PUT: replace the specified ControllerRevision

  • /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}

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

/apis/apps/v1/controllerrevisions

HTTP method

GET

Description

list or watch objects of kind ControllerRevision

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

ControllerRevisionList schema

401 - Unauthorized

Empty

/apis/apps/v1/watch/controllerrevisions

HTTP method

GET

Description

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

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/apps/v1/namespaces/{namespace}/controllerrevisions

HTTP method

DELETE

Description

delete collection of ControllerRevision

Table 3. 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 4. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind ControllerRevision

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

ControllerRevisionList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create a ControllerRevision

Table 6. 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 7. Body parameters
Parameter Type Description

body

ControllerRevision schema
Table 8. HTTP responses
HTTP code Reponse body

200 - OK

ControllerRevision schema

201 - Created

ControllerRevision schema

202 - Accepted

ControllerRevision schema

401 - Unauthorized

Empty

/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions

HTTP method

GET

Description

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

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

Table 10. Global path parameters
Parameter Type Description

name

string

name of the ControllerRevision
HTTP method

DELETE

Description

delete a ControllerRevision

Table 11. 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 12. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified ControllerRevision

Table 13. HTTP responses
HTTP code Reponse body

200 - OK

ControllerRevision schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified ControllerRevision

Table 14. 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 15. HTTP responses
HTTP code Reponse body

200 - OK

ControllerRevision schema

201 - Created

ControllerRevision schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified ControllerRevision

Table 16. 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 17. Body parameters
Parameter Type Description

body

ControllerRevision schema
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

ControllerRevision schema

201 - Created

ControllerRevision schema

401 - Unauthorized

Empty

/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}

Table 19. Global path parameters
Parameter Type Description

name

string

name of the ControllerRevision
HTTP method

GET

Description

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

Table 20. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty