---
title: "Get a list of kubernetes Jobs"
method: GET
path: "/kubernetes/{id}/jobs"
tags: ["kubernetes"]
---

# Get a list of kubernetes Jobs

`GET /kubernetes/{id}/jobs`

Get a list of kubernetes Jobs that the user has access to.
**Access policy**: Authenticated user.

## Path parameters

- `id` integer, required

## Query parameters

- `includeCronJobChildren` boolean

## Response `200`

Success

- KubernetesK8sJob[]
  - `BackoffLimit` integer
  - `Command` string
  - `Completions` integer
  - `Container` V1Container
    - `args` string[] — Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic
    - `command` string[] — Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic
    - `env` V1EnvVar[] — List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name
      - `name` string — Name of the environment variable. May consist of any printable ASCII characters except '='.
      - `value` string — Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional
      - `valueFrom` V1EnvVarSource
        - `configMapKeyRef` V1ConfigMapKeySelector
          - `key` string — The key to select.
          - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `optional` boolean — Specify whether the ConfigMap or its key must be defined +optional
        - `fieldRef` V1ObjectFieldSelector
          - `apiVersion` string — Version of the schema the FieldPath is written in terms of, defaults to "v1". +optional
          - `fieldPath` string — Path of the field to select in the specified API version.
        - `fileKeyRef` V1FileKeySelector
          - `key` string — The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. +required
          - `optional` boolean — Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers. If optional is set to false and the specified key does not exist, an error will be returned during Pod creation. +optional +default=false
          - `path` string — The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. +required
          - `volumeName` string — The name of the volume mount containing the env file. +required
        - `resourceFieldRef` V1ResourceFieldSelector
          - `containerName` string — Container name: required for volumes, optional for env vars +optional
          - `divisor` ResourceQuantity
            - `Format` 'DecimalExponent' | 'BinarySI' | 'DecimalSI'
          - `resource` string — Required: resource to select
        - `secretKeyRef` V1SecretKeySelector
          - `key` string — The key of the secret to select from. Must be a valid secret key.
          - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `optional` boolean — Specify whether the Secret or its key must be defined +optional
    - `envFrom` V1EnvFromSource[] — List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional +listType=atomic
      - `configMapRef` V1ConfigMapEnvSource
        - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
        - `optional` boolean — Specify whether the ConfigMap must be defined +optional
      - `prefix` string — Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. +optional
      - `secretRef` V1SecretEnvSource
        - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
        - `optional` boolean — Specify whether the Secret must be defined +optional
    - `image` string — Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. +optional
    - `imagePullPolicy` 'Always' | 'Never' | 'IfNotPresent'
    - `lifecycle` V1Lifecycle
      - `postStart` V1LifecycleHandler
        - `exec` V1ExecAction
          - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
        - `httpGet` V1HTTPGetAction
          - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
          - `httpHeaders` K8sIoApiCoreV1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
            - `name` string — The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
            - `value` string — The header field value
          - `path` string — Path to access on the HTTP server. +optional
          - `port` IntstrIntOrString
            - `IntVal` integer
            - `StrVal` string
            - `Type` 0 | 1
          - `scheme` 'HTTP' | 'HTTPS'
        - `sleep` V1SleepAction
          - `seconds` integer — Seconds is the number of seconds to sleep.
        - `tcpSocket` V1TCPSocketAction
          - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
          - `port` IntstrIntOrString
            - `IntVal` integer
            - `StrVal` string
            - `Type` 0 | 1
      - `preStop` V1LifecycleHandler
        - `exec` V1ExecAction
          - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
        - `httpGet` V1HTTPGetAction
          - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
          - `httpHeaders` K8sIoApiCoreV1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
            - `name` string — The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
            - `value` string — The header field value
          - `path` string — Path to access on the HTTP server. +optional
          - `port` IntstrIntOrString
            - `IntVal` integer
            - `StrVal` string
            - `Type` 0 | 1
          - `scheme` 'HTTP' | 'HTTPS'
        - `sleep` V1SleepAction
          - `seconds` integer — Seconds is the number of seconds to sleep.
        - `tcpSocket` V1TCPSocketAction
          - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
          - `port` IntstrIntOrString
            - `IntVal` integer
            - `StrVal` string
            - `Type` 0 | 1
      - `stopSignal` 'SIGABRT' | 'SIGALRM' | 'SIGBUS' | 'SIGCHLD' | 'SIGCLD' | 'SIGCONT' | 'SIGFPE' | 'SIGHUP' | 'SIGILL' | 'SIGINT' | 'SIGIO' | 'SIGIOT' | 'SIGKILL' | 'SIGPIPE' | 'SIGPOLL' | 'SIGPROF' | 'SIGPWR' | 'SIGQUIT' | 'SIGSEGV' | 'SIGSTKFLT' | 'SIGSTOP' | 'SIGSYS' | 'SIGTERM' | 'SIGTRAP' | 'SIGTSTP' | 'SIGTTIN' | 'SIGTTOU' | 'SIGURG' | 'SIGUSR1' | 'SIGUSR2' | 'SIGVTALRM' | 'SIGWINCH' | 'SIGXCPU' | 'SIGXFSZ' | 'SIGRTMIN' | 'SIGRTMIN+1' | 'SIGRTMIN+2' | 'SIGRTMIN+3' | 'SIGRTMIN+4' | 'SIGRTMIN+5' | 'SIGRTMIN+6' | 'SIGRTMIN+7' | 'SIGRTMIN+8' | 'SIGRTMIN+9' | 'SIGRTMIN+10' | 'SIGRTMIN+11' | 'SIGRTMIN+12' | 'SIGRTMIN+13' | 'SIGRTMIN+14' | 'SIGRTMIN+15' | 'SIGRTMAX-14' | 'SIGRTMAX-13' | 'SIGRTMAX-12' | 'SIGRTMAX-11' | 'SIGRTMAX-10' | 'SIGRTMAX-9' | 'SIGRTMAX-8' | 'SIGRTMAX-7' | 'SIGRTMAX-6' | 'SIGRTMAX-5' | 'SIGRTMAX-4' | 'SIGRTMAX-3' | 'SIGRTMAX-2' | 'SIGRTMAX-1' | 'SIGRTMAX'
    - `livenessProbe` V1Probe
      - `exec` V1ExecAction
        - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
      - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional
      - `grpc` V1GRPCAction
        - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535.
        - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default=""
      - `httpGet` V1HTTPGetAction
        - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
        - `httpHeaders` K8sIoApiCoreV1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
          - `name` string — The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
          - `value` string — The header field value
        - `path` string — Path to access on the HTTP server. +optional
        - `port` IntstrIntOrString
          - `IntVal` integer
          - `StrVal` string
          - `Type` 0 | 1
        - `scheme` 'HTTP' | 'HTTPS'
      - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
      - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
      - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional
      - `tcpSocket` V1TCPSocketAction
        - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
        - `port` IntstrIntOrString
          - `IntVal` integer
          - `StrVal` string
          - `Type` 0 | 1
      - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional
      - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
    - `name` string — Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
    - `ports` V1ContainerPort[] — List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol
      - `containerPort` integer — Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
      - `hostIP` string — What host IP to bind the external port to. +optional
      - `hostPort` integer — Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional
      - `name` string — If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional
      - `protocol` 'TCP' | 'UDP' | 'SCTP'
    - `readinessProbe` V1Probe
      - `exec` V1ExecAction
        - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
      - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional
      - `grpc` V1GRPCAction
        - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535.
        - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default=""
      - `httpGet` V1HTTPGetAction
        - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
        - `httpHeaders` K8sIoApiCoreV1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
          - `name` string — The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
          - `value` string — The header field value
        - `path` string — Path to access on the HTTP server. +optional
        - `port` IntstrIntOrString
          - `IntVal` integer
          - `StrVal` string
          - `Type` 0 | 1
        - `scheme` 'HTTP' | 'HTTPS'
      - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
      - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
      - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional
      - `tcpSocket` V1TCPSocketAction
        - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
        - `port` IntstrIntOrString
          - `IntVal` integer
          - `StrVal` string
          - `Type` 0 | 1
      - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional
      - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
    - `resizePolicy` V1ContainerResizePolicy[] — Resources resize policy for the container. This field cannot be set on ephemeral containers. +featureGate=InPlacePodVerticalScaling +optional +listType=atomic
      - `resourceName` 'cpu' | 'memory' | 'storage' | 'ephemeral-storage' | 'pods' | 'services' | 'replicationcontrollers' | 'resourcequotas' | 'secrets' | 'configmaps' | 'persistentvolumeclaims' | 'services.nodeports' | 'services.loadbalancers' | 'requests.cpu' | 'requests.memory' | 'requests.storage' | 'requests.ephemeral-storage' | 'limits.cpu' | 'limits.memory' | 'limits.ephemeral-storage'
      - `restartPolicy` 'NotRequired' | 'RestartContainer'
    - `resources` V1ResourceRequirements
      - `claims` K8sIoApiCoreV1ResourceClaim[] — Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional
        - `name` string — Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
        - `request` string — Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. +optional
      - `limits` V1ResourceList
      - `requests` V1ResourceList
    - `restartPolicy` 'Always' | 'Never' | 'OnFailure'
    - `restartPolicyRules` V1ContainerRestartRule[] — Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod's RestartPolicy. +featureGate=ContainerRestartRules +optional +listType=atomic
      - `action` 'Restart' | 'RestartAllContainers'
      - `exitCodes` V1ContainerRestartRuleOnExitCodes
        - `operator` 'In' | 'NotIn'
        - `values` integer[] — Specifies the set of values to check for container exit codes. At most 255 elements are allowed. +optional +listType=set
    - `securityContext` V1SecurityContext
      - `allowPrivilegeEscalation` boolean — AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. +optional
      - `appArmorProfile` V1AppArmorProfile
        - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional
        - `type` 'Unconfined' | 'RuntimeDefault' | 'Localhost'
      - `capabilities` V1Capabilities
        - `add` string[] — Added capabilities +optional +listType=atomic
        - `drop` string[] — Removed capabilities +optional +listType=atomic
      - `privileged` boolean — Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. +optional
      - `procMount` 'Default' | 'Unmasked'
      - `readOnlyRootFilesystem` boolean — Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. +optional
      - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional
      - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
      - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional
      - `seLinuxOptions` V1SELinuxOptions
        - `level` string — Level is SELinux level label that applies to the container. +optional
        - `role` string — Role is a SELinux role label that applies to the container. +optional
        - `type` string — Type is a SELinux type label that applies to the container. +optional
        - `user` string — User is a SELinux user label that applies to the container. +optional
      - `seccompProfile` V1SeccompProfile
        - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional
        - `type` 'Unconfined' | 'RuntimeDefault' | 'Localhost'
      - `windowsOptions` V1WindowsSecurityContextOptions
        - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional
        - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional
        - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional
        - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
    - `startupProbe` V1Probe
      - `exec` V1ExecAction
        - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
      - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional
      - `grpc` V1GRPCAction
        - `port` integer — Port number of the gRPC service. Number must be in the range 1 to 65535.
        - `service` string — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default=""
      - `httpGet` V1HTTPGetAction
        - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
        - `httpHeaders` K8sIoApiCoreV1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
          - `name` string — The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
          - `value` string — The header field value
        - `path` string — Path to access on the HTTP server. +optional
        - `port` IntstrIntOrString
          - `IntVal` integer
          - `StrVal` string
          - `Type` 0 | 1
        - `scheme` 'HTTP' | 'HTTPS'
      - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
      - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
      - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional
      - `tcpSocket` V1TCPSocketAction
        - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
        - `port` IntstrIntOrString
          - `IntVal` integer
          - `StrVal` string
          - `Type` 0 | 1
      - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional
      - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
    - `stdin` boolean — Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional
    - `stdinOnce` boolean — Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional
    - `terminationMessagePath` string — Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional
    - `terminationMessagePolicy` 'File' | 'FallbackToLogsOnError'
    - `tty` boolean — Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional
    - `volumeDevices` V1VolumeDevice[] — volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +listType=map +listMapKey=devicePath +optional
      - `devicePath` string — devicePath is the path inside of the container that the device will be mapped to.
      - `name` string — name must match the name of a persistentVolumeClaim in the pod
    - `volumeMounts` V1VolumeMount[] — Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath
      - `mountPath` string — Path within the container at which the volume should be mounted. Must not contain ':'.
      - `mountPropagation` 'None' | 'HostToContainer' | 'Bidirectional'
      - `name` string — This must match the Name of a Volume.
      - `readOnly` boolean — Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional
      - `recursiveReadOnly` 'Disabled' | 'IfPossible' | 'Enabled'
      - `subPath` string — Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional
      - `subPathExpr` string — Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. +optional
    - `workingDir` string — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional
  - `Duration` string
  - `FailedReason` string
  - `FinishTime` string
  - `Id` string
  - `IsSystem` boolean
  - `Name` string
  - `Namespace` string
  - `PodName` string
  - `StartTime` string
  - `Status` string

## Other responses

- `400` — Invalid request payload, such as missing required fields or fields not meeting validation criteria.
- `401` — Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
- `403` — Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
- `404` — Unable to find an environment with the specified identifier.
- `500` — Server error occurred while attempting to retrieve the list of Jobs.

---

[API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/c0b0975cd11b/schema)