Skip to content

Create a freeze period

POST
/api/v4/projects/{id}/freeze_periods

Creates a freeze period for a specified project. You must have the Maintainer or Owner role for the project.

id
required
One of:
string

The ID or URL-encoded path of the project

Media type application/json
object
freeze_start
required

Start of the freeze period in cron format.

string
nullable
freeze_end
required

End of the freeze period in cron format

string
nullable
cron_timezone

The time zone for the cron fields, defaults to UTC if not provided

string
nullable
Example generated
{
"freeze_start": "example",
"freeze_end": "example",
"cron_timezone": "example"
}

Created

Media type application/json
object
id
integer format: int64
freeze_start
string
freeze_end
string
cron_timezone
string
created_at
string format: date-time
updated_at
string format: date-time
Example
{
"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:03:35.702Z"
}

Bad request

Unauthorized

Not Found