interactions

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.

put/user/interaction-limits

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/user/interaction-limits
  • Auth: none declared

Request body

limit'existing_users' | 'contributors_only' | 'collaborators_only' required

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

expiry'one_day' | 'three_days' | 'one_week' | 'one_month' | 'six_months'

The duration of the interaction restriction. Default: one_day.

Example request

{
  "limit": "collaborators_only",
  "expiry": "one_month"
}

Response

Response

limit'existing_users' | 'contributors_only' | 'collaborators_only' required

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

originstring required
expires_atstring date-time required

Example response

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

Changes

No recorded changes to this operation across all 23 revisions of this API.