Get pull request creation cap for a repository

GET

/repos/{owner}/{repo}/interaction-limits/pulls/creation-cap

Gets the pull request creation cap configuration for a repository. The cap limits the number of open pull requests a user can have at one time.

Only users with admin access to the repository can view the cap configuration.

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

Responses

200

Response

Media type application/json

object

enabled

required

Whether the pull request creation cap is enabled

boolean

max_open_pull_requests

required

The maximum number of open pull requests a user can have at one time

integer

>= 1 <= 1000

Examples

Example default

Response when cap is enabled

{
  "enabled": true,
  "max_open_pull_requests": 1
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

405

Method Not Allowed

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}