Update pre-receive hook enforcement for an organization

For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`

PATCH/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

org string required
pre_receive_hook_id integer required: pre_receive_hook_id parameter

Body Params

optional

application/jsonobject

allow_downstream_configuration boolean

optional

Whether repositories can override enforcement.

enforcement string

optional

The state of enforcement for the hook on this repository.

Responses

application/json org-pre-receive-hook object

Response

allow_downstream_configuration boolean

optional

configuration_url string

optional

enforcement string

optional

id integer

optional

name string

optional

Response Example: 200 application/json

{
  "allow_downstream_configuration": false,
  "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42",
  "enforcement": "enabled",
  "id": 42,
  "name": "Check Commits"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

org *

pre_receive_hook_id *

pre_receive_hook_id parameter

Request Sample: Shell / cURL

curl --request PATCH \
  --url {protocol}://{hostname}/api/v3/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id} \
  --header 'content-type: application/json' \
  --data '{
  "allow_downstream_configuration": false,
  "enforcement": "enabled"
}'