1. Documentation
    2. Page history / Suggest an edit
×

v2alpha1.CronJob

Description

CronJob represents the configuration of a single cron job.

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:

kind:

metadata:

  annotations:

    [string]:

  clusterName:

  creationTimestamp:

  deletionGracePeriodSeconds:

  deletionTimestamp:

  finalizers:

  - [string]:

  generateName:

  generation:

  initializers:

    pending:

    - name:

    result:

      apiVersion:

      code:

      details:

        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

      metadata:

        continue:

        resourceVersion:

        selfLink:

      reason:

      status:

  labels:

    [string]:

  name:

  namespace:

  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

spec:

  concurrencyPolicy:

  failedJobsHistoryLimit:

  jobTemplate:

    metadata:

      annotations:

        [string]:

      clusterName:

      creationTimestamp:

      deletionGracePeriodSeconds:

      deletionTimestamp:

      finalizers:

      - [string]:

      generateName:

      generation:

      initializers:

        pending:

        - name:

        result:

          apiVersion:

          code:

          details:

            causes:

            - field:

              message:

              reason:

            group:

            kind:

            name:

            retryAfterSeconds:

            uid:

          kind:

          message:

          metadata:

            continue:

            resourceVersion:

            selfLink:

          reason:

          status:

      labels:

        [string]:

      name:

      namespace:

      ownerReferences:

      - apiVersion:

        blockOwnerDeletion:

        controller:

        kind:

        name:

        uid:

      resourceVersion:

      selfLink:

      uid:

    spec:

      activeDeadlineSeconds:

      backoffLimit:

      completions:

      manualSelector:

      parallelism:

      selector:

        matchExpressions:

        - key:

          operator:

          values:

          - [string]:

        matchLabels:

          [string]:

      template:

        metadata:

          annotations:

            [string]:

          clusterName:

          creationTimestamp:

          deletionGracePeriodSeconds:

          deletionTimestamp:

          finalizers:

          - [string]:

          generateName:

          generation:

          initializers:

            pending:

            - name:

            result:

              apiVersion:

              code:

              details:

                causes:

                - field:

                  message:

                  reason:

                group:

                kind:

                name:

                retryAfterSeconds:

                uid:

              kind:

              message:

              metadata:

                continue:

                resourceVersion:

                selfLink:

              reason:

              status:

          labels:

            [string]:

          name:

          namespace:

          ownerReferences:

          - apiVersion:

            blockOwnerDeletion:

            controller:

            kind:

            name:

            uid:

          resourceVersion:

          selfLink:

          uid:

        spec:

          activeDeadlineSeconds:

          affinity:

            nodeAffinity:

              preferredDuringSchedulingIgnoredDuringExecution:

              - preference:

              -   matchExpressions:

              -   - key:

                    operator:

                    values:

                    - [string]:

                weight:

              requiredDuringSchedulingIgnoredDuringExecution:

                nodeSelectorTerms:

                - matchExpressions:

                - - key:

                    operator:

                    values:

                    - [string]:

            podAffinity:

              preferredDuringSchedulingIgnoredDuringExecution:

              - podAffinityTerm:

              -   labelSelector:

              -     matchExpressions:

              -     - key:

                      operator:

                      values:

                      - [string]:

                    matchLabels:

                      [string]:

                  namespaces:

                  - [string]:

                  topologyKey:

                weight:

              requiredDuringSchedulingIgnoredDuringExecution:

              - labelSelector:

              -   matchExpressions:

              -   - key:

                    operator:

                    values:

                    - [string]:

                  matchLabels:

                    [string]:

                namespaces:

                - [string]:

                topologyKey:

            podAntiAffinity:

              preferredDuringSchedulingIgnoredDuringExecution:

              - podAffinityTerm:

              -   labelSelector:

              -     matchExpressions:

              -     - key:

                      operator:

                      values:

                      - [string]:

                    matchLabels:

                      [string]:

                  namespaces:

                  - [string]:

                  topologyKey:

                weight:

              requiredDuringSchedulingIgnoredDuringExecution:

              - labelSelector:

              -   matchExpressions:

              -   - key:

                    operator:

                    values:

                    - [string]:

                  matchLabels:

                    [string]:

                namespaces:

                - [string]:

                topologyKey:

          automountServiceAccountToken:

          containers:

          - args:

          - - [string]:

            command:

            - [string]:

            env:

            - name:

              value:

              valueFrom:

                configMapKeyRef:

                  key:

                  name:

                  optional:

                fieldRef:

                  apiVersion:

                  fieldPath:

                resourceFieldRef:

                  containerName:

                  divisor:

                  resource:

                secretKeyRef:

                  key:

                  name:

                  optional:

            envFrom:

            - configMapRef:

            -   name:

                optional:

              prefix:

              secretRef:

                name:

                optional:

            image:

            imagePullPolicy:

            lifecycle:

              postStart:

                exec:

                  command:

                  - [string]:

                httpGet:

                  host:

                  httpHeaders:

                  - name:

                    value:

                  path:

                  port:

                  scheme:

                tcpSocket:

                  host:

                  port:

              preStop:

                exec:

                  command:

                  - [string]:

                httpGet:

                  host:

                  httpHeaders:

                  - name:

                    value:

                  path:

                  port:

                  scheme:

                tcpSocket:

                  host:

                  port:

            livenessProbe:

              exec:

                command:

                - [string]:

              failureThreshold:

              httpGet:

                host:

                httpHeaders:

                - name:

                  value:

                path:

                port:

                scheme:

              initialDelaySeconds:

              periodSeconds:

              successThreshold:

              tcpSocket:

                host:

                port:

              timeoutSeconds:

            name:

            ports:

            - containerPort:

              hostIP:

              hostPort:

              name:

              protocol:

            readinessProbe:

              exec:

                command:

                - [string]:

              failureThreshold:

              httpGet:

                host:

                httpHeaders:

                - name:

                  value:

                path:

                port:

                scheme:

              initialDelaySeconds:

              periodSeconds:

              successThreshold:

              tcpSocket:

                host:

                port:

              timeoutSeconds:

            resources:

              limits:

                [string]:

              requests:

                [string]:

            securityContext:

              allowPrivilegeEscalation:

              capabilities:

                add:

                - [string]:

                drop:

                - [string]:

              privileged:

              readOnlyRootFilesystem:

              runAsNonRoot:

              runAsUser:

              seLinuxOptions:

                level:

                role:

                type:

                user:

            stdin:

            stdinOnce:

            terminationMessagePath:

            terminationMessagePolicy:

            tty:

            volumeDevices:

            - devicePath:

              name:

            volumeMounts:

            - mountPath:

              mountPropagation:

              name:

              readOnly:

              subPath:

            workingDir:

          dnsConfig:

            nameservers:

            - [string]:

            options:

            - name:

              value:

            searches:

            - [string]:

          dnsPolicy:

          hostAliases:

          - hostnames:

          - - [string]:

            ip:

          hostIPC:

          hostNetwork:

          hostPID:

          hostname:

          imagePullSecrets:

          - name:

          initContainers:

          - args:

          - - [string]:

            command:

            - [string]:

            env:

            - name:

              value:

              valueFrom:

                configMapKeyRef:

                  key:

                  name:

                  optional:

                fieldRef:

                  apiVersion:

                  fieldPath:

                resourceFieldRef:

                  containerName:

                  divisor:

                  resource:

                secretKeyRef:

                  key:

                  name:

                  optional:

            envFrom:

            - configMapRef:

            -   name:

                optional:

              prefix:

              secretRef:

                name:

                optional:

            image:

            imagePullPolicy:

            lifecycle:

              postStart:

                exec:

                  command:

                  - [string]:

                httpGet:

                  host:

                  httpHeaders:

                  - name:

                    value:

                  path:

                  port:

                  scheme:

                tcpSocket:

                  host:

                  port:

              preStop:

                exec:

                  command:

                  - [string]:

                httpGet:

                  host:

                  httpHeaders:

                  - name:

                    value:

                  path:

                  port:

                  scheme:

                tcpSocket:

                  host:

                  port:

            livenessProbe:

              exec:

                command:

                - [string]:

              failureThreshold:

              httpGet:

                host:

                httpHeaders:

                - name:

                  value:

                path:

                port:

                scheme:

              initialDelaySeconds:

              periodSeconds:

              successThreshold:

              tcpSocket:

                host:

                port:

              timeoutSeconds:

            name:

            ports:

            - containerPort:

              hostIP:

              hostPort:

              name:

              protocol:

            readinessProbe:

              exec:

                command:

                - [string]:

              failureThreshold:

              httpGet:

                host:

                httpHeaders:

                - name:

                  value:

                path:

                port:

                scheme:

              initialDelaySeconds:

              periodSeconds:

              successThreshold:

              tcpSocket:

                host:

                port:

              timeoutSeconds:

            resources:

              limits:

                [string]:

              requests:

                [string]:

            securityContext:

              allowPrivilegeEscalation:

              capabilities:

                add:

                - [string]:

                drop:

                - [string]:

              privileged:

              readOnlyRootFilesystem:

              runAsNonRoot:

              runAsUser:

              seLinuxOptions:

                level:

                role:

                type:

                user:

            stdin:

            stdinOnce:

            terminationMessagePath:

            terminationMessagePolicy:

            tty:

            volumeDevices:

            - devicePath:

              name:

            volumeMounts:

            - mountPath:

              mountPropagation:

              name:

              readOnly:

              subPath:

            workingDir:

          nodeName:

          nodeSelector:

            [string]:

          priority:

          priorityClassName:

          restartPolicy:

          schedulerName:

          securityContext:

            fsGroup:

            runAsNonRoot:

            runAsUser:

            seLinuxOptions:

              level:

              role:

              type:

              user:

            supplementalGroups:

            - [integer]:

          serviceAccount:

          serviceAccountName:

          subdomain:

          terminationGracePeriodSeconds:

          tolerations:

          - effect:

            key:

            operator:

            tolerationSeconds:

            value:

          volumes:

          - awsElasticBlockStore:

          -   fsType:

              partition:

              readOnly:

              volumeID:

            azureDisk:

              cachingMode:

              diskName:

              diskURI:

              fsType:

              kind:

              readOnly:

            azureFile:

              readOnly:

              secretName:

              shareName:

            cephfs:

              monitors:

              - [string]:

              path:

              readOnly:

              secretFile:

              secretRef:

                name:

              user:

            cinder:

              fsType:

              readOnly:

              volumeID:

            configMap:

              defaultMode:

              items:

              - key:

                mode:

                path:

              name:

              optional:

            downwardAPI:

              defaultMode:

              items:

              - fieldRef:

              -   apiVersion:

                  fieldPath:

                mode:

                path:

                resourceFieldRef:

                  containerName:

                  divisor:

                  resource:

            emptyDir:

              medium:

              sizeLimit:

            fc:

              fsType:

              lun:

              readOnly:

              targetWWNs:

              - [string]:

              wwids:

              - [string]:

            flexVolume:

              driver:

              fsType:

              options:

                [string]:

              readOnly:

              secretRef:

                name:

            flocker:

              datasetName:

              datasetUUID:

            gcePersistentDisk:

              fsType:

              partition:

              pdName:

              readOnly:

            gitRepo:

              directory:

              repository:

              revision:

            glusterfs:

              endpoints:

              path:

              readOnly:

            hostPath:

              path:

              type:

            iscsi:

              chapAuthDiscovery:

              chapAuthSession:

              fsType:

              initiatorName:

              iqn:

              iscsiInterface:

              lun:

              portals:

              - [string]:

              readOnly:

              secretRef:

                name:

              targetPortal:

            name:

            nfs:

              path:

              readOnly:

              server:

            persistentVolumeClaim:

              claimName:

              readOnly:

            photonPersistentDisk:

              fsType:

              pdID:

            portworxVolume:

              fsType:

              readOnly:

              volumeID:

            projected:

              defaultMode:

              sources:

              - configMap:

              -   items:

              -   - key:

                    mode:

                    path:

                  name:

                  optional:

                downwardAPI:

                  items:

                  - fieldRef:

                  -   apiVersion:

                      fieldPath:

                    mode:

                    path:

                    resourceFieldRef:

                      containerName:

                      divisor:

                      resource:

                secret:

                  items:

                  - key:

                    mode:

                    path:

                  name:

                  optional:

            quobyte:

              group:

              readOnly:

              registry:

              user:

              volume:

            rbd:

              fsType:

              image:

              keyring:

              monitors:

              - [string]:

              pool:

              readOnly:

              secretRef:

                name:

              user:

            scaleIO:

              fsType:

              gateway:

              protectionDomain:

              readOnly:

              secretRef:

                name:

              sslEnabled:

              storageMode:

              storagePool:

              system:

              volumeName:

            secret:

              defaultMode:

              items:

              - key:

                mode:

                path:

              optional:

              secretName:

            storageos:

              fsType:

              readOnly:

              secretRef:

                name:

              volumeName:

              volumeNamespace:

            vsphereVolume:

              fsType:

              storagePolicyID:

              storagePolicyName:

              volumePath:

  schedule:

  startingDeadlineSeconds:

  successfulJobsHistoryLimit:

  suspend:

status:

  active:

  - apiVersion:

    fieldPath:

    kind:

    name:

    namespace:

    resourceVersion:

    uid:

  lastScheduleTime:

Operations

Create a CronJob

Create a CronJob

HTTP request

POST /apis/batch/v2alpha1/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/cronjobs <<'EOF'
{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v2alpha1.CronJob

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

201 Created

v2alpha1.CronJob

202 Accepted

v2alpha1.CronJob

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a CronJob in a namespace

Create a CronJob

HTTP request

POST /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs <<'EOF'
{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v2alpha1.CronJob

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

201 Created

v2alpha1.CronJob

202 Accepted

v2alpha1.CronJob

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a CronJob in a namespace

Read the specified CronJob

HTTP request

GET /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

Should this value be exported. Export strips fields that a user can not specify.

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all CronJobs

List or watch objects of kind CronJob

HTTP request

GET /apis/batch/v2alpha1/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/cronjobs

Query parameters

Parameter Description

pretty

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

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJobList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Get all CronJobs in a namespace

List or watch objects of kind CronJob

HTTP request

GET /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJobList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch a CronJob in a namespace

Watch changes to an object of kind CronJob

HTTP request

GET /apis/batch/v2alpha1/watch/namespaces/$NAMESPACE/cronjobs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/watch/namespaces/$NAMESPACE/cronjobs/$NAME

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

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.

pretty

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch all CronJobs

Watch individual changes to a list of CronJob

HTTP request

GET /apis/batch/v2alpha1/watch/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/watch/cronjobs

Query parameters

Parameter Description

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

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.

pretty

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Watch all CronJobs in a namespace

Watch individual changes to a list of CronJob

HTTP request

GET /apis/batch/v2alpha1/watch/namespaces/$NAMESPACE/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/watch/namespaces/$NAMESPACE/cronjobs

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

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.

pretty

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

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.WatchEvent

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Update a CronJob in a namespace

Replace the specified CronJob

HTTP request

PUT /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME <<'EOF'
{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v2alpha1.CronJob

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

201 Created

v2alpha1.CronJob

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a CronJob in a namespace

Partially update the specified CronJob

HTTP request

PATCH /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete a CronJob in a namespace

Delete a CronJob

HTTP request

DELETE /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ...
}

Curl request

$ curl -k \
    -X DELETE \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeleteOptions

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

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.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete all CronJobs in a namespace

Delete collection of CronJob

HTTP request

DELETE /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get status of a CronJob in a namespace

Read status of the specified CronJob

HTTP request

GET /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME/status

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update status of a CronJob in a namespace

Replace status of the specified CronJob

HTTP request

PUT /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME/status <<'EOF'
{
  "kind": "CronJob",
  "apiVersion": "batch/v2alpha1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v2alpha1.CronJob

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

201 Created

v2alpha1.CronJob

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch status of a CronJob in a namespace

Partially update status of the specified CronJob

HTTP request

PATCH /apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/batch/v2alpha1/namespaces/$NAMESPACE/cronjobs/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the CronJob

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v2alpha1.CronJob

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf