GH API to update branch permissions #24758

ydorbala · 2021-05-14T05:00:52Z

ydorbala
May 14, 2021

I am trying to update a branch permission by using gh apis. I authenticated my gh terminal using gh auth login and am able to execute certain gh commands as well.

However, when I am trying to update branch permissions, I am seeing Invalid request errors. I tried running the same using curl and this request is successful. How do I replicate the same using gh api?

curl --location --request PUT 'https://api.github.com/repos/<orgName>/<repoName>/main/protection' \
--header 'Authorization: Bearer <token> \
--header 'Content-Type: application/json' \
--data-raw '{"required_status_checks":{"strict":true,"contexts":["contexts"]},"enforce_admins":true,"required_pull_request_reviews": {},"restrictions":{"users":["users"],"teams":["teams"],"apps":["apps"]}}'

This is what I have come up with thus far (I tried putting in the same body as above but that was failing as well):

gh api -X PUT repos/<orgName>/<repoName>/branches/main/protection -f enforce_admins='true' -f required_pull_request_reviews='{}' -f restrictions='{}' -f required_status_checks='{}'`

and the error I am seeing looks like this.

{
  "message": "Invalid request.\n\nNo subschema in \"anyOf\" matched.\nNo subschema in \"anyOf\" matched.\nNo subschema in \"anyOf\" matched.\nNo subschema in \"anyOf\" matched.\nFor 'allOf/0', \"{}\" is not an object.\nNot all subschemas of \"allOf\" matched.\nFor 'anyOf/1', \"{}\" is not a null.\nFor 'allOf/0', \"{}\" is not an object.\nNot all subschemas of \"allOf\" matched.\nFor 'anyOf/1', \"{}\" is not a null.\nFor 'allOf/0', \"true\" is not a boolean.\nNot all subschemas of \"allOf\" matched.\nFor 'anyOf/1', \"true\" is not a null.\nFor 'allOf/0', \"{}\" is not an object.\nNot all subschemas of \"allOf\" matched.\nFor 'anyOf/1', \"{}\" is not a null.",
  "documentation_url": "https://docs.github.com/rest/reference/repos#update-branch-protection"
}
gh: Invalid request.

Any help on how to send the right request through gh api would be really helpful. Thanks!

Answered by ydorbala

May 14, 2021

This post helped me answer my question. So, I had to pass in the array object as input as opposed to the field value (as that cannot take array values currently)

Something like this worked for me:

jq -n '{"required_status_checks":{"strict":true,"contexts":["contexts"]},"enforce_admins":true,"required_pull_request_reviews": {},"restrictions":{"users":["users"],"teams":["teams"],"apps":["apps"]}}' | gh api -X PUT repos/<orgName>/<repoName>/branches/main/protection --input -

View full answer

ydorbala · 2021-05-14T05:41:08Z

ydorbala
May 14, 2021
Author

This post helped me answer my question. So, I had to pass in the array object as input as opposed to the field value (as that cannot take array values currently)

Something like this worked for me:

jq -n '{"required_status_checks":{"strict":true,"contexts":["contexts"]},"enforce_admins":true,"required_pull_request_reviews": {},"restrictions":{"users":["users"],"teams":["teams"],"apps":["apps"]}}' | gh api -X PUT repos/<orgName>/<repoName>/branches/main/protection --input -

0 replies

joshjohanning · 2023-03-10T14:49:27Z

joshjohanning
Mar 10, 2023

Something like this might also work

gh api -X PUT /repos/ORG/REPO/branches/main/protection \
  --input - << EOF
{
  "required_status_checks": null,
  "enforce_admins": null,
  "required_pull_request_reviews": {
    "dismiss_stale_reviews": false,
    "require_code_owner_reviews": false,
    "require_last_push_approval": false,
    "required_approving_review_count": 1
  },
  "restrictions": null
}

0 replies

pgangloff-hbs · 2024-01-30T19:38:18Z

pgangloff-hbs
Jan 30, 2024

Yep! @ydorbala 's solution above works for me too!

echo "Enabling main branch protection"
jq -n '{"required_status_checks":null,"enforce_admins":null,"required_pull_request_reviews":{"dismissal_restrictions":{},"required_approving_review_count":0},"dismiss_stale_reviews":null,"require_code_owner_reviews":null,"require_last_push_approval":null,"bypass_pull_request_allowances":null,"restrictions":null,"required_linear_history":null,"allow_force_pushes":null,"allow_deletions":null,"block_creations":null,"required_conversation_resolution":null,"lock_branch":null,"allow_fork_syncing":null}' \
| gh api -X PUT repos/MY_ORG/MY_PROJECT/branches/main/protection --input -

FYI: because I struggled with this, this is how we can disable branch protection programmatically (set it to null)

jq -n '{"required_status_checks":null,"enforce_admins":null,"required_pull_request_reviews":null,"dismiss_stale_reviews":null,"require_code_owner_reviews":null,"require_last_push_approval":null,"bypass_pull_request_allowances":null,"restrictions":null,"required_linear_history":null,"allow_force_pushes":null,"allow_deletions":null,"block_creations":null,"required_conversation_resolution":null,"lock_branch":null,"allow_fork_syncing":null}' \
| gh api -X PUT repos/MY_ORG/MY_PROJECT/branches/main/protection --input -

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

GH API to update branch permissions #24758

{{title}}

Replies: 3 comments

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

GitHub Community

GH API to update branch permissions #24758

ydorbala May 14, 2021

Replies: 3 comments

ydorbala May 14, 2021 Author

joshjohanning Mar 10, 2023

pgangloff-hbs Jan 30, 2024

ydorbala
May 14, 2021

ydorbala
May 14, 2021
Author

joshjohanning
Mar 10, 2023

pgangloff-hbs
Jan 30, 2024