GitLab CI/CD

GitLab CI/CD freeze_periods API

Operations related to deploy freeze periods

GitHub OpenAPI

Operations 5

GET /api/v4/projects/{id}/freeze_periods List freeze periods #
POST /api/v4/projects/{id}/freeze_periods Create a freeze period #
GET /api/v4/projects/{id}/freeze_periods/{freeze_period_id} Get a freeze period #
PUT /api/v4/projects/{id}/freeze_periods/{freeze_period_id} Update a freeze period #
DELETE /api/v4/projects/{id}/freeze_periods/{freeze_period_id} Delete a freeze period #

Documentation

📖
Documentation
https://docs.gitlab.com/api/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-freeze-periods-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://docs.gitlab.com/api/openapi/openapi_v2.yaml
🔗
InteractiveDocs
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab-ci-freeze-periods-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-ci-freeze-periods-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab access_requests Freeze Periods API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: freeze_periods
  description: Operations related to deploy freeze periods
paths:
  /api/v4/projects/{id}/freeze_periods:
    get:
      summary: List freeze periods
      description: Paginated list of Freeze Periods, sorted by created_at in ascending order. This feature was introduced in GitLab 13.0.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        schema:
          type: string
      - in: query
        name: page
        description: Current page number
        required: false
        example: 1
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: per_page
        description: Number of items per page
        required: false
        example: 20
        schema:
          type: integer
          format: int32
          default: 20
      responses:
        '200':
          description: List freeze periods
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_FreezePeriod'
        '401':
          description: Unauthorized
        '404':
          description: Not found
      tags:
      - freeze_periods
      operationId: getApiV4ProjectsIdFreezePeriods
    post:
      summary: Create a freeze period
      description: Creates a freeze period. This feature was introduced in GitLab 13.0.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Create a freeze period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_FreezePeriod'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      tags:
      - freeze_periods
      operationId: postApiV4ProjectsIdFreezePeriods
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdFreezePeriods'
        required: true
  /api/v4/projects/{id}/freeze_periods/{freeze_period_id}:
    get:
      summary: Get a freeze period
      description: Get a freeze period for the given `freeze_period_id`. This feature was introduced in GitLab 13.0.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        schema:
          type: string
      - in: path
        name: freeze_period_id
        description: The ID of the freeze period
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get a freeze period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_FreezePeriod'
        '401':
          description: Unauthorized
        '404':
          description: Not found
      tags:
      - freeze_periods
      operationId: getApiV4ProjectsIdFreezePeriodsFreezePeriodId
    put:
      summary: Update a freeze period
      description: Updates a freeze period for the given `freeze_period_id`. This feature was introduced in GitLab 13.0.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        schema:
          type: string
      - in: path
        name: freeze_period_id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Update a freeze period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_FreezePeriod'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      tags:
      - freeze_periods
      operationId: putApiV4ProjectsIdFreezePeriodsFreezePeriodId
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdFreezePeriodsFreezePeriodId'
        required: true
    delete:
      summary: Delete a freeze period
      description: Deletes a freeze period for the given `freeze_period_id`. This feature was introduced in GitLab 13.0.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        schema:
          type: string
      - in: path
        name: freeze_period_id
        description: The ID of the freeze period
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '401':
          description: Unauthorized
        '204':
          description: Delete a freeze period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_FreezePeriod'
      tags:
      - freeze_periods
      operationId: deleteApiV4ProjectsIdFreezePeriodsFreezePeriodId
components:
  schemas:
    putApiV4ProjectsIdFreezePeriodsFreezePeriodId:
      type: object
      properties:
        freeze_start:
          type: string
          description: Start of the freeze period in cron format
        freeze_end:
          type: string
          description: End of the freeze period in cron format
        cron_timezone:
          type: string
          description: The time zone for the cron fields
      description: Update a freeze period
    API_Entities_FreezePeriod:
      type: object
      properties:
        id:
          type: integer
          format: int32
          example: 1
        freeze_start:
          type: string
          example: 0 23 * * 5
        freeze_end:
          type: string
          example: 0 8 * * 1
        cron_timezone:
          type: string
          example: UTC
        created_at:
          type: string
          format: date-time
          example: '2020-05-15T17:03:35.702Z'
        updated_at:
          type: string
          format: date-time
          example: '2020-05-15T17:03:35.702Z'
      required:
      - id
      - freeze_start
      - freeze_end
      - cron_timezone
      - created_at
      - updated_at
      description: API_Entities_FreezePeriod model
    postApiV4ProjectsIdFreezePeriods:
      type: object
      properties:
        freeze_start:
          type: string
          description: Start of the freeze period in cron format.
        freeze_end:
          type: string
          description: End of the freeze period in cron format
        cron_timezone:
          type: string
          description: The time zone for the cron fields, defaults to UTC if not provided
      required:
      - freeze_start
      - freeze_end
      description: Create a freeze period
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query