This is a cache of https://docs.openshift.com/container-platform/3.9/rest_api/api/v1.ReplicationController.html. It is a snapshot of the page at 2024-11-29T03:07:10.811+0000.
v1.ReplicationController - /api/v1 | REST API Reference | OpenShift Container Platform 3.9
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

v1.ReplicationController

Description

ReplicationController represents the configuration of a replication controller.

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:

        resourceVersion:

        selfLink:

      reason:

      status:

  labels:

    [string]:

  name:

  namespace:

  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

spec:

  minReadySeconds:

  replicas:

  selector:

    [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:

            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:

          capabilities:

            add:

            - [string]:

            drop:

            - [string]:

          privileged:

          readOnlyRootFilesystem:

          runAsNonRoot:

          runAsUser:

          seLinuxOptions:

            level:

            role:

            type:

            user:

        stdin:

        stdinOnce:

        terminationMessagePath:

        terminationMessagePolicy:

        tty:

        volumeMounts:

        - mountPath:

          name:

          readOnly:

          subPath:

        workingDir:

      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:

          capabilities:

            add:

            - [string]:

            drop:

            - [string]:

          privileged:

          readOnlyRootFilesystem:

          runAsNonRoot:

          runAsUser:

          seLinuxOptions:

            level:

            role:

            type:

            user:

        stdin:

        stdinOnce:

        terminationMessagePath:

        terminationMessagePolicy:

        tty:

        volumeMounts:

        - mountPath:

          name:

          readOnly:

          subPath:

        workingDir:

      nodeName:

      nodeSelector:

        [string]:

      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]:

        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:

        iscsi:

          chapAuthDiscovery:

          chapAuthSession:

          fsType:

          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:

status:

  availableReplicas:

  conditions:

  - lastTransitionTime:

    message:

    reason:

    status:

    type:

  fullyLabeledReplicas:

  observedGeneration:

  readyReplicas:

  replicas:

Operations

Create a ReplicationController

Create a ReplicationController

HTTP request

POST /api/v1/replicationcontrollers HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/replicationcontrollers <<'EOF'
{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ReplicationController

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.ReplicationController

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a ReplicationController in a namespace

Create a ReplicationController

HTTP request

POST /api/v1/namespaces/$NAMESPACE/replicationcontrollers HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/replicationcontrollers <<'EOF'
{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ReplicationController

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

v1.ReplicationController

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a ReplicationController in a namespace

Read the specified ReplicationController

HTTP request

GET /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME

Path parameters

Parameter Description

name

name of the ReplicationController

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

v1.ReplicationController

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all ReplicationControllers

List or watch objects of kind ReplicationController

HTTP request

GET /api/v1/replicationcontrollers 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/api/v1/replicationcontrollers

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.ReplicationControllerList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Get all ReplicationControllers in a namespace

List or watch objects of kind ReplicationController

HTTP request

GET /api/v1/namespaces/$NAMESPACE/replicationcontrollers 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/api/v1/namespaces/$NAMESPACE/replicationcontrollers

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.ReplicationControllerList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Watch a ReplicationController in a namespace

Watch changes to an object of kind ReplicationController

HTTP request

GET /api/v1/watch/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/watch/namespaces/$NAMESPACE/replicationcontrollers/$NAME

Path parameters

Parameter Description

name

name of the ReplicationController

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 ReplicationControllers

Watch individual changes to a list of ReplicationController

HTTP request

GET /api/v1/watch/replicationcontrollers 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/api/v1/watch/replicationcontrollers

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

Watch individual changes to a list of ReplicationController

HTTP request

GET /api/v1/watch/namespaces/$NAMESPACE/replicationcontrollers 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/api/v1/watch/namespaces/$NAMESPACE/replicationcontrollers

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

Replace the specified ReplicationController

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME <<'EOF'
{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ReplicationController

Path parameters

Parameter Description

name

name of the ReplicationController

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

v1.ReplicationController

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a ReplicationController in a namespace

Partially update the specified ReplicationController

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the ReplicationController

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

v1.ReplicationController

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

Delete a ReplicationController

HTTP request

DELETE /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.DeleteOptions

Path parameters

Parameter Description

name

name of the ReplicationController

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

Delete collection of ReplicationController

HTTP request

DELETE /api/v1/namespaces/$NAMESPACE/replicationcontrollers 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/api/v1/namespaces/$NAMESPACE/replicationcontrollers

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

Get scale of a ReplicationController in a namespace

Read scale of the specified Scale

HTTP request

GET /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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

v1.Scale

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get scale of a ReplicationController in a namespace

Read scale of the specified Scale

HTTP request

GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/replicationcontrollers/$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/replicationcontrollers/$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 ReplicationController in a namespace

Replace scale of the specified Scale

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME/scale HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "Scale",
  "apiVersion": "autoscaling/v1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1.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

v1.Scale

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update scale of a ReplicationController in a namespace

Replace scale of the specified Scale

HTTP request

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

{
  "kind": "Scale",
  "apiVersion": "v1",
  ...
}

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/replicationcontrollers/$NAME/scale <<'EOF'
{
  "kind": "Scale",
  "apiVersion": "v1",
  ...
}
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 ReplicationController in a namespace

Partially update scale of the specified Scale

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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

v1.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

Patch scale of a ReplicationController in a namespace

Partially update scale of the specified Scale

HTTP request

PATCH /apis/extensions/v1beta1/namespaces/$NAMESPACE/replicationcontrollers/$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/replicationcontrollers/$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 ReplicationController in a namespace

Read status of the specified ReplicationController

HTTP request

GET /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME/status

Path parameters

Parameter Description

name

name of the ReplicationController

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

v1.ReplicationController

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update status of a ReplicationController in a namespace

Replace status of the specified ReplicationController

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ReplicationController",
  "apiVersion": "v1",
  ...
}

Curl request

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

HTTP body

Parameter Schema

body

v1.ReplicationController

Path parameters

Parameter Description

name

name of the ReplicationController

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

v1.ReplicationController

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch status of a ReplicationController in a namespace

Partially update status of the specified ReplicationController

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/replicationcontrollers/$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/api/v1/namespaces/$NAMESPACE/replicationcontrollers/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the ReplicationController

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

v1.ReplicationController

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