Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
octokit.interactions.getRestrictionsForOrg({org,});
name | required | description |
---|---|---|
org | yes |
See also: GitHub Developer Guide documentation.
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.
octokit.interactions.getRestrictionsForRepo({owner,repo,});
name | required | description |
---|---|---|
owner | yes | |
repo | yes |
See also: GitHub Developer Guide documentation.
Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response.
octokit.interactions.getRestrictionsForYourPublicRepos();
This endpoint has no parameters
See also: GitHub Developer Guide documentation.
Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
octokit.interactions.removeRestrictionsForOrg({org,});
name | required | description |
---|---|---|
org | yes |
See also: GitHub Developer Guide documentation.
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.
octokit.interactions.removeRestrictionsForRepo({owner,repo,});
name | required | description |
---|---|---|
owner | yes | |
repo | yes |
See also: GitHub Developer Guide documentation.
Removes any interaction restrictions from your public repositories.
octokit.interactions.removeRestrictionsForYourPublicRepos();
This endpoint has no parameters
See also: GitHub Developer Guide documentation.
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.
octokit.interactions.setRestrictionsForOrg({org,limit,});
name | required | description |
---|---|---|
org | yes | |
limit | yes | 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: |
expiry | no | The duration of the interaction restriction. Can be one of: |
See also: GitHub Developer Guide documentation.
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.
octokit.interactions.setRestrictionsForRepo({owner,repo,limit,});
name | required | description |
---|---|---|
owner | yes | |
repo | yes | |
limit | yes | 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: |
expiry | no | The duration of the interaction restriction. Can be one of: |
See also: GitHub Developer Guide documentation.
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.
octokit.interactions.setRestrictionsForYourPublicRepos({limit,});
name | required | description |
---|---|---|
limit | yes | 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: |
expiry | no | The duration of the interaction restriction. Can be one of: |
See also: GitHub Developer Guide documentation.