Skip to main content
Die REST-API ist jetzt versioniert. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für Repositoryinteraktionen

Verwende die REST-API, um vorübergehend einzuschränken, welcher Benutzertyp in einem öffentlichen Repository Kommentare eingeben, Issues eröffnen oder Pull Requests erstellen darf.

Wer kann dieses Feature verwenden?

People with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.

Informationen zu Repositoryinteraktionen

Personen mit Besitzer- oder Administratorzugriff können über die REST-API vorübergehend einschränken, welcher Benutzertyp in einem öffentlichen Repository Kommentare eingeben, Issues eröffnen oder Pull Requests erstellen darf. Wenn Einschränkungen aktiviert sind, kann nur der angegebene Typ von GitHub-Benutzerkonto an Interaktionen teilnehmen. Einschränkungen laufen nach einem definierten Zeitraum automatisch ab. Hier findest du weitere Informationen zu den Typen von GitHub-Benutzern:

  • 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. im Repository.
  • 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. im Repository.
  • Nur Mitarbeiter: Wenn du Interaktionen auf collaborators_only beschränkst, werden Benutzer, die keine Mitarbeiter sind, vorübergehend eingeschränkt. im Repository.

Wenn ein Interaktionsgrenzwert für den Benutzer oder die Organisation, die Besitzer des Repositorys ist, aktiviert ist, kann der Grenzwert für das einzelne Repository nicht geändert werden. Verwende stattdessen die Interaktionsendpunkte Benutzer oder Organisation, um den Interaktionsgrenzwert zu ändern.

Get interaction restrictions for a repository

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

Feinkörnige Zugriffstoken für "Get interaction restrictions for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" repository permissions (read)

Parameter für "Get interaction restrictions for a repository"

Header
Name, Typ, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository without the .git extension. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Get interaction restrictions for a repository"

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für "Get interaction restrictions for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

get/repos/{owner}/{repo}/interaction-limits
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/interaction-limits

Response

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

Set interaction restrictions for a repository

Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

Feinkörnige Zugriffstoken für "Set interaction restrictions for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" repository permissions (write)

Parameter für "Set interaction restrictions for a repository"

Header
Name, Typ, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository without the .git extension. The name is not case sensitive.

Körperparameter
Name, Typ, BESCHREIBUNG
limit string Erforderlich

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Kann eine der folgenden sein: existing_users, contributors_only, collaborators_only

expiry string

The duration of the interaction restriction. Default: one_day.

Kann eine der folgenden sein: one_day, three_days, one_week, one_month, six_months

HTTP-Antwortstatuscodes für "Set interaction restrictions for a repository"

StatuscodeBESCHREIBUNG
200

OK

409

Conflict

Codebeispiele für "Set interaction restrictions for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

put/repos/{owner}/{repo}/interaction-limits
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/interaction-limits \ -d '{"limit":"collaborators_only","expiry":"one_day"}'

Response

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

Remove interaction restrictions for a repository

Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

Feinkörnige Zugriffstoken für "Remove interaction restrictions for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" repository permissions (write)

Parameter für "Remove interaction restrictions for a repository"

Header
Name, Typ, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository without the .git extension. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Remove interaction restrictions for a repository"

StatuscodeBESCHREIBUNG
204

No Content

409

Conflict

Codebeispiele für "Remove interaction restrictions for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

delete/repos/{owner}/{repo}/interaction-limits
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/interaction-limits

Response

Status: 204

Get pull request creation cap bypass list for a repository

Lists the users that are on the pull request creation cap bypass list for a repository. Users on this list can create pull requests regardless of any configured pull request creation cap.

Only repository admins can view the bypass list.

Feinkörnige Zugriffstoken für "Get pull request creation cap bypass list for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" repository permissions (read)

Parameter für "Get pull request creation cap bypass list for a repository"

Header
Name, Typ, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository without the .git extension. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Get pull request creation cap bypass list for a repository"

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

Codebeispiele für "Get pull request creation cap bypass list for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

get/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/interaction-limits/pulls/bypass-list

Response

Status: 200
[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

Add users to the pull request creation cap bypass list for a repository

Adds users to the pull request creation cap bypass list for a repository. Users on this list can create pull requests regardless of any configured pull request creation cap.

Only repository admins can modify the bypass list. You can add a maximum of 100 users per request. The bypass list can only hold a maximum of 100 users.

Feinkörnige Zugriffstoken für "Add users to the pull request creation cap bypass list for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" repository permissions (write)

Parameter für "Add users to the pull request creation cap bypass list for a repository"

Header
Name, Typ, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository without the .git extension. The name is not case sensitive.

Körperparameter
Name, Typ, BESCHREIBUNG
users array of strings Erforderlich

A list of user logins to add or remove from the bypass list.

HTTP-Antwortstatuscodes für "Add users to the pull request creation cap bypass list for a repository"

StatuscodeBESCHREIBUNG
204

No Content

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Add users to the pull request creation cap bypass list for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

put/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/interaction-limits/pulls/bypass-list \ -d '{"users":["octocat","monalisa"]}'

Response

Status: 204

Remove users from the pull request creation cap bypass list for a repository

Removes users from the pull request creation cap bypass list for a repository. Removed users will be subject to any configured pull request creation cap.

Only repository admins can modify the bypass list. You can remove a maximum of 100 users per request.

Feinkörnige Zugriffstoken für "Remove users from the pull request creation cap bypass list for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" repository permissions (write)

Parameter für "Remove users from the pull request creation cap bypass list for a repository"

Header
Name, Typ, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository without the .git extension. The name is not case sensitive.

Körperparameter
Name, Typ, BESCHREIBUNG
users array of strings Erforderlich

A list of user logins to add or remove from the bypass list.

HTTP-Antwortstatuscodes für "Remove users from the pull request creation cap bypass list for a repository"

StatuscodeBESCHREIBUNG
204

No Content

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Remove users from the pull request creation cap bypass list for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

delete/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/interaction-limits/pulls/bypass-list \ -d '{"users":["octocat"]}'

Response

Status: 204