---
title: "Create deployment group"
method: POST
path: "/deployment_group"
tags: ["Deployment group"]
---

# Create deployment group

`POST /deployment_group`

Create a new deployment group with multiple deployments.

## Request body

- DeploymentGroupCreateRequest — Request body for creating a new deployment group with multiple deployments.
  - `release_id` string, required — The ID of the release to deploy.
  - `deployments` DeploymentGroupObject[], required — A list of deployment objects to be included in the deployment group.
    - `scope_id` string, required — The ID of the scope where the deployment belongs.
    - `strategy` 'initial' | 'blue_green', required — The deployment strategy being used.
    - `strategy_data` object, required — Configuration data for the deployment strategy.
      - `switched_traffic` integer — Current percentage of traffic on the new version (0-100).
      - `desired_switched_traffic` integer — Target traffic percentage for the new version.
      - `amount_instances_to_wait` integer — Required number of instances before proceeding to the next step.
      - `healthy_instances` integer — Current count of healthy instances.
      - `launched_instances` integer — Total number of instances launched.
      - `switch_traffic_step` boolean — Indicates whether the deployment is in the active traffic switching phase.

## Response `201`

The operation was successful.

- DeploymentGroupResponse
  - `id` string, required — The ID of the deployment group.
  - `status` 'creating_approval' | 'creating_approval_denied' | 'creating' | 'waiting_for_instances' | 'running' | 'finalizing' | 'finalized' | 'cancelling' | 'cancelled' | 'failed' | 'rolling_back' | 'rolled_back' | 'deleting' | 'deleted', required — Status of the deployment group. > **Note**: See [Deployments](/docs/deployments) for more information. >
  - `deployments` DeploymentGroupObject[], required
    - `scope_id` string, required — The ID of the scope where the deployment belongs.
    - `strategy` 'initial' | 'blue_green', required — The deployment strategy being used.
    - `strategy_data` object, required — Configuration data for the deployment strategy.
      - `switched_traffic` integer — Current percentage of traffic on the new version (0-100).
      - `desired_switched_traffic` integer — Target traffic percentage for the new version.
      - `amount_instances_to_wait` integer — Required number of instances before proceeding to the next step.
      - `healthy_instances` integer — Current count of healthy instances.
      - `launched_instances` integer — Total number of instances launched.
      - `switch_traffic_step` boolean — Indicates whether the deployment is in the active traffic switching phase.
  - `scopes` ScopeDeploymentGroup[], required
    - `id` string — The ID of the scope where the deployment belongs.
    - `name` string — The name for the scope.
  - `strategy_data` object, required — Configuration data for the deployment strategy.
    - `switched_traffic` integer — Current percentage of traffic on the new version (0-100).
    - `desired_switched_traffic` integer — Target traffic percentage for the new version.
    - `amount_instances_to_wait` integer — Required number of instances before proceeding to the next step.
    - `healthy_instances` integer — Current count of healthy instances.
    - `launched_instances` integer — Total number of instances launched.
    - `switch_traffic_step` boolean — Indicates whether the deployment is in the active traffic switching phase.
  - `application_id` string, required — The ID of the application the deployment group belongs to.
  - `release_id` string, required — The ID of the release associated with the deployment.
  - `deployments_amount` integer, required — Number of deployments in the group
  - `created_by` string, required — The user ID of the creator of the deployment group.
  - `updated_by` string, required — The user ID of the last person who updated the deployment group.
  - `created_at` string, date-time, required — The ISO-8601 UTC timestamp of when the deployment group was created.
  - `updated_at` string, date-time, required — The ISO-8601 UTC timestamp of when the deployment group was last updated.

## Other responses

- `4XX` — Client error responses due to invalid input or missing parameters.
- `5XX` — Server error responses indicating an issue on the API side.

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)