Skip to content

Latest commit

 

History

History
487 lines (304 loc) · 29.4 KB

CertificatesV1beta1Api.md

File metadata and controls

487 lines (304 loc) · 29.4 KB

\CertificatesV1beta1Api

All URIs are relative to http://localhost

Method HTTP request Description
CreateCertificateSigningRequest Post /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
DeleteCertificateSigningRequest Delete /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
DeleteCollectionCertificateSigningRequest Delete /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
GetAPIResources Get /apis/certificates.k8s.io/v1beta1/
ListCertificateSigningRequest Get /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
PatchCertificateSigningRequest Patch /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
PatchCertificateSigningRequestStatus Patch /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
ReadCertificateSigningRequest Get /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
ReadCertificateSigningRequestStatus Get /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
ReplaceCertificateSigningRequest Put /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
ReplaceCertificateSigningRequestApproval Put /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/approval
ReplaceCertificateSigningRequestStatus Put /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

CreateCertificateSigningRequest

V1beta1CertificateSigningRequest CreateCertificateSigningRequest(ctx, body, optional)

create a CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body V1beta1CertificateSigningRequest
optional *CreateCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateCertificateSigningRequestOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCertificateSigningRequest

V1Status DeleteCertificateSigningRequest(ctx, name, optional)

delete a CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
optional *DeleteCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCertificateSigningRequestOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 | gracePeriodSeconds | optional.Int32| 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 | optional.Bool| 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 | optional.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. | body | optional.Interface of V1DeleteOptions| |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCollectionCertificateSigningRequest

V1Status DeleteCollectionCertificateSigningRequest(ctx, optional)

delete collection of CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DeleteCollectionCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionCertificateSigningRequestOpts struct

Name Type Description Notes
includeUninitialized optional.Bool If true, partially initialized resources are included in the response.
pretty optional.String If 'true', then the output is pretty printed.
continue_ optional.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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 optional.String A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector optional.String A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit optional.Int32 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 optional.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 optional.Int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch optional.Bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAPIResources

V1ApiResourceList GetAPIResources(ctx, )

get available resources

Required Parameters

This endpoint does not need any parameter.

Return type

V1ApiResourceList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCertificateSigningRequest

V1beta1CertificateSigningRequestList ListCertificateSigningRequest(ctx, optional)

list or watch objects of kind CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListCertificateSigningRequestOpts struct

Name Type Description Notes
includeUninitialized optional.Bool If true, partially initialized resources are included in the response.
pretty optional.String If 'true', then the output is pretty printed.
continue_ optional.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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 optional.String A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector optional.String A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit optional.Int32 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 optional.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 optional.Int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch optional.Bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1beta1CertificateSigningRequestList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchCertificateSigningRequest

V1beta1CertificateSigningRequest PatchCertificateSigningRequest(ctx, name, body, optional)

partially update the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
body UNKNOWN_BASE_TYPE
optional *PatchCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchCertificateSigningRequestOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchCertificateSigningRequestStatus

V1beta1CertificateSigningRequest PatchCertificateSigningRequestStatus(ctx, name, body, optional)

partially update status of the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
body UNKNOWN_BASE_TYPE
optional *PatchCertificateSigningRequestStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchCertificateSigningRequestStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadCertificateSigningRequest

V1beta1CertificateSigningRequest ReadCertificateSigningRequest(ctx, name, optional)

read the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
optional *ReadCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadCertificateSigningRequestOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | exact | optional.Bool| Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | export | optional.Bool| Should this value be exported. Export strips fields that a user can not specify. |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadCertificateSigningRequestStatus

V1beta1CertificateSigningRequest ReadCertificateSigningRequestStatus(ctx, name, optional)

read status of the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
optional *ReadCertificateSigningRequestStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadCertificateSigningRequestStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceCertificateSigningRequest

V1beta1CertificateSigningRequest ReplaceCertificateSigningRequest(ctx, name, body, optional)

replace the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
body V1beta1CertificateSigningRequest
optional *ReplaceCertificateSigningRequestOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceCertificateSigningRequestOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceCertificateSigningRequestApproval

V1beta1CertificateSigningRequest ReplaceCertificateSigningRequestApproval(ctx, name, body, optional)

replace approval of the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
body V1beta1CertificateSigningRequest
optional *ReplaceCertificateSigningRequestApprovalOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceCertificateSigningRequestApprovalOpts struct

Name Type Description Notes

dryRun | optional.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 | pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceCertificateSigningRequestStatus

V1beta1CertificateSigningRequest ReplaceCertificateSigningRequestStatus(ctx, name, body, optional)

replace status of the specified CertificateSigningRequest

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the CertificateSigningRequest
body V1beta1CertificateSigningRequest
optional *ReplaceCertificateSigningRequestStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceCertificateSigningRequestStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1CertificateSigningRequest

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]