Get commit signature protection

GET

/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

Note: You must enable branch protection to require signed commits.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///branches//protection/required_signatures'

Response Example

200 - Example 1

{
    "enabled": true,
    "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins"
}

Request

Path Params

owner

string

required

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

repo

string

required

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

branch

string

required

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Responses

🟢200Response

application/json

Body

Protected Branch Admin Enforced

enabled

boolean

required

Example:

true

url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins

🟠404404

Modified at 2023-08-15 02:59:29

Delete commit signature protection

Create commit signature protection