PUT /orgs/{org}/interaction-limits

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.

Servers

Path parameters

Name Type Required Description
org String Yes

The organization name. The name is not case sensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
expiry String No

The duration of the interaction restriction. Default: one_day.

Possible values:

  • "three_days"
  • "one_day"
  • "one_month"
  • "six_months"
  • "one_week"
limit String Yes

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

Possible values:

  • "existing_users"
  • "collaborators_only"
  • "contributors_only"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.