gitlab-org--gitlab-foss/doc/api/freeze_periods.md

stage	group	info	type
Release	Release	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments	concepts, howto

Freeze Periods API

Introduced in GitLab 13.0.

You can use the Freeze Periods API to manipulate GitLab's Freeze Period entries.

Permissions and security

Only users with Maintainer permissions can interact with the Freeze Period API endpoints.

List Freeze Periods

Paginated list of Freeze Periods, sorted by created_at in ascending order.

GET /projects/:id/freeze_periods

Attribute	Type	Required	Description
id	integer/string	yes	The ID or URL-encoded path of the project.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/19/freeze_periods"

Example response:

[
   {
      "id":1,
      "freeze_start":"0 23 * * 5",
      "freeze_end":"0 8 * * 1",
      "cron_timezone":"UTC",
      "created_at":"2020-05-15T17:03:35.702Z",
      "updated_at":"2020-05-15T17:06:41.566Z"
   }
]

Get a Freeze Period by a freeze_period_id

Get a Freeze Period for the given freeze_period_id.

GET /projects/:id/freeze_periods/:freeze_period_id

Attribute	Type	Required	Description
id	integer or string	yes	The ID or URL-encoded path of the project.
freeze_period_id	string	yes	The database ID of the Freeze Period.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"

Example response:

{
   "id":1,
   "freeze_start":"0 23 * * 5",
   "freeze_end":"0 8 * * 1",
   "cron_timezone":"UTC",
   "created_at":"2020-05-15T17:03:35.702Z",
   "updated_at":"2020-05-15T17:06:41.566Z"
}

Create a Freeze Period

Create a Freeze Period.

POST /projects/:id/freeze_periods

Attribute	Type	Required	Description
id	integer or string	yes	The ID or URL-encoded path of the project.
freeze_start	string	yes	Start of the Freeze Period in cron format.
freeze_end	string	yes	End of the Freeze Period in cron format.
cron_timezone	string	no	The timezone for the cron fields, defaults to UTC if not provided.

Example request:

curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: <your_access_token>" \
     --data '{ "freeze_start": "0 23 * * 5", "freeze_end": "0 7 * * 1", "cron_timezone": "UTC" }' \
     --request POST "https://gitlab.example.com/api/v4/projects/19/freeze_periods"

Example response:

{
   "id":1,
   "freeze_start":"0 23 * * 5",
   "freeze_end":"0 7 * * 1",
   "cron_timezone":"UTC",
   "created_at":"2020-05-15T17:03:35.702Z",
   "updated_at":"2020-05-15T17:03:35.702Z"
}

Update a Freeze Period

Update a Freeze Period for the given freeze_period_id.

PUT /projects/:id/freeze_periods/:tag_name

Attribute	Type	Required	Description
id	integer or string	yes	The ID or URL-encoded path of the project.
freeze_period_id	integer or string	yes	The database ID of the Freeze Period.
freeze_start	string	no	Start of the Freeze Period in cron format.
freeze_end	string	no	End of the Freeze Period in cron format.
cron_timezone	string	no	The timezone for the cron fields.

Example request:

curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: <your_access_token>" \
     --data '{ "freeze_end": "0 8 * * 1" }' \
     --request PUT "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"

Example response:

{
   "id":1,
   "freeze_start":"0 23 * * 5",
   "freeze_end":"0 8 * * 1",
   "cron_timezone":"UTC",
   "created_at":"2020-05-15T17:03:35.702Z",
   "updated_at":"2020-05-15T17:06:41.566Z"
}

Delete a Freeze Period

Delete a Freeze Period for the given freeze_period_id.

DELETE /projects/:id/freeze_periods/:freeze_period_id

Attribute	Type	Required	Description
id	integer or string	yes	The ID or URL-encoded path of the project.
freeze_period_id	string	yes	The database ID of the Freeze Period.

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"