certificateSigningRequest [certificates.k8s.io/v1beta1] - certificates.k8s.io | API reference

Specification
API endpoints

Description: Describes a certificate signing request
Type: object

Specification

Property Type Description

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/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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`
`.spec`	`object`	This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.
`.status`	`object`	Derived information about the request.

.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/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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

.spec

object

This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.

.status

object

Derived information about the request.

.spec

Description

This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.

Type

object

Required

request

Property Type Description

Property	Type	Description
`extra`	`object`	Extra information about the requesting user. See user.Info interface for details.
`extra{}`	`array (string)`
`groups`	`array (string)`	Group information about the requesting user. See user.Info interface for details.
`request`	`string`	Base64-encoded PKCS#10 CSR data
`uid`	`string`	UID information about the requesting user. See user.Info interface for details.
`usages`	`array (string)`	allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12
`username`	`string`	Information about the requesting user. See user.Info interface for details.

extra

object

Extra information about the requesting user. See user.Info interface for details.

extra{}

array (string)

groups

array (string)

Group information about the requesting user. See user.Info interface for details.

request

string

Base64-encoded PKCS#10 CSR data

uid

string

UID information about the requesting user. See user.Info interface for details.

usages

array (string)

allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12

username

string

Information about the requesting user. See user.Info interface for details.

.spec.extra

Description: Extra information about the requesting user. See user.Info interface for details.
Type: object

.status

Description: Derived information about the request.
Type: object

Property Type Description

Property	Type	Description
`certificate`	`string`	If request was approved, the controller will place the issued certificate here.
`conditions`	`array`	Conditions applied to the request, such as approval or denial.
`conditions[]`	`object`

certificate

string

If request was approved, the controller will place the issued certificate here.

conditions

array

Conditions applied to the request, such as approval or denial.

conditions[]

object

.status.conditions

Description: Conditions applied to the request, such as approval or denial.
Type: array

.status.conditions[]

Description

Type

object

Required

type

Property Type Description

Property	Type	Description
`lastUpdateTime`	`Time meta/v1`	timestamp for the last update to this condition
`message`	`string`	human readable message with details about the request state
`reason`	`string`	brief reason for the request state
`type`	`string`	request approval state, currently Approved or Denied.

lastUpdateTime

Time meta/v1

timestamp for the last update to this condition

message

string

human readable message with details about the request state

reason

string

brief reason for the request state

type

string

request approval state, currently Approved or Denied.

API endpoints

The following API endpoints are available:

/apis/certificates.k8s.io/v1beta1/certificatesigningrequests
- DELETE: delete collection of certificateSigningRequest
- GET: list or watch objects of kind certificateSigningRequest
- POST: create a certificateSigningRequest
/apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
- DELETE: delete a certificateSigningRequest
- GET: read the specified certificateSigningRequest
- PATCH: partially update the specified certificateSigningRequest
- PUT: replace the specified certificateSigningRequest
/apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
- GET: read status of the specified certificateSigningRequest
- PATCH: partially update status of the specified certificateSigningRequest
- PUT: replace status of the specified certificateSigningRequest
/apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/approval
- PUT: replace approval of the specified certificateSigningRequest

/apis/certificates.k8s.io/v1beta1/certificatesigningrequests

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of certificateSigningRequest

Table 2. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

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

Table 4. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequestList certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a certificateSigningRequest

Table 6. Body parameters
Parameter	Type	Description
`body`	`certificateSigningRequest certificates.k8s.io/v1beta1`

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
201 - Created	`certificateSigningRequest certificates.k8s.io/v1beta1`
202 - Accepted	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

/apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the certificateSigningRequest

Table 9. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a certificateSigningRequest

Table 10. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	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`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 11. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified certificateSigningRequest

Table 13. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified certificateSigningRequest

Table 15. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified certificateSigningRequest

Table 17. Body parameters
Parameter	Type	Description
`body`	`certificateSigningRequest certificates.k8s.io/v1beta1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
201 - Created	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

/apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

Table 19. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the certificateSigningRequest

Table 20. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

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

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

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

Table 22. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 23. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

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

Table 24. Body parameters
Parameter	Type	Description
`body`	`certificateSigningRequest certificates.k8s.io/v1beta1`

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
201 - Created	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty

/apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/approval

Table 26. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the certificateSigningRequest

Table 27. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: PUT
Description: replace approval of the specified certificateSigningRequest

Table 28. Body parameters
Parameter	Type	Description
`body`	`certificateSigningRequest certificates.k8s.io/v1beta1`

Table 29. HTTP responses
HTTP code	Reponse body
200 - OK	`certificateSigningRequest certificates.k8s.io/v1beta1`
201 - Created	`certificateSigningRequest certificates.k8s.io/v1beta1`
401 - Unauthorized	Empty