Files
c/kubernetes/docs/CoreV1API.md
Kubernetes Prow Robot 6d68c83d69 Automated openapi generation from release-1.29
Signed-off-by: Kubernetes Prow Robot <k8s.ci.robot@gmail.com>
2024-01-23 12:51:46 +00:00

689 KiB

CoreV1API

All URIs are relative to http://localhost

Method HTTP request Description
CoreV1API_connectDeleteNamespacedPodProxy DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectDeleteNamespacedPodProxyWithPath DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectDeleteNamespacedServiceProxy DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectDeleteNamespacedServiceProxyWithPath DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectDeleteNodeProxy DELETE /api/v1/nodes/{name}/proxy
CoreV1API_connectDeleteNodeProxyWithPath DELETE /api/v1/nodes/{name}/proxy/{path}
CoreV1API_connectGetNamespacedPodAttach GET /api/v1/namespaces/{namespace}/pods/{name}/attach
CoreV1API_connectGetNamespacedPodExec GET /api/v1/namespaces/{namespace}/pods/{name}/exec
CoreV1API_connectGetNamespacedPodPortforward GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
CoreV1API_connectGetNamespacedPodProxy GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectGetNamespacedPodProxyWithPath GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectGetNamespacedServiceProxy GET /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectGetNamespacedServiceProxyWithPath GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectGetNodeProxy GET /api/v1/nodes/{name}/proxy
CoreV1API_connectGetNodeProxyWithPath GET /api/v1/nodes/{name}/proxy/{path}
CoreV1API_connectHeadNamespacedPodProxy HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectHeadNamespacedPodProxyWithPath HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectHeadNamespacedServiceProxy HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectHeadNamespacedServiceProxyWithPath HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectHeadNodeProxy HEAD /api/v1/nodes/{name}/proxy
CoreV1API_connectHeadNodeProxyWithPath HEAD /api/v1/nodes/{name}/proxy/{path}
CoreV1API_connectOptionsNamespacedPodProxy OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectOptionsNamespacedPodProxyWithPath OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectOptionsNamespacedServiceProxy OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectOptionsNamespacedServiceProxyWithPath OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectOptionsNodeProxy OPTIONS /api/v1/nodes/{name}/proxy
CoreV1API_connectOptionsNodeProxyWithPath OPTIONS /api/v1/nodes/{name}/proxy/{path}
CoreV1API_connectPatchNamespacedPodProxy PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectPatchNamespacedPodProxyWithPath PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectPatchNamespacedServiceProxy PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectPatchNamespacedServiceProxyWithPath PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectPatchNodeProxy PATCH /api/v1/nodes/{name}/proxy
CoreV1API_connectPatchNodeProxyWithPath PATCH /api/v1/nodes/{name}/proxy/{path}
CoreV1API_connectPostNamespacedPodAttach POST /api/v1/namespaces/{namespace}/pods/{name}/attach
CoreV1API_connectPostNamespacedPodExec POST /api/v1/namespaces/{namespace}/pods/{name}/exec
CoreV1API_connectPostNamespacedPodPortforward POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
CoreV1API_connectPostNamespacedPodProxy POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectPostNamespacedPodProxyWithPath POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectPostNamespacedServiceProxy POST /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectPostNamespacedServiceProxyWithPath POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectPostNodeProxy POST /api/v1/nodes/{name}/proxy
CoreV1API_connectPostNodeProxyWithPath POST /api/v1/nodes/{name}/proxy/{path}
CoreV1API_connectPutNamespacedPodProxy PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
CoreV1API_connectPutNamespacedPodProxyWithPath PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
CoreV1API_connectPutNamespacedServiceProxy PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
CoreV1API_connectPutNamespacedServiceProxyWithPath PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
CoreV1API_connectPutNodeProxy PUT /api/v1/nodes/{name}/proxy
CoreV1API_connectPutNodeProxyWithPath PUT /api/v1/nodes/{name}/proxy/{path}
CoreV1API_createNamespace POST /api/v1/namespaces
CoreV1API_createNamespacedBinding POST /api/v1/namespaces/{namespace}/bindings
CoreV1API_createNamespacedConfigMap POST /api/v1/namespaces/{namespace}/configmaps
CoreV1API_createNamespacedEndpoints POST /api/v1/namespaces/{namespace}/endpoints
CoreV1API_createNamespacedEvent POST /api/v1/namespaces/{namespace}/events
CoreV1API_createNamespacedLimitRange POST /api/v1/namespaces/{namespace}/limitranges
CoreV1API_createNamespacedPersistentVolumeClaim POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
CoreV1API_createNamespacedPod POST /api/v1/namespaces/{namespace}/pods
CoreV1API_createNamespacedPodBinding POST /api/v1/namespaces/{namespace}/pods/{name}/binding
CoreV1API_createNamespacedPodEviction POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
CoreV1API_createNamespacedPodTemplate POST /api/v1/namespaces/{namespace}/podtemplates
CoreV1API_createNamespacedReplicationController POST /api/v1/namespaces/{namespace}/replicationcontrollers
CoreV1API_createNamespacedResourceQuota POST /api/v1/namespaces/{namespace}/resourcequotas
CoreV1API_createNamespacedSecret POST /api/v1/namespaces/{namespace}/secrets
CoreV1API_createNamespacedService POST /api/v1/namespaces/{namespace}/services
CoreV1API_createNamespacedServiceAccount POST /api/v1/namespaces/{namespace}/serviceaccounts
CoreV1API_createNamespacedServiceAccountToken POST /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token
CoreV1API_createNode POST /api/v1/nodes
CoreV1API_createPersistentVolume POST /api/v1/persistentvolumes
CoreV1API_deleteCollectionNamespacedConfigMap DELETE /api/v1/namespaces/{namespace}/configmaps
CoreV1API_deleteCollectionNamespacedEndpoints DELETE /api/v1/namespaces/{namespace}/endpoints
CoreV1API_deleteCollectionNamespacedEvent DELETE /api/v1/namespaces/{namespace}/events
CoreV1API_deleteCollectionNamespacedLimitRange DELETE /api/v1/namespaces/{namespace}/limitranges
CoreV1API_deleteCollectionNamespacedPersistentVolumeClaim DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
CoreV1API_deleteCollectionNamespacedPod DELETE /api/v1/namespaces/{namespace}/pods
CoreV1API_deleteCollectionNamespacedPodTemplate DELETE /api/v1/namespaces/{namespace}/podtemplates
CoreV1API_deleteCollectionNamespacedReplicationController DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
CoreV1API_deleteCollectionNamespacedResourceQuota DELETE /api/v1/namespaces/{namespace}/resourcequotas
CoreV1API_deleteCollectionNamespacedSecret DELETE /api/v1/namespaces/{namespace}/secrets
CoreV1API_deleteCollectionNamespacedService DELETE /api/v1/namespaces/{namespace}/services
CoreV1API_deleteCollectionNamespacedServiceAccount DELETE /api/v1/namespaces/{namespace}/serviceaccounts
CoreV1API_deleteCollectionNode DELETE /api/v1/nodes
CoreV1API_deleteCollectionPersistentVolume DELETE /api/v1/persistentvolumes
CoreV1API_deleteNamespace DELETE /api/v1/namespaces/{name}
CoreV1API_deleteNamespacedConfigMap DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
CoreV1API_deleteNamespacedEndpoints DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
CoreV1API_deleteNamespacedEvent DELETE /api/v1/namespaces/{namespace}/events/{name}
CoreV1API_deleteNamespacedLimitRange DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
CoreV1API_deleteNamespacedPersistentVolumeClaim DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
CoreV1API_deleteNamespacedPod DELETE /api/v1/namespaces/{namespace}/pods/{name}
CoreV1API_deleteNamespacedPodTemplate DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
CoreV1API_deleteNamespacedReplicationController DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
CoreV1API_deleteNamespacedResourceQuota DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
CoreV1API_deleteNamespacedSecret DELETE /api/v1/namespaces/{namespace}/secrets/{name}
CoreV1API_deleteNamespacedService DELETE /api/v1/namespaces/{namespace}/services/{name}
CoreV1API_deleteNamespacedServiceAccount DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
CoreV1API_deleteNode DELETE /api/v1/nodes/{name}
CoreV1API_deletePersistentVolume DELETE /api/v1/persistentvolumes/{name}
CoreV1API_getAPIResources GET /api/v1/
CoreV1API_listComponentStatus GET /api/v1/componentstatuses
CoreV1API_listConfigMapForAllNamespaces GET /api/v1/configmaps
CoreV1API_listEndpointsForAllNamespaces GET /api/v1/endpoints
CoreV1API_listEventForAllNamespaces GET /api/v1/events
CoreV1API_listLimitRangeForAllNamespaces GET /api/v1/limitranges
CoreV1API_listNamespace GET /api/v1/namespaces
CoreV1API_listNamespacedConfigMap GET /api/v1/namespaces/{namespace}/configmaps
CoreV1API_listNamespacedEndpoints GET /api/v1/namespaces/{namespace}/endpoints
CoreV1API_listNamespacedEvent GET /api/v1/namespaces/{namespace}/events
CoreV1API_listNamespacedLimitRange GET /api/v1/namespaces/{namespace}/limitranges
CoreV1API_listNamespacedPersistentVolumeClaim GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
CoreV1API_listNamespacedPod GET /api/v1/namespaces/{namespace}/pods
CoreV1API_listNamespacedPodTemplate GET /api/v1/namespaces/{namespace}/podtemplates
CoreV1API_listNamespacedReplicationController GET /api/v1/namespaces/{namespace}/replicationcontrollers
CoreV1API_listNamespacedResourceQuota GET /api/v1/namespaces/{namespace}/resourcequotas
CoreV1API_listNamespacedSecret GET /api/v1/namespaces/{namespace}/secrets
CoreV1API_listNamespacedService GET /api/v1/namespaces/{namespace}/services
CoreV1API_listNamespacedServiceAccount GET /api/v1/namespaces/{namespace}/serviceaccounts
CoreV1API_listNode GET /api/v1/nodes
CoreV1API_listPersistentVolume GET /api/v1/persistentvolumes
CoreV1API_listPersistentVolumeClaimForAllNamespaces GET /api/v1/persistentvolumeclaims
CoreV1API_listPodForAllNamespaces GET /api/v1/pods
CoreV1API_listPodTemplateForAllNamespaces GET /api/v1/podtemplates
CoreV1API_listReplicationControllerForAllNamespaces GET /api/v1/replicationcontrollers
CoreV1API_listResourceQuotaForAllNamespaces GET /api/v1/resourcequotas
CoreV1API_listSecretForAllNamespaces GET /api/v1/secrets
CoreV1API_listServiceAccountForAllNamespaces GET /api/v1/serviceaccounts
CoreV1API_listServiceForAllNamespaces GET /api/v1/services
CoreV1API_patchNamespace PATCH /api/v1/namespaces/{name}
CoreV1API_patchNamespaceStatus PATCH /api/v1/namespaces/{name}/status
CoreV1API_patchNamespacedConfigMap PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
CoreV1API_patchNamespacedEndpoints PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
CoreV1API_patchNamespacedEvent PATCH /api/v1/namespaces/{namespace}/events/{name}
CoreV1API_patchNamespacedLimitRange PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
CoreV1API_patchNamespacedPersistentVolumeClaim PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
CoreV1API_patchNamespacedPersistentVolumeClaimStatus PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
CoreV1API_patchNamespacedPod PATCH /api/v1/namespaces/{namespace}/pods/{name}
CoreV1API_patchNamespacedPodEphemeralcontainers PATCH /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
CoreV1API_patchNamespacedPodStatus PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
CoreV1API_patchNamespacedPodTemplate PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
CoreV1API_patchNamespacedReplicationController PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
CoreV1API_patchNamespacedReplicationControllerScale PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
CoreV1API_patchNamespacedReplicationControllerStatus PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
CoreV1API_patchNamespacedResourceQuota PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
CoreV1API_patchNamespacedResourceQuotaStatus PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
CoreV1API_patchNamespacedSecret PATCH /api/v1/namespaces/{namespace}/secrets/{name}
CoreV1API_patchNamespacedService PATCH /api/v1/namespaces/{namespace}/services/{name}
CoreV1API_patchNamespacedServiceAccount PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
CoreV1API_patchNamespacedServiceStatus PATCH /api/v1/namespaces/{namespace}/services/{name}/status
CoreV1API_patchNode PATCH /api/v1/nodes/{name}
CoreV1API_patchNodeStatus PATCH /api/v1/nodes/{name}/status
CoreV1API_patchPersistentVolume PATCH /api/v1/persistentvolumes/{name}
CoreV1API_patchPersistentVolumeStatus PATCH /api/v1/persistentvolumes/{name}/status
CoreV1API_readComponentStatus GET /api/v1/componentstatuses/{name}
CoreV1API_readNamespace GET /api/v1/namespaces/{name}
CoreV1API_readNamespaceStatus GET /api/v1/namespaces/{name}/status
CoreV1API_readNamespacedConfigMap GET /api/v1/namespaces/{namespace}/configmaps/{name}
CoreV1API_readNamespacedEndpoints GET /api/v1/namespaces/{namespace}/endpoints/{name}
CoreV1API_readNamespacedEvent GET /api/v1/namespaces/{namespace}/events/{name}
CoreV1API_readNamespacedLimitRange GET /api/v1/namespaces/{namespace}/limitranges/{name}
CoreV1API_readNamespacedPersistentVolumeClaim GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
CoreV1API_readNamespacedPersistentVolumeClaimStatus GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
CoreV1API_readNamespacedPod GET /api/v1/namespaces/{namespace}/pods/{name}
CoreV1API_readNamespacedPodEphemeralcontainers GET /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
CoreV1API_readNamespacedPodLog GET /api/v1/namespaces/{namespace}/pods/{name}/log
CoreV1API_readNamespacedPodStatus GET /api/v1/namespaces/{namespace}/pods/{name}/status
CoreV1API_readNamespacedPodTemplate GET /api/v1/namespaces/{namespace}/podtemplates/{name}
CoreV1API_readNamespacedReplicationController GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
CoreV1API_readNamespacedReplicationControllerScale GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
CoreV1API_readNamespacedReplicationControllerStatus GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
CoreV1API_readNamespacedResourceQuota GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
CoreV1API_readNamespacedResourceQuotaStatus GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
CoreV1API_readNamespacedSecret GET /api/v1/namespaces/{namespace}/secrets/{name}
CoreV1API_readNamespacedService GET /api/v1/namespaces/{namespace}/services/{name}
CoreV1API_readNamespacedServiceAccount GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
CoreV1API_readNamespacedServiceStatus GET /api/v1/namespaces/{namespace}/services/{name}/status
CoreV1API_readNode GET /api/v1/nodes/{name}
CoreV1API_readNodeStatus GET /api/v1/nodes/{name}/status
CoreV1API_readPersistentVolume GET /api/v1/persistentvolumes/{name}
CoreV1API_readPersistentVolumeStatus GET /api/v1/persistentvolumes/{name}/status
CoreV1API_replaceNamespace PUT /api/v1/namespaces/{name}
CoreV1API_replaceNamespaceFinalize PUT /api/v1/namespaces/{name}/finalize
CoreV1API_replaceNamespaceStatus PUT /api/v1/namespaces/{name}/status
CoreV1API_replaceNamespacedConfigMap PUT /api/v1/namespaces/{namespace}/configmaps/{name}
CoreV1API_replaceNamespacedEndpoints PUT /api/v1/namespaces/{namespace}/endpoints/{name}
CoreV1API_replaceNamespacedEvent PUT /api/v1/namespaces/{namespace}/events/{name}
CoreV1API_replaceNamespacedLimitRange PUT /api/v1/namespaces/{namespace}/limitranges/{name}
CoreV1API_replaceNamespacedPersistentVolumeClaim PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
CoreV1API_replaceNamespacedPersistentVolumeClaimStatus PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
CoreV1API_replaceNamespacedPod PUT /api/v1/namespaces/{namespace}/pods/{name}
CoreV1API_replaceNamespacedPodEphemeralcontainers PUT /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
CoreV1API_replaceNamespacedPodStatus PUT /api/v1/namespaces/{namespace}/pods/{name}/status
CoreV1API_replaceNamespacedPodTemplate PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
CoreV1API_replaceNamespacedReplicationController PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
CoreV1API_replaceNamespacedReplicationControllerScale PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
CoreV1API_replaceNamespacedReplicationControllerStatus PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
CoreV1API_replaceNamespacedResourceQuota PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
CoreV1API_replaceNamespacedResourceQuotaStatus PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
CoreV1API_replaceNamespacedSecret PUT /api/v1/namespaces/{namespace}/secrets/{name}
CoreV1API_replaceNamespacedService PUT /api/v1/namespaces/{namespace}/services/{name}
CoreV1API_replaceNamespacedServiceAccount PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
CoreV1API_replaceNamespacedServiceStatus PUT /api/v1/namespaces/{namespace}/services/{name}/status
CoreV1API_replaceNode PUT /api/v1/nodes/{name}
CoreV1API_replaceNodeStatus PUT /api/v1/nodes/{name}/status
CoreV1API_replacePersistentVolume PUT /api/v1/persistentvolumes/{name}
CoreV1API_replacePersistentVolumeStatus PUT /api/v1/persistentvolumes/{name}/status

CoreV1API_connectDeleteNamespacedPodProxy

// connect DELETE requests to proxy of Pod
//
char* CoreV1API_connectDeleteNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectDeleteNamespacedPodProxyWithPath

// connect DELETE requests to proxy of Pod
//
char* CoreV1API_connectDeleteNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectDeleteNamespacedServiceProxy

// connect DELETE requests to proxy of Service
//
char* CoreV1API_connectDeleteNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectDeleteNamespacedServiceProxyWithPath

// connect DELETE requests to proxy of Service
//
char* CoreV1API_connectDeleteNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectDeleteNodeProxy

// connect DELETE requests to proxy of Node
//
char* CoreV1API_connectDeleteNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectDeleteNodeProxyWithPath

// connect DELETE requests to proxy of Node
//
char* CoreV1API_connectDeleteNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedPodAttach

// connect GET requests to attach of Pod
//
char* CoreV1API_connectGetNamespacedPodAttach(apiClient_t *apiClient, char *name, char *_namespace, char *container, int *_stderr, int *_stdin, int *_stdout, int *tty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodAttachOptions
_namespace char * object name and auth scope, such as for teams and projects
container char * The container in which to execute the command. Defaults to only container if there is only one container in the pod. [optional]
_stderr int * Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. [optional]
_stdin int * Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. [optional]
_stdout int * Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. [optional]
tty int * TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedPodExec

// connect GET requests to exec of Pod
//
char* CoreV1API_connectGetNamespacedPodExec(apiClient_t *apiClient, char *name, char *_namespace, char *command, char *container, int *_stderr, int *_stdin, int *_stdout, int *tty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodExecOptions
_namespace char * object name and auth scope, such as for teams and projects
command char * Command is the remote command to execute. argv array. Not executed within a shell. [optional]
container char * Container in which to execute the command. Defaults to only container if there is only one container in the pod. [optional]
_stderr int * Redirect the standard error stream of the pod for this call. [optional]
_stdin int * Redirect the standard input stream of the pod for this call. Defaults to false. [optional]
_stdout int * Redirect the standard output stream of the pod for this call. [optional]
tty int * TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedPodPortforward

// connect GET requests to portforward of Pod
//
char* CoreV1API_connectGetNamespacedPodPortforward(apiClient_t *apiClient, char *name, char *_namespace, int *ports);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodPortForwardOptions
_namespace char * object name and auth scope, such as for teams and projects
ports int * List of ports to forward Required when using WebSockets [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedPodProxy

// connect GET requests to proxy of Pod
//
char* CoreV1API_connectGetNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedPodProxyWithPath

// connect GET requests to proxy of Pod
//
char* CoreV1API_connectGetNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedServiceProxy

// connect GET requests to proxy of Service
//
char* CoreV1API_connectGetNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNamespacedServiceProxyWithPath

// connect GET requests to proxy of Service
//
char* CoreV1API_connectGetNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNodeProxy

// connect GET requests to proxy of Node
//
char* CoreV1API_connectGetNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectGetNodeProxyWithPath

// connect GET requests to proxy of Node
//
char* CoreV1API_connectGetNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectHeadNamespacedPodProxy

// connect HEAD requests to proxy of Pod
//
char* CoreV1API_connectHeadNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectHeadNamespacedPodProxyWithPath

// connect HEAD requests to proxy of Pod
//
char* CoreV1API_connectHeadNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectHeadNamespacedServiceProxy

// connect HEAD requests to proxy of Service
//
char* CoreV1API_connectHeadNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectHeadNamespacedServiceProxyWithPath

// connect HEAD requests to proxy of Service
//
char* CoreV1API_connectHeadNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectHeadNodeProxy

// connect HEAD requests to proxy of Node
//
char* CoreV1API_connectHeadNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectHeadNodeProxyWithPath

// connect HEAD requests to proxy of Node
//
char* CoreV1API_connectHeadNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectOptionsNamespacedPodProxy

// connect OPTIONS requests to proxy of Pod
//
char* CoreV1API_connectOptionsNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectOptionsNamespacedPodProxyWithPath

// connect OPTIONS requests to proxy of Pod
//
char* CoreV1API_connectOptionsNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectOptionsNamespacedServiceProxy

// connect OPTIONS requests to proxy of Service
//
char* CoreV1API_connectOptionsNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectOptionsNamespacedServiceProxyWithPath

// connect OPTIONS requests to proxy of Service
//
char* CoreV1API_connectOptionsNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectOptionsNodeProxy

// connect OPTIONS requests to proxy of Node
//
char* CoreV1API_connectOptionsNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectOptionsNodeProxyWithPath

// connect OPTIONS requests to proxy of Node
//
char* CoreV1API_connectOptionsNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPatchNamespacedPodProxy

// connect PATCH requests to proxy of Pod
//
char* CoreV1API_connectPatchNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPatchNamespacedPodProxyWithPath

// connect PATCH requests to proxy of Pod
//
char* CoreV1API_connectPatchNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPatchNamespacedServiceProxy

// connect PATCH requests to proxy of Service
//
char* CoreV1API_connectPatchNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPatchNamespacedServiceProxyWithPath

// connect PATCH requests to proxy of Service
//
char* CoreV1API_connectPatchNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPatchNodeProxy

// connect PATCH requests to proxy of Node
//
char* CoreV1API_connectPatchNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPatchNodeProxyWithPath

// connect PATCH requests to proxy of Node
//
char* CoreV1API_connectPatchNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedPodAttach

// connect POST requests to attach of Pod
//
char* CoreV1API_connectPostNamespacedPodAttach(apiClient_t *apiClient, char *name, char *_namespace, char *container, int *_stderr, int *_stdin, int *_stdout, int *tty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodAttachOptions
_namespace char * object name and auth scope, such as for teams and projects
container char * The container in which to execute the command. Defaults to only container if there is only one container in the pod. [optional]
_stderr int * Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. [optional]
_stdin int * Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. [optional]
_stdout int * Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. [optional]
tty int * TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedPodExec

// connect POST requests to exec of Pod
//
char* CoreV1API_connectPostNamespacedPodExec(apiClient_t *apiClient, char *name, char *_namespace, char *command, char *container, int *_stderr, int *_stdin, int *_stdout, int *tty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodExecOptions
_namespace char * object name and auth scope, such as for teams and projects
command char * Command is the remote command to execute. argv array. Not executed within a shell. [optional]
container char * Container in which to execute the command. Defaults to only container if there is only one container in the pod. [optional]
_stderr int * Redirect the standard error stream of the pod for this call. [optional]
_stdin int * Redirect the standard input stream of the pod for this call. Defaults to false. [optional]
_stdout int * Redirect the standard output stream of the pod for this call. [optional]
tty int * TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedPodPortforward

// connect POST requests to portforward of Pod
//
char* CoreV1API_connectPostNamespacedPodPortforward(apiClient_t *apiClient, char *name, char *_namespace, int *ports);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodPortForwardOptions
_namespace char * object name and auth scope, such as for teams and projects
ports int * List of ports to forward Required when using WebSockets [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedPodProxy

// connect POST requests to proxy of Pod
//
char* CoreV1API_connectPostNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedPodProxyWithPath

// connect POST requests to proxy of Pod
//
char* CoreV1API_connectPostNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedServiceProxy

// connect POST requests to proxy of Service
//
char* CoreV1API_connectPostNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNamespacedServiceProxyWithPath

// connect POST requests to proxy of Service
//
char* CoreV1API_connectPostNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNodeProxy

// connect POST requests to proxy of Node
//
char* CoreV1API_connectPostNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPostNodeProxyWithPath

// connect POST requests to proxy of Node
//
char* CoreV1API_connectPostNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPutNamespacedPodProxy

// connect PUT requests to proxy of Pod
//
char* CoreV1API_connectPutNamespacedPodProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPutNamespacedPodProxyWithPath

// connect PUT requests to proxy of Pod
//
char* CoreV1API_connectPutNamespacedPodProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to pod. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPutNamespacedServiceProxy

// connect PUT requests to proxy of Service
//
char* CoreV1API_connectPutNamespacedServiceProxy(apiClient_t *apiClient, char *name, char *_namespace, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPutNamespacedServiceProxyWithPath

// connect PUT requests to proxy of Service
//
char* CoreV1API_connectPutNamespacedServiceProxyWithPath(apiClient_t *apiClient, char *name, char *_namespace, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceProxyOptions
_namespace char * object name and auth scope, such as for teams and projects
path char * path to the resource
path2 char * Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPutNodeProxy

// connect PUT requests to proxy of Node
//
char* CoreV1API_connectPutNodeProxy(apiClient_t *apiClient, char *name, char *path);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_connectPutNodeProxyWithPath

// connect PUT requests to proxy of Node
//
char* CoreV1API_connectPutNodeProxyWithPath(apiClient_t *apiClient, char *name, char *path, char *path2);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the NodeProxyOptions
path char * path to the resource
path2 char * Path is the URL path to use for the current proxy request to node. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

CoreV1API_createNamespace

// create a Namespace
//
v1_namespace_t* CoreV1API_createNamespace(apiClient_t *apiClient, v1_namespace_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_namespace_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_namespace_t *

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]

CoreV1API_createNamespacedBinding

// create a Binding
//
v1_binding_t* CoreV1API_createNamespacedBinding(apiClient_t *apiClient, char *_namespace, v1_binding_t *body, char *dryRun, char *fieldManager, char *fieldValidation, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_binding_t *
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_binding_t *

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]

CoreV1API_createNamespacedConfigMap

// create a ConfigMap
//
v1_config_map_t* CoreV1API_createNamespacedConfigMap(apiClient_t *apiClient, char *_namespace, v1_config_map_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_config_map_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_config_map_t *

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]

CoreV1API_createNamespacedEndpoints

// create Endpoints
//
v1_endpoints_t* CoreV1API_createNamespacedEndpoints(apiClient_t *apiClient, char *_namespace, v1_endpoints_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_endpoints_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_endpoints_t *

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]

CoreV1API_createNamespacedEvent

// create an Event
//
core_v1_event_t* CoreV1API_createNamespacedEvent(apiClient_t *apiClient, char *_namespace, core_v1_event_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body core_v1_event_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

core_v1_event_t *

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]

CoreV1API_createNamespacedLimitRange

// create a LimitRange
//
v1_limit_range_t* CoreV1API_createNamespacedLimitRange(apiClient_t *apiClient, char *_namespace, v1_limit_range_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_limit_range_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_limit_range_t *

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]

CoreV1API_createNamespacedPersistentVolumeClaim

// create a PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_createNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *_namespace, v1_persistent_volume_claim_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_persistent_volume_claim_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_persistent_volume_claim_t *

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]

CoreV1API_createNamespacedPod

// create a Pod
//
v1_pod_t* CoreV1API_createNamespacedPod(apiClient_t *apiClient, char *_namespace, v1_pod_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_pod_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_pod_t *

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]

CoreV1API_createNamespacedPodBinding

// create binding of a Pod
//
v1_binding_t* CoreV1API_createNamespacedPodBinding(apiClient_t *apiClient, char *name, char *_namespace, v1_binding_t *body, char *dryRun, char *fieldManager, char *fieldValidation, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Binding
_namespace char * object name and auth scope, such as for teams and projects
body v1_binding_t *
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_binding_t *

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]

CoreV1API_createNamespacedPodEviction

// create eviction of a Pod
//
v1_eviction_t* CoreV1API_createNamespacedPodEviction(apiClient_t *apiClient, char *name, char *_namespace, v1_eviction_t *body, char *dryRun, char *fieldManager, char *fieldValidation, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Eviction
_namespace char * object name and auth scope, such as for teams and projects
body v1_eviction_t *
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_eviction_t *

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]

CoreV1API_createNamespacedPodTemplate

// create a PodTemplate
//
v1_pod_template_t* CoreV1API_createNamespacedPodTemplate(apiClient_t *apiClient, char *_namespace, v1_pod_template_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_pod_template_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_pod_template_t *

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]

CoreV1API_createNamespacedReplicationController

// create a ReplicationController
//
v1_replication_controller_t* CoreV1API_createNamespacedReplicationController(apiClient_t *apiClient, char *_namespace, v1_replication_controller_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_replication_controller_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_replication_controller_t *

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]

CoreV1API_createNamespacedResourceQuota

// create a ResourceQuota
//
v1_resource_quota_t* CoreV1API_createNamespacedResourceQuota(apiClient_t *apiClient, char *_namespace, v1_resource_quota_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_resource_quota_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_resource_quota_t *

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]

CoreV1API_createNamespacedSecret

// create a Secret
//
v1_secret_t* CoreV1API_createNamespacedSecret(apiClient_t *apiClient, char *_namespace, v1_secret_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_secret_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_secret_t *

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]

CoreV1API_createNamespacedService

// create a Service
//
v1_service_t* CoreV1API_createNamespacedService(apiClient_t *apiClient, char *_namespace, v1_service_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_service_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_service_t *

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]

CoreV1API_createNamespacedServiceAccount

// create a ServiceAccount
//
v1_service_account_t* CoreV1API_createNamespacedServiceAccount(apiClient_t *apiClient, char *_namespace, v1_service_account_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1_service_account_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_service_account_t *

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]

CoreV1API_createNamespacedServiceAccountToken

// create token of a ServiceAccount
//
authentication_v1_token_request_t* CoreV1API_createNamespacedServiceAccountToken(apiClient_t *apiClient, char *name, char *_namespace, authentication_v1_token_request_t *body, char *dryRun, char *fieldManager, char *fieldValidation, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the TokenRequest
_namespace char * object name and auth scope, such as for teams and projects
body authentication_v1_token_request_t *
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

authentication_v1_token_request_t *

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]

CoreV1API_createNode

// create a Node
//
v1_node_t* CoreV1API_createNode(apiClient_t *apiClient, v1_node_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_node_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_node_t *

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]

CoreV1API_createPersistentVolume

// create a PersistentVolume
//
v1_persistent_volume_t* CoreV1API_createPersistentVolume(apiClient_t *apiClient, v1_persistent_volume_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_persistent_volume_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_persistent_volume_t *

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]

CoreV1API_deleteCollectionNamespacedConfigMap

// delete collection of ConfigMap
//
v1_status_t* CoreV1API_deleteCollectionNamespacedConfigMap(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedEndpoints

// delete collection of Endpoints
//
v1_status_t* CoreV1API_deleteCollectionNamespacedEndpoints(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedEvent

// delete collection of Event
//
v1_status_t* CoreV1API_deleteCollectionNamespacedEvent(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedLimitRange

// delete collection of LimitRange
//
v1_status_t* CoreV1API_deleteCollectionNamespacedLimitRange(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedPersistentVolumeClaim

// delete collection of PersistentVolumeClaim
//
v1_status_t* CoreV1API_deleteCollectionNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedPod

// delete collection of Pod
//
v1_status_t* CoreV1API_deleteCollectionNamespacedPod(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedPodTemplate

// delete collection of PodTemplate
//
v1_status_t* CoreV1API_deleteCollectionNamespacedPodTemplate(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedReplicationController

// delete collection of ReplicationController
//
v1_status_t* CoreV1API_deleteCollectionNamespacedReplicationController(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedResourceQuota

// delete collection of ResourceQuota
//
v1_status_t* CoreV1API_deleteCollectionNamespacedResourceQuota(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedSecret

// delete collection of Secret
//
v1_status_t* CoreV1API_deleteCollectionNamespacedSecret(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedService

// delete collection of Service
//
v1_status_t* CoreV1API_deleteCollectionNamespacedService(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNamespacedServiceAccount

// delete collection of ServiceAccount
//
v1_status_t* CoreV1API_deleteCollectionNamespacedServiceAccount(apiClient_t *apiClient, char *_namespace, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionNode

// delete collection of Node
//
v1_status_t* CoreV1API_deleteCollectionNode(apiClient_t *apiClient, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteCollectionPersistentVolume

// delete collection of PersistentVolume
//
v1_status_t* CoreV1API_deleteCollectionPersistentVolume(apiClient_t *apiClient, char *pretty, char *_continue, char *dryRun, char *fieldSelector, int *gracePeriodSeconds, char *labelSelector, int *limit, int *orphanDependents, char *propagationPolicy, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int * 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespace

// delete a Namespace
//
v1_status_t* CoreV1API_deleteNamespace(apiClient_t *apiClient, char *name, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedConfigMap

// delete a ConfigMap
//
v1_status_t* CoreV1API_deleteNamespacedConfigMap(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ConfigMap
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedEndpoints

// delete Endpoints
//
v1_status_t* CoreV1API_deleteNamespacedEndpoints(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Endpoints
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedEvent

// delete an Event
//
v1_status_t* CoreV1API_deleteNamespacedEvent(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Event
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedLimitRange

// delete a LimitRange
//
v1_status_t* CoreV1API_deleteNamespacedLimitRange(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the LimitRange
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedPersistentVolumeClaim

// delete a PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_deleteNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_persistent_volume_claim_t *

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]

CoreV1API_deleteNamespacedPod

// delete a Pod
//
v1_pod_t* CoreV1API_deleteNamespacedPod(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_pod_t *

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]

CoreV1API_deleteNamespacedPodTemplate

// delete a PodTemplate
//
v1_pod_template_t* CoreV1API_deleteNamespacedPodTemplate(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodTemplate
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_pod_template_t *

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]

CoreV1API_deleteNamespacedReplicationController

// delete a ReplicationController
//
v1_status_t* CoreV1API_deleteNamespacedReplicationController(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedResourceQuota

// delete a ResourceQuota
//
v1_resource_quota_t* CoreV1API_deleteNamespacedResourceQuota(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_resource_quota_t *

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]

CoreV1API_deleteNamespacedSecret

// delete a Secret
//
v1_status_t* CoreV1API_deleteNamespacedSecret(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Secret
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deleteNamespacedService

// delete a Service
//
v1_service_t* CoreV1API_deleteNamespacedService(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_service_t *

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]

CoreV1API_deleteNamespacedServiceAccount

// delete a ServiceAccount
//
v1_service_account_t* CoreV1API_deleteNamespacedServiceAccount(apiClient_t *apiClient, char *name, char *_namespace, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceAccount
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_service_account_t *

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]

CoreV1API_deleteNode

// delete a Node
//
v1_status_t* CoreV1API_deleteNode(apiClient_t *apiClient, char *name, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

CoreV1API_deletePersistentVolume

// delete a PersistentVolume
//
v1_persistent_volume_t* CoreV1API_deletePersistentVolume(apiClient_t *apiClient, char *name, char *pretty, char *dryRun, int *gracePeriodSeconds, int *orphanDependents, char *propagationPolicy, v1_delete_options_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int * 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. [optional]
orphanDependents int * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_persistent_volume_t *

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]

CoreV1API_getAPIResources

// get available resources
//
v1_api_resource_list_t* CoreV1API_getAPIResources(apiClient_t *apiClient);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration

Return type

v1_api_resource_list_t *

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]

CoreV1API_listComponentStatus

// list objects of kind ComponentStatus
//
v1_component_status_list_t* CoreV1API_listComponentStatus(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_component_status_list_t *

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]

CoreV1API_listConfigMapForAllNamespaces

// list or watch objects of kind ConfigMap
//
v1_config_map_list_t* CoreV1API_listConfigMapForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_config_map_list_t *

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]

CoreV1API_listEndpointsForAllNamespaces

// list or watch objects of kind Endpoints
//
v1_endpoints_list_t* CoreV1API_listEndpointsForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_endpoints_list_t *

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]

CoreV1API_listEventForAllNamespaces

// list or watch objects of kind Event
//
core_v1_event_list_t* CoreV1API_listEventForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

core_v1_event_list_t *

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]

CoreV1API_listLimitRangeForAllNamespaces

// list or watch objects of kind LimitRange
//
v1_limit_range_list_t* CoreV1API_listLimitRangeForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_limit_range_list_t *

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]

CoreV1API_listNamespace

// list or watch objects of kind Namespace
//
v1_namespace_list_t* CoreV1API_listNamespace(apiClient_t *apiClient, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_namespace_list_t *

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]

CoreV1API_listNamespacedConfigMap

// list or watch objects of kind ConfigMap
//
v1_config_map_list_t* CoreV1API_listNamespacedConfigMap(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_config_map_list_t *

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]

CoreV1API_listNamespacedEndpoints

// list or watch objects of kind Endpoints
//
v1_endpoints_list_t* CoreV1API_listNamespacedEndpoints(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_endpoints_list_t *

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]

CoreV1API_listNamespacedEvent

// list or watch objects of kind Event
//
core_v1_event_list_t* CoreV1API_listNamespacedEvent(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

core_v1_event_list_t *

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]

CoreV1API_listNamespacedLimitRange

// list or watch objects of kind LimitRange
//
v1_limit_range_list_t* CoreV1API_listNamespacedLimitRange(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_limit_range_list_t *

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]

CoreV1API_listNamespacedPersistentVolumeClaim

// list or watch objects of kind PersistentVolumeClaim
//
v1_persistent_volume_claim_list_t* CoreV1API_listNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_persistent_volume_claim_list_t *

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]

CoreV1API_listNamespacedPod

// list or watch objects of kind Pod
//
v1_pod_list_t* CoreV1API_listNamespacedPod(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_pod_list_t *

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]

CoreV1API_listNamespacedPodTemplate

// list or watch objects of kind PodTemplate
//
v1_pod_template_list_t* CoreV1API_listNamespacedPodTemplate(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_pod_template_list_t *

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]

CoreV1API_listNamespacedReplicationController

// list or watch objects of kind ReplicationController
//
v1_replication_controller_list_t* CoreV1API_listNamespacedReplicationController(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_replication_controller_list_t *

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]

CoreV1API_listNamespacedResourceQuota

// list or watch objects of kind ResourceQuota
//
v1_resource_quota_list_t* CoreV1API_listNamespacedResourceQuota(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_resource_quota_list_t *

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]

CoreV1API_listNamespacedSecret

// list or watch objects of kind Secret
//
v1_secret_list_t* CoreV1API_listNamespacedSecret(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_secret_list_t *

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]

CoreV1API_listNamespacedService

// list or watch objects of kind Service
//
v1_service_list_t* CoreV1API_listNamespacedService(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_service_list_t *

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]

CoreV1API_listNamespacedServiceAccount

// list or watch objects of kind ServiceAccount
//
v1_service_account_list_t* CoreV1API_listNamespacedServiceAccount(apiClient_t *apiClient, char *_namespace, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_service_account_list_t *

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]

CoreV1API_listNode

// list or watch objects of kind Node
//
v1_node_list_t* CoreV1API_listNode(apiClient_t *apiClient, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_node_list_t *

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]

CoreV1API_listPersistentVolume

// list or watch objects of kind PersistentVolume
//
v1_persistent_volume_list_t* CoreV1API_listPersistentVolume(apiClient_t *apiClient, char *pretty, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_persistent_volume_list_t *

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]

CoreV1API_listPersistentVolumeClaimForAllNamespaces

// list or watch objects of kind PersistentVolumeClaim
//
v1_persistent_volume_claim_list_t* CoreV1API_listPersistentVolumeClaimForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_persistent_volume_claim_list_t *

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]

CoreV1API_listPodForAllNamespaces

// list or watch objects of kind Pod
//
v1_pod_list_t* CoreV1API_listPodForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_pod_list_t *

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]

CoreV1API_listPodTemplateForAllNamespaces

// list or watch objects of kind PodTemplate
//
v1_pod_template_list_t* CoreV1API_listPodTemplateForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_pod_template_list_t *

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]

CoreV1API_listReplicationControllerForAllNamespaces

// list or watch objects of kind ReplicationController
//
v1_replication_controller_list_t* CoreV1API_listReplicationControllerForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_replication_controller_list_t *

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]

CoreV1API_listResourceQuotaForAllNamespaces

// list or watch objects of kind ResourceQuota
//
v1_resource_quota_list_t* CoreV1API_listResourceQuotaForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_resource_quota_list_t *

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]

CoreV1API_listSecretForAllNamespaces

// list or watch objects of kind Secret
//
v1_secret_list_t* CoreV1API_listSecretForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_secret_list_t *

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]

CoreV1API_listServiceAccountForAllNamespaces

// list or watch objects of kind ServiceAccount
//
v1_service_account_list_t* CoreV1API_listServiceAccountForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_service_account_list_t *

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]

CoreV1API_listServiceForAllNamespaces

// list or watch objects of kind Service
//
v1_service_list_t* CoreV1API_listServiceForAllNamespaces(apiClient_t *apiClient, int *allowWatchBookmarks, char *_continue, char *fieldSelector, char *labelSelector, int *limit, char *pretty, char *resourceVersion, char *resourceVersionMatch, int *sendInitialEvents, int *timeoutSeconds, int *watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int * allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * 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 &quot;next key&quot;. 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
sendInitialEvents int * `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as &quot;data at least as new as the provided `resourceVersion`&quot; and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=&quot;&quot;` or `resourceVersion=&quot;0&quot;` (for backward compatibility reasons) and to false otherwise. [optional]
timeoutSeconds int * Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int * Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_service_list_t *

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]

CoreV1API_patchNamespace

// partially update the specified Namespace
//
v1_namespace_t* CoreV1API_patchNamespace(apiClient_t *apiClient, char *name, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_namespace_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespaceStatus

// partially update status of the specified Namespace
//
v1_namespace_t* CoreV1API_patchNamespaceStatus(apiClient_t *apiClient, char *name, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_namespace_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedConfigMap

// partially update the specified ConfigMap
//
v1_config_map_t* CoreV1API_patchNamespacedConfigMap(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ConfigMap
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_config_map_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedEndpoints

// partially update the specified Endpoints
//
v1_endpoints_t* CoreV1API_patchNamespacedEndpoints(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Endpoints
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_endpoints_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedEvent

// partially update the specified Event
//
core_v1_event_t* CoreV1API_patchNamespacedEvent(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Event
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

core_v1_event_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedLimitRange

// partially update the specified LimitRange
//
v1_limit_range_t* CoreV1API_patchNamespacedLimitRange(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the LimitRange
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_limit_range_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedPersistentVolumeClaim

// partially update the specified PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_patchNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_persistent_volume_claim_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedPersistentVolumeClaimStatus

// partially update status of the specified PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_patchNamespacedPersistentVolumeClaimStatus(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_persistent_volume_claim_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedPod

// partially update the specified Pod
//
v1_pod_t* CoreV1API_patchNamespacedPod(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_pod_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedPodEphemeralcontainers

// partially update ephemeralcontainers of the specified Pod
//
v1_pod_t* CoreV1API_patchNamespacedPodEphemeralcontainers(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_pod_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedPodStatus

// partially update status of the specified Pod
//
v1_pod_t* CoreV1API_patchNamespacedPodStatus(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_pod_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedPodTemplate

// partially update the specified PodTemplate
//
v1_pod_template_t* CoreV1API_patchNamespacedPodTemplate(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodTemplate
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_pod_template_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedReplicationController

// partially update the specified ReplicationController
//
v1_replication_controller_t* CoreV1API_patchNamespacedReplicationController(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_replication_controller_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedReplicationControllerScale

// partially update scale of the specified ReplicationController
//
v1_scale_t* CoreV1API_patchNamespacedReplicationControllerScale(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Scale
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_scale_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedReplicationControllerStatus

// partially update status of the specified ReplicationController
//
v1_replication_controller_t* CoreV1API_patchNamespacedReplicationControllerStatus(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_replication_controller_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedResourceQuota

// partially update the specified ResourceQuota
//
v1_resource_quota_t* CoreV1API_patchNamespacedResourceQuota(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_resource_quota_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedResourceQuotaStatus

// partially update status of the specified ResourceQuota
//
v1_resource_quota_t* CoreV1API_patchNamespacedResourceQuotaStatus(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_resource_quota_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedSecret

// partially update the specified Secret
//
v1_secret_t* CoreV1API_patchNamespacedSecret(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Secret
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_secret_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedService

// partially update the specified Service
//
v1_service_t* CoreV1API_patchNamespacedService(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_service_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedServiceAccount

// partially update the specified ServiceAccount
//
v1_service_account_t* CoreV1API_patchNamespacedServiceAccount(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceAccount
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_service_account_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNamespacedServiceStatus

// partially update status of the specified Service
//
v1_service_t* CoreV1API_patchNamespacedServiceStatus(apiClient_t *apiClient, char *name, char *_namespace, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_service_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNode

// partially update the specified Node
//
v1_node_t* CoreV1API_patchNode(apiClient_t *apiClient, char *name, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_node_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchNodeStatus

// partially update status of the specified Node
//
v1_node_t* CoreV1API_patchNodeStatus(apiClient_t *apiClient, char *name, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_node_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchPersistentVolume

// partially update the specified PersistentVolume
//
v1_persistent_volume_t* CoreV1API_patchPersistentVolume(apiClient_t *apiClient, char *name, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_persistent_volume_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_patchPersistentVolumeStatus

// partially update status of the specified PersistentVolume
//
v1_persistent_volume_t* CoreV1API_patchPersistentVolumeStatus(apiClient_t *apiClient, char *name, object_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation, int *force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
body object_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * 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. [optional]
force int * Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_persistent_volume_t *

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_readComponentStatus

// read the specified ComponentStatus
//
v1_component_status_t* CoreV1API_readComponentStatus(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ComponentStatus
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_component_status_t *

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]

CoreV1API_readNamespace

// read the specified Namespace
//
v1_namespace_t* CoreV1API_readNamespace(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_namespace_t *

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]

CoreV1API_readNamespaceStatus

// read status of the specified Namespace
//
v1_namespace_t* CoreV1API_readNamespaceStatus(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_namespace_t *

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]

CoreV1API_readNamespacedConfigMap

// read the specified ConfigMap
//
v1_config_map_t* CoreV1API_readNamespacedConfigMap(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ConfigMap
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_config_map_t *

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]

CoreV1API_readNamespacedEndpoints

// read the specified Endpoints
//
v1_endpoints_t* CoreV1API_readNamespacedEndpoints(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Endpoints
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_endpoints_t *

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]

CoreV1API_readNamespacedEvent

// read the specified Event
//
core_v1_event_t* CoreV1API_readNamespacedEvent(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Event
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

core_v1_event_t *

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]

CoreV1API_readNamespacedLimitRange

// read the specified LimitRange
//
v1_limit_range_t* CoreV1API_readNamespacedLimitRange(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the LimitRange
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_limit_range_t *

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]

CoreV1API_readNamespacedPersistentVolumeClaim

// read the specified PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_readNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_persistent_volume_claim_t *

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]

CoreV1API_readNamespacedPersistentVolumeClaimStatus

// read status of the specified PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_readNamespacedPersistentVolumeClaimStatus(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_persistent_volume_claim_t *

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]

CoreV1API_readNamespacedPod

// read the specified Pod
//
v1_pod_t* CoreV1API_readNamespacedPod(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_pod_t *

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]

CoreV1API_readNamespacedPodEphemeralcontainers

// read ephemeralcontainers of the specified Pod
//
v1_pod_t* CoreV1API_readNamespacedPodEphemeralcontainers(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_pod_t *

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]

CoreV1API_readNamespacedPodLog

// read log of the specified Pod
//
char* CoreV1API_readNamespacedPodLog(apiClient_t *apiClient, char *name, char *_namespace, char *container, int *follow, int *insecureSkipTLSVerifyBackend, int *limitBytes, char *pretty, int *previous, int *sinceSeconds, int *tailLines, int *timestamps);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
container char * The container for which to stream logs. Defaults to only container if there is one container in the pod. [optional]
follow int * Follow the log stream of the pod. Defaults to false. [optional]
insecureSkipTLSVerifyBackend int * insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). [optional]
limitBytes int * If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
previous int * Return previous terminated container logs. Defaults to false. [optional]
sinceSeconds int * A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. [optional]
tailLines int * If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime [optional]
timestamps int * If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. [optional]

Return type

char*

Authorization

BearerToken

HTTP request headers

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

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

CoreV1API_readNamespacedPodStatus

// read status of the specified Pod
//
v1_pod_t* CoreV1API_readNamespacedPodStatus(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_pod_t *

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]

CoreV1API_readNamespacedPodTemplate

// read the specified PodTemplate
//
v1_pod_template_t* CoreV1API_readNamespacedPodTemplate(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodTemplate
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_pod_template_t *

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]

CoreV1API_readNamespacedReplicationController

// read the specified ReplicationController
//
v1_replication_controller_t* CoreV1API_readNamespacedReplicationController(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_replication_controller_t *

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]

CoreV1API_readNamespacedReplicationControllerScale

// read scale of the specified ReplicationController
//
v1_scale_t* CoreV1API_readNamespacedReplicationControllerScale(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Scale
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_scale_t *

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]

CoreV1API_readNamespacedReplicationControllerStatus

// read status of the specified ReplicationController
//
v1_replication_controller_t* CoreV1API_readNamespacedReplicationControllerStatus(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_replication_controller_t *

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]

CoreV1API_readNamespacedResourceQuota

// read the specified ResourceQuota
//
v1_resource_quota_t* CoreV1API_readNamespacedResourceQuota(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_resource_quota_t *

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]

CoreV1API_readNamespacedResourceQuotaStatus

// read status of the specified ResourceQuota
//
v1_resource_quota_t* CoreV1API_readNamespacedResourceQuotaStatus(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_resource_quota_t *

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]

CoreV1API_readNamespacedSecret

// read the specified Secret
//
v1_secret_t* CoreV1API_readNamespacedSecret(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Secret
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_secret_t *

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]

CoreV1API_readNamespacedService

// read the specified Service
//
v1_service_t* CoreV1API_readNamespacedService(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_service_t *

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]

CoreV1API_readNamespacedServiceAccount

// read the specified ServiceAccount
//
v1_service_account_t* CoreV1API_readNamespacedServiceAccount(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceAccount
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_service_account_t *

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]

CoreV1API_readNamespacedServiceStatus

// read status of the specified Service
//
v1_service_t* CoreV1API_readNamespacedServiceStatus(apiClient_t *apiClient, char *name, char *_namespace, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_service_t *

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]

CoreV1API_readNode

// read the specified Node
//
v1_node_t* CoreV1API_readNode(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_node_t *

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]

CoreV1API_readNodeStatus

// read status of the specified Node
//
v1_node_t* CoreV1API_readNodeStatus(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_node_t *

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]

CoreV1API_readPersistentVolume

// read the specified PersistentVolume
//
v1_persistent_volume_t* CoreV1API_readPersistentVolume(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_persistent_volume_t *

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]

CoreV1API_readPersistentVolumeStatus

// read status of the specified PersistentVolume
//
v1_persistent_volume_t* CoreV1API_readPersistentVolumeStatus(apiClient_t *apiClient, char *name, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_persistent_volume_t *

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]

CoreV1API_replaceNamespace

// replace the specified Namespace
//
v1_namespace_t* CoreV1API_replaceNamespace(apiClient_t *apiClient, char *name, v1_namespace_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
body v1_namespace_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_namespace_t *

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]

CoreV1API_replaceNamespaceFinalize

// replace finalize of the specified Namespace
//
v1_namespace_t* CoreV1API_replaceNamespaceFinalize(apiClient_t *apiClient, char *name, v1_namespace_t *body, char *dryRun, char *fieldManager, char *fieldValidation, char *pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
body v1_namespace_t *
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]

Return type

v1_namespace_t *

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]

CoreV1API_replaceNamespaceStatus

// replace status of the specified Namespace
//
v1_namespace_t* CoreV1API_replaceNamespaceStatus(apiClient_t *apiClient, char *name, v1_namespace_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Namespace
body v1_namespace_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_namespace_t *

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]

CoreV1API_replaceNamespacedConfigMap

// replace the specified ConfigMap
//
v1_config_map_t* CoreV1API_replaceNamespacedConfigMap(apiClient_t *apiClient, char *name, char *_namespace, v1_config_map_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ConfigMap
_namespace char * object name and auth scope, such as for teams and projects
body v1_config_map_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_config_map_t *

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]

CoreV1API_replaceNamespacedEndpoints

// replace the specified Endpoints
//
v1_endpoints_t* CoreV1API_replaceNamespacedEndpoints(apiClient_t *apiClient, char *name, char *_namespace, v1_endpoints_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Endpoints
_namespace char * object name and auth scope, such as for teams and projects
body v1_endpoints_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_endpoints_t *

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]

CoreV1API_replaceNamespacedEvent

// replace the specified Event
//
core_v1_event_t* CoreV1API_replaceNamespacedEvent(apiClient_t *apiClient, char *name, char *_namespace, core_v1_event_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Event
_namespace char * object name and auth scope, such as for teams and projects
body core_v1_event_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

core_v1_event_t *

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]

CoreV1API_replaceNamespacedLimitRange

// replace the specified LimitRange
//
v1_limit_range_t* CoreV1API_replaceNamespacedLimitRange(apiClient_t *apiClient, char *name, char *_namespace, v1_limit_range_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the LimitRange
_namespace char * object name and auth scope, such as for teams and projects
body v1_limit_range_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_limit_range_t *

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]

CoreV1API_replaceNamespacedPersistentVolumeClaim

// replace the specified PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_replaceNamespacedPersistentVolumeClaim(apiClient_t *apiClient, char *name, char *_namespace, v1_persistent_volume_claim_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
body v1_persistent_volume_claim_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_persistent_volume_claim_t *

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]

CoreV1API_replaceNamespacedPersistentVolumeClaimStatus

// replace status of the specified PersistentVolumeClaim
//
v1_persistent_volume_claim_t* CoreV1API_replaceNamespacedPersistentVolumeClaimStatus(apiClient_t *apiClient, char *name, char *_namespace, v1_persistent_volume_claim_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolumeClaim
_namespace char * object name and auth scope, such as for teams and projects
body v1_persistent_volume_claim_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_persistent_volume_claim_t *

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]

CoreV1API_replaceNamespacedPod

// replace the specified Pod
//
v1_pod_t* CoreV1API_replaceNamespacedPod(apiClient_t *apiClient, char *name, char *_namespace, v1_pod_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
body v1_pod_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_pod_t *

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]

CoreV1API_replaceNamespacedPodEphemeralcontainers

// replace ephemeralcontainers of the specified Pod
//
v1_pod_t* CoreV1API_replaceNamespacedPodEphemeralcontainers(apiClient_t *apiClient, char *name, char *_namespace, v1_pod_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
body v1_pod_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_pod_t *

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]

CoreV1API_replaceNamespacedPodStatus

// replace status of the specified Pod
//
v1_pod_t* CoreV1API_replaceNamespacedPodStatus(apiClient_t *apiClient, char *name, char *_namespace, v1_pod_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Pod
_namespace char * object name and auth scope, such as for teams and projects
body v1_pod_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_pod_t *

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]

CoreV1API_replaceNamespacedPodTemplate

// replace the specified PodTemplate
//
v1_pod_template_t* CoreV1API_replaceNamespacedPodTemplate(apiClient_t *apiClient, char *name, char *_namespace, v1_pod_template_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PodTemplate
_namespace char * object name and auth scope, such as for teams and projects
body v1_pod_template_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_pod_template_t *

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]

CoreV1API_replaceNamespacedReplicationController

// replace the specified ReplicationController
//
v1_replication_controller_t* CoreV1API_replaceNamespacedReplicationController(apiClient_t *apiClient, char *name, char *_namespace, v1_replication_controller_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
body v1_replication_controller_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_replication_controller_t *

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]

CoreV1API_replaceNamespacedReplicationControllerScale

// replace scale of the specified ReplicationController
//
v1_scale_t* CoreV1API_replaceNamespacedReplicationControllerScale(apiClient_t *apiClient, char *name, char *_namespace, v1_scale_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Scale
_namespace char * object name and auth scope, such as for teams and projects
body v1_scale_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_scale_t *

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]

CoreV1API_replaceNamespacedReplicationControllerStatus

// replace status of the specified ReplicationController
//
v1_replication_controller_t* CoreV1API_replaceNamespacedReplicationControllerStatus(apiClient_t *apiClient, char *name, char *_namespace, v1_replication_controller_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ReplicationController
_namespace char * object name and auth scope, such as for teams and projects
body v1_replication_controller_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_replication_controller_t *

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]

CoreV1API_replaceNamespacedResourceQuota

// replace the specified ResourceQuota
//
v1_resource_quota_t* CoreV1API_replaceNamespacedResourceQuota(apiClient_t *apiClient, char *name, char *_namespace, v1_resource_quota_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
body v1_resource_quota_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_resource_quota_t *

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]

CoreV1API_replaceNamespacedResourceQuotaStatus

// replace status of the specified ResourceQuota
//
v1_resource_quota_t* CoreV1API_replaceNamespacedResourceQuotaStatus(apiClient_t *apiClient, char *name, char *_namespace, v1_resource_quota_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ResourceQuota
_namespace char * object name and auth scope, such as for teams and projects
body v1_resource_quota_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_resource_quota_t *

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]

CoreV1API_replaceNamespacedSecret

// replace the specified Secret
//
v1_secret_t* CoreV1API_replaceNamespacedSecret(apiClient_t *apiClient, char *name, char *_namespace, v1_secret_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Secret
_namespace char * object name and auth scope, such as for teams and projects
body v1_secret_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_secret_t *

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]

CoreV1API_replaceNamespacedService

// replace the specified Service
//
v1_service_t* CoreV1API_replaceNamespacedService(apiClient_t *apiClient, char *name, char *_namespace, v1_service_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
body v1_service_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_service_t *

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]

CoreV1API_replaceNamespacedServiceAccount

// replace the specified ServiceAccount
//
v1_service_account_t* CoreV1API_replaceNamespacedServiceAccount(apiClient_t *apiClient, char *name, char *_namespace, v1_service_account_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ServiceAccount
_namespace char * object name and auth scope, such as for teams and projects
body v1_service_account_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_service_account_t *

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]

CoreV1API_replaceNamespacedServiceStatus

// replace status of the specified Service
//
v1_service_t* CoreV1API_replaceNamespacedServiceStatus(apiClient_t *apiClient, char *name, char *_namespace, v1_service_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Service
_namespace char * object name and auth scope, such as for teams and projects
body v1_service_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_service_t *

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]

CoreV1API_replaceNode

// replace the specified Node
//
v1_node_t* CoreV1API_replaceNode(apiClient_t *apiClient, char *name, v1_node_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
body v1_node_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_node_t *

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]

CoreV1API_replaceNodeStatus

// replace status of the specified Node
//
v1_node_t* CoreV1API_replaceNodeStatus(apiClient_t *apiClient, char *name, v1_node_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Node
body v1_node_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_node_t *

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]

CoreV1API_replacePersistentVolume

// replace the specified PersistentVolume
//
v1_persistent_volume_t* CoreV1API_replacePersistentVolume(apiClient_t *apiClient, char *name, v1_persistent_volume_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
body v1_persistent_volume_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_persistent_volume_t *

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]

CoreV1API_replacePersistentVolumeStatus

// replace status of the specified PersistentVolume
//
v1_persistent_volume_t* CoreV1API_replacePersistentVolumeStatus(apiClient_t *apiClient, char *name, v1_persistent_volume_t *body, char *pretty, char *dryRun, char *fieldManager, char *fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the PersistentVolume
body v1_persistent_volume_t *
pretty char * If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * 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. [optional]

Return type

v1_persistent_volume_t *

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]