API de gestion des données

{{< details >}}

• Édition : GitLab Premium, GitLab Ultimate
• Offre : GitLab Self-Managed
• Statut : Expérience

{{< /details >}}

{{< history >}}

• Introduit dans GitLab 18.3 avec un indicateur nommé geo_primary_verification_view. Désactivé par défaut. Cette fonctionnalité est une expérience.
• L'indicateur est activé par défaut dans GitLab 18.8.

{{< /history >}}

Utilisez l'API de gestion des données pour gérer les données d'une instance.

Prérequis :

• Vous devez être un administrateur.

Récupérer les informations du modèle {#retrieve-model-information}

Récupère des informations sur un modèle de données dans une instance. Cette opération est une expérience et peut être modifiée ou supprimée sans préavis.

GET /admin/data_management/:model_name

Le paramètre :model_name doit être l'un des suivants :

• ci_job_artifacts
• ci_pipeline_artifacts
• ci_secure_files
• container_repositories
• dependency_proxy_blobs
• dependency_proxy_manifests
• design_management_repositories
• group_wiki_repositories
• lfs_objects
• merge_request_diffs
• packages_debian_project_component_files
• packages_nuget_symbols
• packages_package_files
• pages_deployments
• projects
• projects_wiki_repositories
• snippet_repositories
• supply_chain_attestations
• terraform_state_versions
• uploads

Attributs pris en charge :

Ce point de terminaison prend en charge la pagination par jeu de clés sur la clé primaire du modèle, avec un tri par ordre croissant ou décroissant. Pour utiliser la pagination par jeu de clés, ajoutez le paramètre pagination=keyset à la requête. Par défaut, la pagination par jeu de clés charge 20 enregistrements par page, triés par ordre croissant. Vous pouvez modifier l'ordre de tri avec le paramètre de requête sort, et les valeurs asc ou desc. Pour sélectionner un nombre d'enregistrements par page, utilisez le paramètre per_page.

En cas de succès, renvoie 200 et des informations sur le modèle. Il inclut les attributs de réponse suivants :

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/data_management/projects?pagination=keyset"

Exemple de réponse :

[
  {
    "record_identifier": 1,
    "model_class": "Project",
    "created_at": "2025-02-05T11:27:10.173Z",
    "file_size": null,
    "checksum_information": {
      "checksum": "<object checksum>",
      "last_checksum": "2025-07-24T14:22:18.643Z",
      "checksum_state": "succeeded",
      "checksum_retry_count": 0,
      "checksum_retry_at": null,
      "checksum_failure": null
    }
  },
  {
    "record_identifier": 2,
    "model_class": "Project",
    "created_at": "2025-02-05T11:27:14.402Z",
    "file_size": null,
    "checksum_information": {
      "checksum": "<object checksum>",
      "last_checksum": "2025-07-24T14:22:18.214Z",
      "checksum_state": "succeeded",
      "checksum_retry_count": 0,
      "checksum_retry_at": null,
      "checksum_failure": null
    }
  }
]

Recalculer les sommes de contrôle pour les enregistrements du modèle {#recalculate-checksums-for-model-records}

Recalcule les sommes de contrôle pour les enregistrements sélectionnés d'un modèle spécifié, filtrés par les paramètres checksum_state et identifiers si fournis. La requête place un job en arrière-plan dans la file d'attente pour effectuer le recalcul.

PUT /admin/data_management/:model_name/checksum

En cas de succès, renvoie 200 et une réponse JSON contenant les informations suivantes :

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/data_management/projects/checksum"

Exemple de réponse :

{
  "status": "success",
  "message": "Batch update job has been successfully enqueued."
}

Récupérer des informations sur un enregistrement de modèle {#retrieve-information-about-a-model-record}

Récupère des informations sur un enregistrement de modèle spécifié.

GET /admin/data_management/:model_name/:id

En cas de succès, renvoie 200 et des informations sur l'enregistrement de modèle spécifique. Il inclut les attributs de réponse suivants :

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/data_management/projects/1"

Exemple de réponse :

{
  "record_identifier": 1,
  "model_class": "Project",
  "created_at": "2025-02-05T11:27:10.173Z",
  "file_size": null,
  "checksum_information": {
    "checksum": "<object checksum>",
    "last_checksum": "2025-07-24T14:22:18.643Z",
    "checksum_state": "succeeded",
    "checksum_retry_count": 0,
    "checksum_retry_at": null,
    "checksum_failure": null
  }
}

Recalculer la somme de contrôle d'un enregistrement de modèle {#recalculate-the-checksum-of-a-model-record}

Recalcule la somme de contrôle d'un enregistrement de modèle spécifié. La valeur de la somme de contrôle est une représentation du modèle interrogé hachée avec l'algorithme md5 ou sha256.

PUT /admin/data_management/:model_name/:record_identifier/checksum

En cas de succès, renvoie 200 et des informations sur l'enregistrement de modèle spécifique.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/data_management/projects/1/checksum"

Exemple de réponse :

{
  "record_identifier": 1,
  "model_class": "Project",
  "created_at": "2025-02-05T11:27:10.173Z",
  "file_size": null,
  "checksum_information": {
    "checksum": "<sha256 or md5 string>",
    "last_checksum": "2025-07-24T14:22:18.643Z",
    "checksum_state": "succeeded",
    "checksum_retry_count": 0,
    "checksum_retry_at": null,
    "checksum_failure": null
  }
}