Use this API to interact with deployment freeze periods.
List all freeze periods
GET /api/v4/projects/{id}/freeze_periods
Lists all freeze periods for a specified project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
pageQuery | Integer | Current page number Default: 1Example: 1 |
per_Query | Integer | Number of items per page Default: 20Example: 20 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not found | — |
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.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
Request body (application/json)
| Property | Type | Description |
|---|---|---|
cron_ | String | The time zone for the cron fields, |
freeze_Required | String | End of the freeze period in cron format |
freeze_Required | String | Start of the freeze period in cron format |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Retrieve a freeze period
GET /api/v4/projects/{id}/freeze_periods/{freeze_period_id}
Retrieves a freeze period for a specified freeze_period_id. You must have the Reporter, Developer, Maintainer, or Owner role for the project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
freeze_Path, | Integer | The ID of the freeze period |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not found | — |
Update a freeze period
PUT /api/v4/projects/{id}/freeze_periods/{freeze_period_id}
Updates a freeze period for a specified freeze_period_id. You must have the Maintainer or Owner role for the project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
freeze_Path, | Integer | The ID of the freeze period |
Request body (application/json)
| Property | Type | Description |
|---|---|---|
cron_ | String | The time zone for the cron fields |
freeze_ | String | End of the freeze period in cron format |
freeze_ | String | Start of the freeze period in cron format |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Delete a freeze period
DELETE /api/v4/projects/{id}/freeze_periods/{freeze_period_id}
Deletes a freeze period for a specified freeze_period_id. You must have the Maintainer or Owner role for the project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String or integer | The ID or URL- |
freeze_Path, | Integer | The ID of the freeze period |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesFreezePeriod
| Property | Type | Description |
|---|---|---|
created_ | String (date- | Example:2020- |
cron_ | String | Example:UTC |
freeze_ | String | Example:0 8 * * 1 |
freeze_ | String | Example:0 23 * * 5 |
id | Integer (int64) | Example:1 |
updated_ | String (date- | Example:2020- |