Freeze Periods API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

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

Permissions and security

Users with Reporter permissions or greater can read Freeze Period API endpoints. Only users with the Maintainer role can modify Freeze Periods.

List freeze periods

Paginated list of freeze periods, sorted by created_at in ascending order.

Copy to clipboard
GET /projects/:id/freeze_periods
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.

Example request:

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

Example response:

Copy to clipboard
[
   {
      "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.

Copy to clipboard
GET /projects/:id/freeze_periods/:freeze_period_id
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
freeze_period_idintegeryesThe ID of the freeze period.

Example request:

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

Example response:

Copy to clipboard
{
   "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.

Copy to clipboard
POST /projects/:id/freeze_periods
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
freeze_startstringyesStart of the freeze period in cron format.
freeze_endstringyesEnd of the freeze period in cron format.
cron_timezonestringnoThe time zone for the cron fields, defaults to UTC if not provided.

Example request:

Copy to clipboard
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:

Copy to clipboard
{
   "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.

Copy to clipboard
PUT /projects/:id/freeze_periods/:freeze_period_id
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
freeze_period_idintegeryesThe ID of the freeze period.
freeze_startstringnoStart of the freeze period in cron format.
freeze_endstringnoEnd of the freeze period in cron format.
cron_timezonestringnoThe time zone for the cron fields.

Example request:

Copy to clipboard
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:

Copy to clipboard
{
   "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.

Copy to clipboard
DELETE /projects/:id/freeze_periods/:freeze_period_id
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
freeze_period_idintegeryesThe ID of the freeze period.

Example request:

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