interactions

Set interaction restrictions for an organization

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

put/orgs/{org}/interaction-limits

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/interaction-limits
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

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 83 revisions of this API.