---
title: "pauses the Deployment"
method: PUT
path: "/api/v1/deployment/{namespace}/{deployment}/pause"
---

# pauses the Deployment

`PUT /api/v1/deployment/{namespace}/{deployment}/pause`

## Path parameters

- `namespace` string, required
- `deployment` string, required

## Query parameters

- `filterBy` string
- `sortBy` string
- `itemsPerPage` string
- `page` string
- `metricNames` string
- `aggregations` string

## Response `200`

OK

- DeploymentDeploymentDetail
  - `conditions` CommonCondition[], required
    - `lastProbeTime` V1Time, required
      - `Time` string, date-time, required
    - `lastTransitionTime` V1Time, required
      - `Time` string, date-time, required
    - `message` string, required
    - `reason` string, required
    - `status` string, required
    - `type` string, required
  - `containerImages` string[], required
  - `errors` Error[], required
    - unknown
  - `initContainerImages` string[], required
  - `minReadySeconds` integer, required
  - `objectMeta` TypesObjectMeta, required
    - `annotations` object
    - `creationTimestamp` V1Time
      - `Time` string, date-time, required
    - `labels` object
    - `name` string
    - `namespace` string
    - `uid` string
  - `pods` CommonPodInfo, required
    - `current` integer, required
    - `desired` integer
    - `failed` integer, required
    - `pending` integer, required
    - `running` integer, required
    - `succeeded` integer, required
    - `warnings` CommonEvent[], required
      - `count` integer, required
      - `firstSeen` V1Time, required
        - `Time` string, date-time, required
      - `lastSeen` V1Time, required
        - `Time` string, date-time, required
      - `message` string, required
      - `object` string, required
      - `objectKind` string
      - `objectMeta` TypesObjectMeta, required
        - `annotations` object
        - `creationTimestamp` V1Time
          - `Time` string, date-time, required
        - `labels` object
        - `name` string
        - `namespace` string
        - `uid` string
      - `objectName` string
      - `objectNamespace` string
      - `reason` string, required
      - `sourceComponent` string, required
      - `sourceHost` string, required
      - `type` string, required
      - `typeMeta` TypesTypeMeta, required
        - `kind` string
        - `restartable` boolean
        - `scalable` boolean
  - `revisionHistoryLimit` integer, required
  - `rollingUpdateStrategy` DeploymentRollingUpdateStrategy
    - `maxSurge` IntstrIntOrString, required
      - `IntVal` integer, required
      - `StrVal` string, required
      - `Type` integer, required
    - `maxUnavailable` IntstrIntOrString, required
      - `IntVal` integer, required
      - `StrVal` string, required
      - `Type` integer, required
  - `selector` object, required
  - `statusInfo` DeploymentStatusInfo, required
    - `available` integer, required
    - `replicas` integer, required
    - `unavailable` integer, required
    - `updated` integer, required
  - `strategy` string, required
  - `typeMeta` TypesTypeMeta, required
    - `kind` string
    - `restartable` boolean
    - `scalable` boolean

---

[API](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api.md) · [All operations](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/karmada-io/kubernetes-dashboard-api/versions/8521b53800a7/schema)