GitLab Data management API

openapi: 3.2.0
info:
  title: GitLab REST Data management 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: Data management
  description: '> [!note]

    > These endpoints are an experiment.


    Use this API to inspect and checksum the records that an instance stores for a given model.


    These endpoints require administrator access to the instance.'
  x-displayName: Data management
  externalDocs:
    url: https://docs.gitlab.com/api/admin/data_management/
paths:
  /api/v4/admin/data_management/{model_name}/{record_identifier}:
    get:
      operationId: getApiV4AdminDataManagementModelNameRecordIdentifier
      summary: Retrieve information about a model record
      description: Retrieves information about a specified model record. Only available to administrators.
      tags:
      - Data management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAdminModel'
        '400':
          description: 400 Bad request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Model Not Found
      parameters:
      - name: model_name
        required: true
        description: See https://docs.gitlab.com/administration/admin_area/#data-management for the list of allowed values
        schema:
          type: string
          minLength: 1
        in: path
        example: uploads
      - name: record_identifier
        required: true
        description: Unique identifier of the record. Can be an integer or a Base64-encoded string, as returned by the list endpoint.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
  /api/v4/admin/data_management/{model_name}/{record_identifier}/checksum:
    put:
      operationId: putApiV4AdminDataManagementModelNameRecordIdentifierChecksum
      summary: Recalculate the checksum of a model record
      description: Recalculates the checksum of a specified model record. The checksum value is a representation of the queried model hashed with the md5 or sha256 algorithm. Only available to administrators on primary Geo sites.
      tags:
      - Data management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAdminModel'
        '400':
          description: 400 Bad request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Model Not Found
      parameters:
      - name: model_name
        required: true
        description: See https://docs.gitlab.com/administration/admin_area/#data-management for the list of allowed values
        schema:
          type: string
          minLength: 1
        in: path
        example: uploads
      - name: record_identifier
        required: true
        description: Unique identifier of the record, as returned by the list endpoint.
        schema:
          type: integer
        in: path
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
  /api/v4/admin/data_management/{model_name}:
    get:
      operationId: getApiV4AdminDataManagementModelName
      summary: Retrieve model information
      description: Retrieves information about a data model in an instance. Only available to administrators.
      tags:
      - Data management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesAdminModel'
        '400':
          description: 400 Bad request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Model Not Found
      parameters:
      - name: model_name
        required: true
        description: See https://docs.gitlab.com/administration/admin_area/#data-management for the list of allowed values
        schema:
          type: string
          minLength: 1
        in: path
        example: uploads
      - 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
      - name: identifiers
        required: false
        description: Filter results with an array of unique identifiers of the requested model, which can be integers or base64 encoded strings.
        schema:
          oneOf:
          - type:
            - array
            - 'null'
            items:
              type: integer
          - type:
            - array
            - 'null'
            items:
              type: string
        in: query
      - name: checksum_state
        required: false
        description: Filter by checksum status.
        schema:
          type:
          - string
          - 'null'
          enum:
          - pending
          - started
          - succeeded
          - failed
          - disabled
          - null
        in: query
      - name: cursor
        required: false
        description: Cursor for obtaining the next set of records.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: sort
        required: false
        description: Sort results in ascending or descending order.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        in: query
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
  /api/v4/admin/data_management/{model_name}/checksum:
    put:
      operationId: putApiV4AdminDataManagementModelNameChecksum
      summary: Recalculate checksums for model records
      description: Recalculates checksums for selected records of a specified model, filtered by `checksum_state` and `identifiers` parameters if provided. The request enqueues a background job to perform the recalculation. Only available to administrators on primary Geo sites.
      tags:
      - Data management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAdminModel'
        '400':
          description: 400 Bad request
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Model Not Found
      parameters:
      - name: model_name
        required: true
        description: See https://docs.gitlab.com/administration/admin_area/#data-management for the list of allowed values
        schema:
          type: string
          minLength: 1
        in: path
        example: uploads
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4AdminDataManagementModelNameChecksumRequest'
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
components:
  schemas:
    putApiV4AdminDataManagementModelNameChecksumRequest:
      type: object
      properties:
        identifiers:
          oneOf:
          - type:
            - array
            - 'null'
            items:
              type: integer
          - type:
            - array
            - 'null'
            items:
              type: string
          description: Filter results with an array of unique identifiers of the requested model, which can be integers or base64 encoded strings.
        checksum_state:
          type:
          - string
          - 'null'
          enum:
          - started
          - succeeded
          - failed
          - disabled
          - null
          description: Filter by checksum status.
    APIEntitiesAdminModel:
      type: object
      properties:
        record_identifier:
          oneOf:
          - type: string
          - type: integer
          example: abc123
        model_class:
          type: string
          example: Project
        created_at:
          type: string
          format: date-time
          example: '2025-01-31T15:10:45.080Z'
        file_size:
          type: integer
          example: 123
        checksum_information:
          type: object
          properties:
            checksum:
              type: string
            last_checksum:
              type: string
            checksum_state:
              type: string
            checksum_retry_count:
              type: string
            checksum_retry_at:
              type: string
            checksum_failure:
              type: string
  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