GitLab External status checks API

openapi: 3.2.0
info:
  title: GitLab REST External status checks 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: External status checks
  description: Use this API to manage external status checks.
  x-displayName: External status checks
  externalDocs:
    url: https://docs.gitlab.com/api/status_checks/
paths:
  /api/v4/projects/{id}/external_status_checks:
    post:
      operationId: postApiV4ProjectsIdExternalStatusChecks
      summary: Create external status check service
      description: Creates an external status check service for a specified project.
      tags:
      - External status checks
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesExternalStatusCheck'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdExternalStatusChecksRequest'
      x-gitlab-tier: ultimate
    get:
      operationId: getApiV4ProjectsIdExternalStatusChecks
      summary: Retrieve project external status check services
      description: Retrieves information on external status check services for a project.
      tags:
      - External status checks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesExternalStatusCheck'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      x-gitlab-tier: ultimate
  /api/v4/projects/{id}/external_status_checks/{check_id}:
    put:
      operationId: putApiV4ProjectsIdExternalStatusChecksCheckId
      summary: Update external status check service
      description: Updates an existing external status check for a project.
      tags:
      - External status checks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesExternalStatusCheck'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: check_id
        required: true
        description: ID of the external status check.
        schema:
          type: integer
        in: path
        example: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdExternalStatusChecksCheckIdRequest'
      x-gitlab-tier: ultimate
    delete:
      operationId: deleteApiV4ProjectsIdExternalStatusChecksCheckId
      summary: Delete external status check service
      description: Deletes a specified external status check service for a project.
      tags:
      - External status checks
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: check_id
        required: true
        description: ID of the external status check.
        schema:
          type: integer
        in: path
      x-gitlab-tier: ultimate
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/status_check_responses:
    post:
      operationId: postApiV4ProjectsIdMergeRequestsMergeRequestIidStatusCheckResponses
      summary: Update status of an external status check
      description: Updates the status of an external status check for a specified merge request, informing GitLab that a merge request has passed a check by an external service. To set the status of an external check, the personal access token used must belong to a user with the Developer, Maintainer, or Owner role on the target project of the merge request. Any user with permission to approve the merge request can use this operation.
      tags:
      - External status checks
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMergeRequestsStatusCheckResponse'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: '1'
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
        example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdMergeRequestsMergeRequestIidStatusCheckResponsesRequest'
      x-gitlab-tier: ultimate
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/status_checks:
    get:
      operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidStatusChecks
      summary: List all status checks for a merge request
      description: Lists all external status check services for a specified merge request and their status.
      tags:
      - External status checks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesMergeRequestsStatusCheck'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      x-gitlab-tier: ultimate
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/status_checks/{external_status_check_id}/retry:
    post:
      operationId: postApiV4ProjectsIdMergeRequestsMergeRequestIidStatusChecksExternalStatusCheckIdRetry
      summary: Retry failed status check for a merge request
      description: Retries a specified failed external status check for a merge request. Even though the merge request has not changed, this endpoint resends the current state of merge request to the defined external service.
      tags:
      - External status checks
      responses:
        '202':
          description: Accepted
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: '1'
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
        example: 1
      - name: external_status_check_id
        required: true
        description: ID of the failed external status check.
        schema:
          type: integer
        in: path
      x-gitlab-tier: ultimate
components:
  schemas:
    putApiV4ProjectsIdExternalStatusChecksCheckIdRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Display name of the external status check service.
          example: QA
        shared_secret:
          type:
          - string
          - 'null'
          description: HMAC secret for the external status check.
          example: hmac-sha256
        external_url:
          type:
          - string
          - 'null'
          description: URL of the external status check service.
          example: https://www.example.com
        protected_branch_ids:
          type:
          - array
          - 'null'
          items:
            type: integer
          description: IDs of protected branches to scope the rule by.
    APIEntitiesProtectedRefAccess:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        access_level:
          type: integer
          example: 40
        access_level_description:
          type: string
          example: Maintainers
        deploy_key_id:
          type: integer
          format: int64
          example: 1
        user_id:
          type: integer
          format: int64
          example: 1
        group_id:
          type: integer
          format: int64
          example: 1
        member_role_id:
          type: integer
          format: int64
          example: 42
        member_role_name:
          type: string
          example: Lead Developer
    APIEntitiesMergeRequest:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 84
        iid:
          type: integer
          example: 14
        project_id:
          type: integer
          format: int64
          example: 4
        title:
          type: string
          example: Impedit et ut et dolores vero provident ullam est
        description:
          type: string
          example: Repellendus impedit et vel velit dignissimos.
        state:
          type: string
          example: closed
        created_at:
          type: string
          format: date-time
          example: '2022-08-17T12:46:35.053Z'
        updated_at:
          type: string
          format: date-time
          example: '2022-11-14T17:22:01.470Z'
        merged_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        merge_user:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        merged_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        closed_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        closed_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        title_html:
          type: string
        description_html:
          type: string
        target_branch:
          type: string
        source_branch:
          type: string
        user_notes_count:
          type: integer
        upvotes:
          type: integer
        downvotes:
          type: integer
        author:
          $ref: '#/components/schemas/APIEntitiesMergeRequestAuthor'
        assignees:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        assignee:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        reviewers:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        source_project_id:
          type: integer
          format: int64
        target_project_id:
          type: integer
          format: int64
        labels:
          type: array
          items:
            type: string
        draft:
          type: boolean
        imported:
          type: boolean
        imported_from:
          type: string
          example: bitbucket
        work_in_progress:
          type: boolean
        milestone:
          $ref: '#/components/schemas/APIEntitiesMilestone'
        merge_when_pipeline_succeeds:
          type: boolean
        merge_status:
          type: string
          example: unchecked
        detailed_merge_status:
          type: string
          example: mergeable
        merge_after:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        sha:
          type: string
          example: 1234abcd
        merge_commit_sha:
          type: string
          example: 1234abcd
        squash_commit_sha:
          type: string
          example: 1234abcd
        discussion_locked:
          type: boolean
        should_remove_source_branch:
          type: boolean
        force_remove_source_branch:
          type: boolean
        prepared_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        allow_collaboration:
          type: boolean
        allow_maintainer_to_push:
          type: boolean
        reference:
          type: string
          example: '!1'
        references:
          $ref: '#/components/schemas/APIEntitiesIssuableReferences'
        web_url:
          type: string
          example: https://gitlab.example.com/my-group/my-project/-/merge_requests/1
        time_stats:
          $ref: '#/components/schemas/APIEntitiesIssuableTimeStats'
        squash:
          type: boolean
        squash_on_merge:
          type: boolean
        task_completion_status:
          $ref: '#/components/schemas/APIEntitiesTaskCompletionStatus'
        has_conflicts:
          type: boolean
        blocking_discussions_resolved:
          type: boolean
        approvals_before_merge:
          type: integer
          example: 2
        subscribed:
          type: boolean
        changes_count:
          type: string
          example: '1'
        latest_build_started_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        latest_build_finished_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        first_deployed_to_production_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipelineBasic'
        head_pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipeline'
        diff_refs:
          $ref: '#/components/schemas/APIEntitiesDiffRefs'
        merge_error:
          type: string
          example: Merge error
        rebase_in_progress:
          type: boolean
        diverged_commits_count:
          type: integer
          example: 0
        first_contribution:
          type: boolean
        user:
          type: object
          properties:
            can_merge:
              type: boolean
    APIEntitiesMergeRequestsStatusCheckResponseExternalStatusCheck:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: QA
        external_url:
          type: string
          example: https://www.example.com
    APIEntitiesUserBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
    APIEntitiesMilestone:
      type: object
      properties:
        id:
          type: integer
          format: int64
        iid:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        group_id:
          type: string
        title:
          type: string
        description:
          type: string
        state:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        due_date:
          type: string
        start_date:
          type: string
        expired:
          type: boolean
        web_url:
          type: string
    APIEntitiesMergeRequestAuthor:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
        bot:
          type: boolean
          example: false
    APIEntitiesMergeRequestsStatusCheckResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        merge_request:
          $ref: '#/components/schemas/APIEntitiesMergeRequest'
        external_status_check:
          $ref: '#/components/schemas/APIEntitiesMergeRequestsStatusCheckResponseExternalStatusCheck'
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    APIEntitiesCiPipeline:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 2
        project_id:
          type: integer
          format: int64
          example: 3
        sha:
          type: string
          example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
        ref:
          type: string
          example: feature-branch
        status:
          type: string
          example: success
        source:
          type: string
          example: push
        created_at:
          type: string
          format: date-time
          example: '2015-12-24T15:51:21.880Z'
        updated_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:31.198Z'
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
        before_sha:
          type: string
          example: a91957a858320c0e17f3a0eca7cfacbff50ea29a
        tag:
          type: boolean
          example: false
        yaml_errors:
          type: string
          example: 'widgets:build: needs ''widgets:test'''
        user:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        started_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:30.733Z'
        finished_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:31.198Z'
        committed_at:
          type: string
          format: date-time
          example: '2015-12-24T15:51:21.880Z'
        duration:
          type: integer
          description: Time spent running in seconds
          example: 127
        queued_duration:
          type: integer
          description: Time spent enqueued in seconds
          example: 63
        coverage:
          type: number
          format: float
          example: 98.29
        detailed_status:
          $ref: '#/components/schemas/DetailedStatusEntity'
        archived:
          type: boolean
          example: false
    APIEntitiesExternalStatusCheck:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: QA
        project_id:
          type: integer
          format: int64
          example: 1
        external_url:
          type: string
          example: https://www.example.com
        protected_branches:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesProtectedBranch'
        hmac:
          type: boolean
          example: true
    DetailedStatusEntity:
      type: object
      properties:
        icon:
          type: string
          example: status_success
        text:
          type: string
          example: passed
        label:
          type: string
          example: passed
        group:
          type: string
          example: success
        tooltip:
          type: string
          example: passed
        has_details:
          type: boolean
          example: true
        details_path:
          type: string
          example: /test-group/test-project/-/pipelines/287
        illustration:
          type: object
          example:
            image: illustrations/empty-state/empty-job-not-triggered-md.svg
            size: ''
            title: This job has not been triggered yet
            content: This job depends on upstream jobs that need to succeed in order for this job to be triggered
        favicon:
          type: string
          example: /assets/ci_favicons/favicon_status_success.png
        action:
          type: object
          properties:
            icon:
              type: string
              example: cancel
            title:
              type: string
              example: Cancel
            path:
              type: string
              example: /namespace1/project1/-/jobs/2/cancel
            method:
              type: string
              example: post
            button_title:
              type: string
              example: Cancel this job
            confirmation_message:
              type: string
              example: Are you sure?
    APIEntitiesTaskCompletionStatus:
      type: object
      properties:
        count:
          type: integer
          example: 5
        completed_count:
          type: integer
          example: 3
    APIEntitiesIssuableTimeStats:
      type: object
      properties:
        time_estimate:
          type: integer
          example: 12600
        total_time_spent:
          type: integer
          example: 3600
        human_time_estimate:
          type: string
          example: 3h 30m
        human_total_time_spent:
          type: string
          example: 1h
    APIEntitiesProtectedBranch:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: main
        push_access_levels:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesProtectedRefAccess'
        merge_access_levels:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesProtectedRefAccess'
        allow_force_push:
          type: boolean
        unprotect_access_levels:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesProtectedRefAccess'
        code_owner_approval_required:
          type: boolean
        inherited:
          type: boolean
    postApiV4ProjectsIdExternalStatusChecksRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Display name of the external status check service.
          example: QA
        shared_secret:
          type:
          - string
          - 'null'
          description: HMAC secret for the external status check.
          example: hmac-sha256
        external_url:
          type:
          - string
          - 'null'
          description: URL of the external status check service.
          example: https://www.example.com
        protected_branch_ids:
          type:
          - array
          - 'null'
          items:
            type: integer
          description: IDs of protected branches to scope the rule by.
      required:
      - name
      - external_url
    APIEntitiesIssuableReferences:
      type: object
      properties:
        short:
          type: string
          example: '&6'
        relative:
          type: string
          example: '&6'
        full:
          type: string
          example: test&6
    APIEntitiesDiffRefs:
      type: object
      properties:
        base_sha:
          type: string
          example: b83d6e391c22777fca1ed3012fce84f633d7fed0
        head_sha:
          type: string
          example: b83d6e391c22777fca1ed3012fce84f633d7fed0
        start_sha:
          type: string
          example: b83d6e391c22777fca1ed3012fce84f633d7fed0
    APIEntitiesCiPipelineBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 2
        project_id:
          type: integer
          format: int64
          example: 3
        sha:
          type: string
          example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
        ref:
          type: string
          example: feature-branch
        status:
          type: string
          example: success
        source:
          type: string
          example: push
        created_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        updated_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
    postApiV4ProjectsIdMergeRequestsMergeRequestIidStatusCheckResponsesRequest:
      type: object
      properties:
        external_status_check_id:
          type:
          - integer
          - 'null'
          description: ID of the external status check.
          example: 1
        sha:
          type:
          - string
          - 'null'
          description: SHA at `HEAD` of the source branch.
          example: 5957a570eee0ac4580ec027fb874ad7514d1e576
        status:
          type: string
          enum:
          - passed
          - failed
          - pending
          description: Status of the check.
          minLength: 1
      required:
      - external_status_check_id
      - sha
      - status
    APIEntitiesMergeRequestsStatusCheck:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: QA
        external_url:
          type: string
          example: https://www.example.com
        status:
          type: string
          example: passed
  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