GitLab Rollouts API

openapi: 3.2.0
info:
  title: GitLab REST Rollouts API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Rollouts
  description: Operations related to rollouts.
paths:
  /api/v4/rollouts/{id}:
    post:
      operationId: postApiV4RolloutsId
      summary: Ingest a rollout workflow event
      description: Reports flow-graph progress from the CD orchestrator (a Starlark workflow run by AutoFlow).
      tags:
      - Rollouts
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCdRollout'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: The ID of the rollout
        schema:
          type: integer
        in: path
        example: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RolloutsIdRequest'
components:
  schemas:
    postApiV4RolloutsIdRequest:
      type: object
      properties:
        topic:
          type:
          - string
          - 'null'
          description: The event topic
        type:
          type:
          - string
          - 'null'
          description: The event type
          maxLength: 255
        data:
          type:
          - object
          - 'null'
          description: The event payload. Exactly one of `data`, `value` must be provided.
          properties:
            position:
              type:
              - array
              - 'null'
              items:
                type: integer
              description: Zero-based path to the stage/step in the flow definition; required for every event except com.gitlab.cd.rollout_succeeded
            stage_name:
              type:
              - string
              - 'null'
              description: Name of the enclosing stage (an environment tier); absent for a step outside any stage
              maxLength: 255
            environment:
              type:
              - string
              - 'null'
              description: Exact name of the target GitLab environment; resolves the rollout environment to update when a stage deploys to more than one environment
              maxLength: 255
            step_type:
              type:
              - string
              - 'null'
              description: The step type, present on step_* events
              maxLength: 255
            service:
              type:
              - string
              - 'null'
              description: Name of the Cd::Service, present on service_started/service_succeeded/service_failed
              maxLength: 255
            error:
              type:
              - string
              - 'null'
              description: Failure detail, present on step_failed and service_failed
              maxLength: 2000
            reason:
              type:
              - string
              - 'null'
              description: Human-readable prompt, present on approval_requested
              maxLength: 2000
            reply:
              type:
              - string
              - 'null'
              description: Name of the AutoFlow channel to post the approval decision back into, present on approval_requested
              maxLength: 255
        value:
          type:
          - object
          - 'null'
          description: AutoFlow Value (protojson), decoded into the same topic/type/data shape as `data` above. Exactly one of `data`, `value` must be provided.
        channel_tokens:
          type:
          - array
          - 'null'
          description: AutoFlow channels opened alongside this event, for posting a value back into them later
          items:
            type: object
            properties:
              channel_name:
                type:
                - string
                - 'null'
                description: Name of the AutoFlow channel
                maxLength: 255
              token:
                type:
                - string
                - 'null'
                description: Token used to post a value into the channel
                maxLength: 4096
            required:
            - channel_name
            - token
    APIEntitiesCdRollout:
      type: object
      properties:
        id:
          type: integer
          example: 1
        iid:
          type: integer
          example: 1
        state:
          type: string
          example: in_progress
        workflow_ref:
          type: string
          example: cd-rollout-1
        started_at:
          type: string
          format: date-time
          example: '2026-07-22T11:37:00Z'
        finished_at:
          type: string
          format: date-time
          example: '2026-07-22T11:42:00Z'
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header