---
title: "Get DeploymentFreezes"
method: GET
path: "/deploymentfreezes"
tags: ["DeploymentFreeze"]
---

# Get DeploymentFreezes

`GET /deploymentfreezes`

Gets a paginated set of DeploymentFreezes.

## Query parameters

- `effectiveDate` string, date-time
- `environmentIds` string[]
- `ids` string[]
- `includeComplete` boolean
- `partialName` string
- `projectIds` string[]
- `skip` integer, required
- `status` string
- `take` integer, required
- `tenantIds` string[]

## Response `200`

Requested list of DeploymentFreezes

- GetDeploymentFreezesResponse
  - `Count` integer, required
  - `DeploymentFreezes` DeploymentFreezeResource[], required
    - `Description` string
    - `End` string, date-time, required
    - `Id` string, required
    - `Name` string, required
    - `ProjectEnvironmentScope` object, required
    - `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)