Limites de débit sur l'API Users

{{< details >}}

• Niveau : Free, Premium, Ultimate
• Offre : GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Les limites de débit pour l'API Users ont été introduites dans GitLab 17.1 avec un flag nommé rate_limiting_user_endpoints. Désactivé par défaut.
• Ajout de limites de débit personnalisables dans GitLab 17.10.
• Disponibilité générale dans GitLab 18.1. Indicateur de feature flag rate_limiting_user_endpoints supprimé.

{{< /history >}}

[!note] Lors de la mise à niveau vers GitLab 18.0 ou une version ultérieure, les limites de débit configurables pour cette API sont définies sur 0. Les administrateurs peuvent ajuster les limites de débit selon leurs besoins. Pour savoir quelles limites de débit sont concernées, consultez Rate limitations announced for Projects, Groups, and Users APIs.

Vous pouvez configurer la limite de débit par minute et par adresse IP et par utilisateur pour les requêtes vers l'API Users suivante.

Limite	Valeur par défaut
GET /users/:id/followers	100 par minute
GET /users/:id/following	100 par minute
GET /users/:id/status	240 par minute
GET /users/:id/keys	120 par minute
GET /users/:id/keys/:key_id	120 par minute
GET /users/:id/gpg_keys	120 par minute
GET /users/:id/gpg_keys/:key_id	120 par minute

Prérequis :

• Accès administrateur.

Pour modifier la limite de débit :

1. Dans le coin supérieur droit, sélectionnez Admin.
2. Dans la barre latérale gauche, sélectionnez Paramètres > Réseau.
3. Développez Users API rate limit.
4. Définissez des valeurs pour toute limite de débit disponible. Les limites de débit sont par minute, par utilisateur pour les requêtes authentifiées et par adresse IP pour les requêtes non authentifiées. Saisissez 0 pour désactiver une limite de débit.
5. Sélectionnez Sauvegarder les modifications.

Chaque limite de débit :

• S'applique par utilisateur si la requête est authentifiée.
• S'applique par adresse IP si la requête n'est pas authentifiée.
• Peut être définie sur 0 pour désactiver les limites de débit.

Journaux :

• Les requêtes qui dépassent la limite de débit sont consignées dans le fichier auth.log.
• Les modifications de limite de débit sont consignées dans le fichier audit_json.log.

Exemple :

Si vous définissez une limite de débit de 150 pour GET /users/:id/followers et envoyez 155 requêtes en une minute, les cinq dernières requêtes sont bloquées. Après une minute, vous pouvez continuer à envoyer des requêtes jusqu'à ce que vous dépassiez à nouveau la limite de débit.