---
title: "Creates a new deployment freeze."
method: POST
path: "/deploymentfreezes"
tags: ["DeploymentFreeze"]
---

# Creates a new deployment freeze.

`POST /deploymentfreezes`

## Request body

- CreateDeploymentFreezeCommand
  - `Description` string
  - `End` string, date-time, required
  - `Name` string, required
  - `ProjectEnvironmentScope` object
  - `Start` string, date-time, required

## Response `201`

Created

- CreateDeploymentFreezeResponse
  - `Description` string
  - `End` string, date-time, required
  - `Id` string, required
  - `Name` string, required
  - `ProjectEnvironmentScope` object
  - `RecurringSchedule` RecurringScheduleResource
    - `EndAfterOccurrences` integer
    - `EndDate` string, date-time
    - `EndOnDate` string, date-time
    - `EndType` 'Never' | 'OnDate' | 'AfterOccurrences'
    - `StartDate` string, date-time
    - `Type` 'Daily' | 'Weekly' | 'Monthly' | 'Annually'
    - `Unit` integer
    - `UserUtcOffsetInMinutes` integer
  - `Start` string, date-time, required
  - `TenantProjectEnvironmentScope` TenantProjectEnvironment[]
    - `EnvironmentId` string, required
    - `ProjectId` string, required
    - `TenantId` string, required

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

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