website/docs/api-reference/v1.5/documents/_generated_certificatesigni...

13 KiB


CertificateSigningRequest v1alpha1

Group Version Kind
Certificates v1alpha1 CertificateSigningRequest

Describes a certificate signing request

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
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
spec
CertificateSigningRequestSpec
The certificate request itself and any additional information.
status
CertificateSigningRequestStatus
Derived information about the request.

CertificateSigningRequestSpec v1alpha1

Field Description
groups
string array
request
string
Base64-encoded PKCS#10 CSR data
uid
string
username
string
Information about the requesting user (if relevant) See user.Info interface for details

CertificateSigningRequestStatus v1alpha1

Field Description
certificate
string
If request was approved, the controller will place the issued certificate here.
conditions
CertificateSigningRequestCondition array
Conditions applied to the request, such as approval or denial.

CertificateSigningRequestList v1alpha1

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
CertificateSigningRequest array
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

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

create a CertificateSigningRequest

HTTP Request

POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
CertificateSigningRequest

Response

Code Description
200
CertificateSigningRequest
OK

Replace

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

replace the specified CertificateSigningRequest

HTTP Request

PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}

Path Parameters

Parameter Description
name name of the CertificateSigningRequest

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
CertificateSigningRequest

Response

Code Description
200
CertificateSigningRequest
OK

Patch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

partially update the specified CertificateSigningRequest

HTTP Request

PATCH /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}

Path Parameters

Parameter Description
name name of the CertificateSigningRequest

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
CertificateSigningRequest
OK

Delete

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete a CertificateSigningRequest

HTTP Request

DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}

Path Parameters

Parameter Description
name name of the CertificateSigningRequest

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

Response

Code Description
200
Status
OK

Delete Collection

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete collection of CertificateSigningRequest

HTTP Request

DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests

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
OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

read the specified CertificateSigningRequest

HTTP Request

GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}

Path Parameters

Parameter Description
name name of the CertificateSigningRequest

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
CertificateSigningRequest
OK

List

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

list or watch objects of kind CertificateSigningRequest

HTTP Request

GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests

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
CertificateSigningRequestList
OK

Watch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

watch changes to an object of kind CertificateSigningRequest

HTTP Request

GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests/{name}

Path Parameters

Parameter Description
name name of the CertificateSigningRequest

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
OK