The REST API is now versioned. For more information, see "About API versioning."

Benutzerinteraktionen

Mit der Benutzerinteraktions-API kannst du vorübergehend einschränken, welche Benutzer*innen kommentieren, Issues öffnen oder Pull Requests in deinen öffentlichen Repositorys können.

Informationen zur Benutzerinteraktions-API

Mit der Benutzerinteraktions-API kannst du vorübergehend einschränken, welche Benutzerinnen kommentieren, Issues öffnen oder Pull Requests in deinen öffentlichen Repositorys können. Wenn Einschränkungen aktiviert sind, kann nur der angegebene Typ von GitHub-Benutzer an Interaktionen teilnehmen. Einschränkungen laufen nach einem definierten Zeitraum automatisch ab. Hier findest du weitere Informationen zu den Typen von GitHub-Benutzerinnen:

Vorhandene Benutzer: Wenn du Interaktionen auf existing_users beschränkst, werden neue Benutzer, deren Konten noch keine 24 Stunden alt sind, die noch keinen Beitrag geleistet haben und die keine Mitarbeiter sind, vorübergehend eingeschränkt. von der Interaktion mit deinen Repositorys.
Nur Mitwirkende: Wenn du Interaktionen auf contributors_only beschränkst, werden Benutzer, die zuvor nicht mitgewirkt haben und keine Projektmitarbeiter sind, vorübergehend eingeschränkt. von der Interaktion mit deinen Repositorys.
Nur Mitarbeiter: Wenn du Interaktionen auf collaborators_only beschränkst, werden Benutzer, die keine Mitarbeiter sind, vorübergehend eingeschränkt. von der Interaktion mit deinen Repositorys.

Durch Festlegen des Interaktionslimits auf Benutzerebene werden alle Interaktionsbeschränkungen überschrieben, die für einzelne Repositorys im Besitz des Benutzers bzw. der Benutzerin festgelegt sind. Verwende stattdessen die Repositoryinteraktionsendpunkte, um unterschiedliche Interaktionsgrenzwerte für einzelne Repositorys festzulegen, die dem Benutzer bzw. der Benutzerin gehören.

Get interaction restrictions for your public repositories

Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`200`	Default response
`204`	Response when there are no restrictions

Codebeispiele

get/user/interaction-limits

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/interaction-limits

Default response

Status: 200

{
  "limit": "collaborators_only",
  "origin": "organization",
  "expires_at": "2018-08-17T04:18:39Z"
}

Set interaction restrictions for your public repositories

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

Parameter

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Body parameters
Name, Type, Description
`limit`stringRequired The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`
`expiry`string The duration of the interaction restriction. Default: `one_day`. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele

put/user/interaction-limits

curl \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/interaction-limits \
  -d '{"limit":"collaborators_only","expiry":"one_month"}'

Response

Status: 200

{
  "limit": "collaborators_only",
  "origin": "user",
  "expires_at": "2018-08-17T04:18:39Z"
}

Remove interaction restrictions from your public repositories

Removes any interaction restrictions from your public repositories.

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele

delete/user/interaction-limits

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/interaction-limits

Response

Status: 204