1. Documentation
×

v1beta1.Deployment

Description

Deployment enables declarative updates for Pods and ReplicaSets.

Object Schema

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

apiVersion:

kind:

Collapse all
metadata:

Collapse all
  annotations:

    [string]:

  clusterName:

  creationTimestamp:

  deletionGracePeriodSeconds:

  deletionTimestamp:

Collapse all
  finalizers:

  - [string]:

  generateName:

  generation:

Collapse all
  initializers:

Collapse all
    pending:

    - name:

Collapse all
    result:

      apiVersion:

      code:

Collapse all
      details:

Collapse all
        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

Collapse all
      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

Collapse all
  labels:

    [string]:

  name:

  namespace:

Collapse all
  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

Collapse all
spec:

  minReadySeconds:

  paused:

  progressDeadlineSeconds:

  replicas:

  revisionHistoryLimit:

Collapse all
  rollbackTo:

    revision:

Collapse all
  selector:

Collapse all
    matchExpressions:

    - key:

      operator:

Collapse all
      values:

      - [string]:

Collapse all
    matchLabels:

      [string]:

Collapse all
  strategy:

Collapse all
    rollingUpdate:

      maxSurge:

      maxUnavailable:

    type:

Collapse all
  template:

Collapse all
    metadata:

Collapse all
      annotations:

        [string]:

      clusterName:

      creationTimestamp:

      deletionGracePeriodSeconds:

      deletionTimestamp:

Collapse all
      finalizers:

      - [string]:

      generateName:

      generation:

Collapse all
      initializers:

Collapse all
        pending:

        - name:

Collapse all
        result:

          apiVersion:

          code:

Collapse all
          details:

Collapse all
            causes:

            - field:

              message:

              reason:

            group:

            kind:

            name:

            retryAfterSeconds:

            uid:

          kind:

          message:

Collapse all
          metadata:

            resourceVersion:

            selfLink:

          reason:

          status:

Collapse all
      labels:

        [string]:

      name:

      namespace:

Collapse all
      ownerReferences:

      - apiVersion:

        blockOwnerDeletion:

        controller:

        kind:

        name:

        uid:

      resourceVersion:

      selfLink:

      uid:

Collapse all
    spec:

      activeDeadlineSeconds:

Collapse all
      affinity:

Collapse all
        nodeAffinity:

Collapse all
          preferredDuringSchedulingIgnoredDuringExecution:

Collapse all
          - preference:

Collapse all
          -   matchExpressions:

          -   - key:

                operator:

Collapse all
                values:

                - [string]:

            weight:

Collapse all
          requiredDuringSchedulingIgnoredDuringExecution:

Collapse all
            nodeSelectorTerms:

Collapse all
            - matchExpressions:

            - - key:

                operator:

Collapse all
                values:

                - [string]:

Collapse all
        podAffinity:

Collapse all
          preferredDuringSchedulingIgnoredDuringExecution:

Collapse all
          - podAffinityTerm:

Collapse all
          -   labelSelector:

Collapse all
          -     matchExpressions:

          -     - key:

                  operator:

Collapse all
                  values:

                  - [string]:

Collapse all
                matchLabels:

                  [string]:

Collapse all
              namespaces:

              - [string]:

              topologyKey:

            weight:

Collapse all
          requiredDuringSchedulingIgnoredDuringExecution:

Collapse all
          - labelSelector:

Collapse all
          -   matchExpressions:

          -   - key:

                operator:

Collapse all
                values:

                - [string]:

Collapse all
              matchLabels:

                [string]:

Collapse all
            namespaces:

            - [string]:

            topologyKey:

Collapse all
        podAntiAffinity:

Collapse all
          preferredDuringSchedulingIgnoredDuringExecution:

Collapse all
          - podAffinityTerm:

Collapse all
          -   labelSelector:

Collapse all
          -     matchExpressions:

          -     - key:

                  operator:

Collapse all
                  values:

                  - [string]:

Collapse all
                matchLabels:

                  [string]:

Collapse all
              namespaces:

              - [string]:

              topologyKey:

            weight:

Collapse all
          requiredDuringSchedulingIgnoredDuringExecution:

Collapse all
          - labelSelector:

Collapse all
          -   matchExpressions:

          -   - key:

                operator:

Collapse all
                values:

                - [string]:

Collapse all
              matchLabels:

                [string]:

Collapse all
            namespaces:

            - [string]:

            topologyKey:

      automountServiceAccountToken:

Collapse all
      containers:

Collapse all
      - args:

      - - [string]:

Collapse all
        command:

        - [string]:

Collapse all
        env:

        - name:

          value:

Collapse all
          valueFrom:

Collapse all
            configMapKeyRef:

              key:

              name:

              optional:

Collapse all
            fieldRef:

              apiVersion:

              fieldPath:

Collapse all
            resourceFieldRef:

              containerName:

              divisor:

              resource:

Collapse all
            secretKeyRef:

              key:

              name:

              optional:

Collapse all
        envFrom:

Collapse all
        - configMapRef:

        -   name:

            optional:

          prefix:

Collapse all
          secretRef:

            name:

            optional:

        image:

        imagePullPolicy:

Collapse all
        lifecycle:

Collapse all
          postStart:

Collapse all
            exec:

Collapse all
              command:

              - [string]:

Collapse all
            httpGet:

              host:

Collapse all
              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

Collapse all
            tcpSocket:

              host:

              port:

Collapse all
          preStop:

Collapse all
            exec:

Collapse all
              command:

              - [string]:

Collapse all
            httpGet:

              host:

Collapse all
              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

Collapse all
            tcpSocket:

              host:

              port:

Collapse all
        livenessProbe:

Collapse all
          exec:

Collapse all
            command:

            - [string]:

          failureThreshold:

Collapse all
          httpGet:

            host:

Collapse all
            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

Collapse all
          tcpSocket:

            host:

            port:

          timeoutSeconds:

        name:

Collapse all
        ports:

        - containerPort:

          hostIP:

          hostPort:

          name:

          protocol:

Collapse all
        readinessProbe:

Collapse all
          exec:

Collapse all
            command:

            - [string]:

          failureThreshold:

Collapse all
          httpGet:

            host:

Collapse all
            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

Collapse all
          tcpSocket:

            host:

            port:

          timeoutSeconds:

Collapse all
        resources:

Collapse all
          limits:

            [string]:

Collapse all
          requests:

            [string]:

Collapse all
        securityContext:

Collapse all
          capabilities:

Collapse all
            add:

            - [string]:

Collapse all
            drop:

            - [string]:

          privileged:

          readOnlyRootFilesystem:

          runAsNonRoot:

          runAsUser:

Collapse all
          seLinuxOptions:

            level:

            role:

            type:

            user:

        stdin:

        stdinOnce:

        terminationMessagePath:

        terminationMessagePolicy:

        tty:

Collapse all
        volumeMounts:

        - mountPath:

          name:

          readOnly:

          subPath:

        workingDir:

      dnsPolicy:

Collapse all
      hostAliases:

Collapse all
      - hostnames:

      - - [string]:

        ip:

      hostIPC:

      hostNetwork:

      hostPID:

      hostname:

Collapse all
      imagePullSecrets:

      - name:

Collapse all
      initContainers:

Collapse all
      - args:

      - - [string]:

Collapse all
        command:

        - [string]:

Collapse all
        env:

        - name:

          value:

Collapse all
          valueFrom:

Collapse all
            configMapKeyRef:

              key:

              name:

              optional:

Collapse all
            fieldRef:

              apiVersion:

              fieldPath:

Collapse all
            resourceFieldRef:

              containerName:

              divisor:

              resource:

Collapse all
            secretKeyRef:

              key:

              name:

              optional:

Collapse all
        envFrom:

Collapse all
        - configMapRef:

        -   name:

            optional:

          prefix:

Collapse all
          secretRef:

            name:

            optional:

        image:

        imagePullPolicy:

Collapse all
        lifecycle:

Collapse all
          postStart:

Collapse all
            exec:

Collapse all
              command:

              - [string]:

Collapse all
            httpGet:

              host:

Collapse all
              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

Collapse all
            tcpSocket:

              host:

              port:

Collapse all
          preStop:

Collapse all
            exec:

Collapse all
              command:

              - [string]:

Collapse all
            httpGet:

              host:

Collapse all
              httpHeaders:

              - name:

                value:

              path:

              port:

              scheme:

Collapse all
            tcpSocket:

              host:

              port:

Collapse all
        livenessProbe:

Collapse all
          exec:

Collapse all
            command:

            - [string]:

          failureThreshold:

Collapse all
          httpGet:

            host:

Collapse all
            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

Collapse all
          tcpSocket:

            host:

            port:

          timeoutSeconds:

        name:

Collapse all
        ports:

        - containerPort:

          hostIP:

          hostPort:

          name:

          protocol:

Collapse all
        readinessProbe:

Collapse all
          exec:

Collapse all
            command:

            - [string]:

          failureThreshold:

Collapse all
          httpGet:

            host:

Collapse all
            httpHeaders:

            - name:

              value:

            path:

            port:

            scheme:

          initialDelaySeconds:

          periodSeconds:

          successThreshold:

Collapse all
          tcpSocket:

            host:

            port:

          timeoutSeconds:

Collapse all
        resources:

Collapse all
          limits:

            [string]:

Collapse all
          requests:

            [string]:

Collapse all
        securityContext:

Collapse all
          capabilities:

Collapse all
            add:

            - [string]:

Collapse all
            drop:

            - [string]:

          privileged:

          readOnlyRootFilesystem:

          runAsNonRoot:

          runAsUser:

Collapse all
          seLinuxOptions:

            level:

            role:

            type:

            user:

        stdin:

        stdinOnce:

        terminationMessagePath:

        terminationMessagePolicy:

        tty:

Collapse all
        volumeMounts:

        - mountPath:

          name:

          readOnly:

          subPath:

        workingDir:

      nodeName:

Collapse all
      nodeSelector:

        [string]:

      restartPolicy:

      schedulerName:

Collapse all
      securityContext:

        fsGroup:

        runAsNonRoot:

        runAsUser:

Collapse all
        seLinuxOptions:

          level:

          role:

          type:

          user:

Collapse all
        supplementalGroups:

        - [integer]:

      serviceAccount:

      serviceAccountName:

      subdomain:

      terminationGracePeriodSeconds:

Collapse all
      tolerations:

      - effect:

        key:

        operator:

        tolerationSeconds:

        value:

Collapse all
      volumes:

Collapse all
      - awsElasticBlockStore:

      -   fsType:

          partition:

          readOnly:

          volumeID:

Collapse all
        azureDisk:

          cachingMode:

          diskName:

          diskURI:

          fsType:

          kind:

          readOnly:

Collapse all
        azureFile:

          readOnly:

          secretName:

          shareName:

Collapse all
        cephfs:

Collapse all
          monitors:

          - [string]:

          path:

          readOnly:

          secretFile:

Collapse all
          secretRef:

            name:

          user:

Collapse all
        cinder:

          fsType:

          readOnly:

          volumeID:

Collapse all
        configMap:

          defaultMode:

Collapse all
          items:

          - key:

            mode:

            path:

          name:

          optional:

Collapse all
        downwardAPI:

          defaultMode:

Collapse all
          items:

Collapse all
          - fieldRef:

          -   apiVersion:

              fieldPath:

            mode:

            path:

Collapse all
            resourceFieldRef:

              containerName:

              divisor:

              resource:

Collapse all
        emptyDir:

          medium:

          sizeLimit:

Collapse all
        fc:

          fsType:

          lun:

          readOnly:

Collapse all
          targetWWNs:

          - [string]:

Collapse all
        flexVolume:

          driver:

          fsType:

Collapse all
          options:

            [string]:

          readOnly:

Collapse all
          secretRef:

            name:

Collapse all
        flocker:

          datasetName:

          datasetUUID:

Collapse all
        gcePersistentDisk:

          fsType:

          partition:

          pdName:

          readOnly:

Collapse all
        gitRepo:

          directory:

          repository:

          revision:

Collapse all
        glusterfs:

          endpoints:

          path:

          readOnly:

Collapse all
        hostPath:

          path:

Collapse all
        iscsi:

          chapAuthDiscovery:

          chapAuthSession:

          fsType:

          iqn:

          iscsiInterface:

          lun:

Collapse all
          portals:

          - [string]:

          readOnly:

Collapse all
          secretRef:

            name:

          targetPortal:

        name:

Collapse all
        nfs:

          path:

          readOnly:

          server:

Collapse all
        persistentVolumeClaim:

          claimName:

          readOnly:

Collapse all
        photonPersistentDisk:

          fsType:

          pdID:

Collapse all
        portworxVolume:

          fsType:

          readOnly:

          volumeID:

Collapse all
        projected:

          defaultMode:

Collapse all
          sources:

Collapse all
          - configMap:

Collapse all
          -   items:

          -   - key:

                mode:

                path:

              name:

              optional:

Collapse all
            downwardAPI:

Collapse all
              items:

Collapse all
              - fieldRef:

              -   apiVersion:

                  fieldPath:

                mode:

                path:

Collapse all
                resourceFieldRef:

                  containerName:

                  divisor:

                  resource:

Collapse all
            secret:

Collapse all
              items:

              - key:

                mode:

                path:

              name:

              optional:

Collapse all
        quobyte:

          group:

          readOnly:

          registry:

          user:

          volume:

Collapse all
        rbd:

          fsType:

          image:

          keyring:

Collapse all
          monitors:

          - [string]:

          pool:

          readOnly:

Collapse all
          secretRef:

            name:

          user:

Collapse all
        scaleIO:

          fsType:

          gateway:

          protectionDomain:

          readOnly:

Collapse all
          secretRef:

            name:

          sslEnabled:

          storageMode:

          storagePool:

          system:

          volumeName:

Collapse all
        secret:

          defaultMode:

Collapse all
          items:

          - key:

            mode:

            path:

          optional:

          secretName:

Collapse all
        storageos:

          fsType:

          readOnly:

Collapse all
          secretRef:

            name:

          volumeName:

          volumeNamespace:

Collapse all
        vsphereVolume:

          fsType:

          storagePolicyID:

          storagePolicyName:

          volumePath:

Collapse all
status:

  availableReplicas:

  collisionCount:

Collapse all
  conditions:

  - lastTransitionTime:

    lastUpdateTime:

    message:

    reason:

    status:

    type:

  observedGeneration:

  readyReplicas:

  replicas:

  unavailableReplicas:

  updatedReplicas:

Operations

Create a Deployment

Create a Deployment

HTTP request

POST /apis/extensions/v1beta1/deployments HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Deployment",
  "apiVersion": "extensions/v1beta1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1beta1.Deployment

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1beta1.Deployment

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a Deployment in a namespace

Create a Deployment

HTTP request

POST /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Deployment",
  "apiVersion": "extensions/v1beta1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1beta1.Deployment

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

v1beta1.Deployment

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a Deployment in a namespace

Read the specified Deployment

HTTP request

GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME

Path parameters

Parameter Description

name

name of the Deployment

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

v1beta1.Deployment

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all Deployments

List or watch objects of kind Deployment

HTTP request

GET /apis/extensions/v1beta1/deployments 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/extensions/v1beta1/deployments

Query parameters

Parameter Description

pretty

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

fieldSelector

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

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.

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

v1beta1.DeploymentList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Get all Deployments in a namespace

List or watch objects of kind Deployment

HTTP request

GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments 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/extensions/v1beta1/namespaces/$NAMESPACE/deployments

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.

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.

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

v1beta1.DeploymentList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Watch a Deployment in a namespace

Watch changes to an object of kind Deployment

HTTP request

GET /apis/extensions/v1beta1/watch/namespaces/$NAMESPACE/deployments/$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/extensions/v1beta1/watch/namespaces/$NAMESPACE/deployments/$NAME

Path parameters

Parameter Description

name

name of the Deployment

namespace

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

Query parameters

Parameter Description

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.

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 Deployments

Watch individual changes to a list of Deployment

HTTP request

GET /apis/extensions/v1beta1/watch/deployments 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/extensions/v1beta1/watch/deployments

Query parameters

Parameter Description

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.

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 Deployments in a namespace

Watch individual changes to a list of Deployment

HTTP request

GET /apis/extensions/v1beta1/watch/namespaces/$NAMESPACE/deployments 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/extensions/v1beta1/watch/namespaces/$NAMESPACE/deployments

Path parameters

Parameter Description

namespace

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

Query parameters

Parameter Description

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.

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 Deployment in a namespace

Replace the specified Deployment

HTTP request

PUT /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Deployment",
  "apiVersion": "extensions/v1beta1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1beta1.Deployment

Path parameters

Parameter Description

name

name of the Deployment

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

v1beta1.Deployment

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a Deployment in a namespace

Partially update the specified Deployment

HTTP request

PATCH /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the Deployment

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

v1beta1.Deployment

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 Deployment in a namespace

Delete a Deployment

HTTP request

DELETE /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeleteOptions

Path parameters

Parameter Description

name

name of the Deployment

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.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete all Deployments in a namespace

Delete collection of Deployment

HTTP request

DELETE /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments 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/extensions/v1beta1/namespaces/$NAMESPACE/deployments

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.

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.

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

Create rollback of a Deployment in a namespace

Create rollback of a DeploymentRollback

HTTP request

POST /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/rollback HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "DeploymentRollback",
  "apiVersion": "extensions/v1beta1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/rollback <<'EOF'
{
  "kind": "DeploymentRollback",
  "apiVersion": "extensions/v1beta1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1beta1.DeploymentRollback

Path parameters

Parameter Description

name

name of the DeploymentRollback

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

v1beta1.DeploymentRollback

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get scale of a Deployment in a namespace

Read scale of the specified Scale

HTTP request

GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/scale 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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/scale

Path parameters

Parameter Description

name

name of the Scale

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

v1beta1.Scale

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update scale of a Deployment in a namespace

Replace scale of the specified Scale

HTTP request

PUT /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/scale HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Scale",
  "apiVersion": "extensions/v1beta1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1beta1.Scale

Path parameters

Parameter Description

name

name of the Scale

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

v1beta1.Scale

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch scale of a Deployment in a namespace

Partially update scale of the specified Scale

HTTP request

PATCH /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/scale 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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/scale <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the Scale

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

v1beta1.Scale

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

Get status of a Deployment in a namespace

Read status of the specified Deployment

HTTP request

GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/status

Path parameters

Parameter Description

name

name of the Deployment

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

v1beta1.Deployment

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update status of a Deployment in a namespace

Replace status of the specified Deployment

HTTP request

PUT /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Deployment",
  "apiVersion": "extensions/v1beta1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1beta1.Deployment

Path parameters

Parameter Description

name

name of the Deployment

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

v1beta1.Deployment

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch status of a Deployment in a namespace

Partially update status of the specified Deployment

HTTP request

PATCH /apis/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$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/extensions/v1beta1/namespaces/$NAMESPACE/deployments/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the Deployment

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

v1beta1.Deployment

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