Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user.
Organization
The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. When restrictions are enabled, only the specified type of GitHub user will be able to participate in interactions. Restrictions automatically expire after a defined duration. Here's more about the types of GitHub users:
- Existing users: When you limit interactions to
existing_users
, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted in the organization. - Contributors only: When you limit interactions to
contributors_only
, users who have not previously contributed and are not collaborators will be temporarily restricted in the organization. - Collaborators only: When you limit interactions to
collaborators_only
, users who are not collaborators will be temporarily restricted in the organization.
Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the Repository interactions endpoints instead.
Get interaction restrictions for an organization
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.
get /orgs/{org}/interaction-limits
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
org |
string | path |
Code samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/orgs/ORG/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('GET /orgs/{org}/interaction-limits', {
org: 'org'
})
Default response
Status: 200 OK
{
"limit": "collaborators_only",
"origin": "organization",
"expires_at": "2018-08-17T04:18:39Z"
}
Notes
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
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
org |
string | path | |
limit |
string | body |
Required. 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 |
string | body |
The duration of the interaction restriction. Can be one of: |
Code samples
Shell
curl \
-X PUT \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/orgs/ORG/interaction-limits \
-d '{"limit":"limit"}'
JavaScript (@octokit/core.js)
await octokit.request('PUT /orgs/{org}/interaction-limits', {
org: 'org',
limit: 'limit'
})
Default response
Status: 200 OK
{
"limit": "collaborators_only",
"origin": "organization",
"expires_at": "2018-08-17T04:18:39Z"
}
Validation failed
Status: 422 Unprocessable Entity
Notes
Remove interaction restrictions for an organization
Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
delete /orgs/{org}/interaction-limits
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
org |
string | path |
Code samples
Shell
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/orgs/ORG/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('DELETE /orgs/{org}/interaction-limits', {
org: 'org'
})
Default Response
Status: 204 No Content
Notes
Repository
The Repository Interactions API allows 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. When restrictions are enabled, only the specified type of GitHub user will be able to participate in interactions. Restrictions automatically expire after a defined duration. Here's more about the types of GitHub users:
- Existing users: When you limit interactions to
existing_users
, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted in the repository. - Contributors only: When you limit interactions to
contributors_only
, users who have not previously contributed and are not collaborators will be temporarily restricted in the repository. - Collaborators only: When you limit interactions to
collaborators_only
, users who are not collaborators will be temporarily restricted in the repository.
If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the User or Organization interactions endpoints to change the interaction limit.
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.
get /repos/{owner}/{repo}/interaction-limits
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
owner |
string | path | |
repo |
string | path |
Code samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/octocat/hello-world/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('GET /repos/{owner}/{repo}/interaction-limits', {
owner: 'octocat',
repo: 'hello-world'
})
Default response
Status: 200 OK
{
"limit": "collaborators_only",
"origin": "repository",
"expires_at": "2018-08-17T04:18:39Z"
}
Notes
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.
put /repos/{owner}/{repo}/interaction-limits
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
owner |
string | path | |
repo |
string | path | |
limit |
string | body |
Required. 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 |
string | body |
The duration of the interaction restriction. Can be one of: |
Code samples
Shell
curl \
-X PUT \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/octocat/hello-world/interaction-limits \
-d '{"limit":"limit"}'
JavaScript (@octokit/core.js)
await octokit.request('PUT /repos/{owner}/{repo}/interaction-limits', {
owner: 'octocat',
repo: 'hello-world',
limit: 'limit'
})
Default response
Status: 200 OK
{
"limit": "collaborators_only",
"origin": "repository",
"expires_at": "2018-08-17T04:18:39Z"
}
Conflict
Status: 409 Conflict
Notes
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.
delete /repos/{owner}/{repo}/interaction-limits
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
owner |
string | path | |
repo |
string | path |
Code samples
Shell
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/octocat/hello-world/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('DELETE /repos/{owner}/{repo}/interaction-limits', {
owner: 'octocat',
repo: 'hello-world'
})
Default Response
Status: 204 No Content
Conflict
Status: 409 Conflict
Notes
User
The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. When restrictions are enabled, only the specified type of GitHub user will be able to participate in interactions. Restrictions automatically expire after a defined duration. Here's more about the types of GitHub users:
- Existing users: When you limit interactions to
existing_users
, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted from interacting with your repositories. - Contributors only: When you limit interactions to
contributors_only
, users who have not previously contributed and are not collaborators will be temporarily restricted from interacting with your repositories. - Collaborators only: When you limit interactions to
collaborators_only
, users who are not collaborators will be temporarily restricted from interacting with your repositories.
Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the Repository interactions endpoints instead.
Get interaction restrictions for your public repositories
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.
get /user/interaction-limits
Code samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/user/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('GET /user/interaction-limits')
Default response
Status: 200 OK
{
"limit": "collaborators_only",
"origin": "user",
"expires_at": "2018-08-17T04:18:39Z"
}
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
Parameters
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
limit |
string | body |
Required. 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 |
string | body |
The duration of the interaction restriction. Can be one of: |
Code samples
Shell
curl \
-X PUT \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/user/interaction-limits \
-d '{"limit":"limit"}'
JavaScript (@octokit/core.js)
await octokit.request('PUT /user/interaction-limits', {
limit: 'limit'
})
Default response
Status: 200 OK
{
"limit": "collaborators_only",
"origin": "user",
"expires_at": "2018-08-17T04:18:39Z"
}
Validation failed
Status: 422 Unprocessable Entity
Remove interaction restrictions from your public repositories
Removes any interaction restrictions from your public repositories.
delete /user/interaction-limits
Code samples
Shell
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/user/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('DELETE /user/interaction-limits')
Default Response
Status: 204 No Content