Create a pre-receive hook

curl --location --request POST 'https://api.github.com/admin/pre-receive-hooks' \ --header 'Content-Type: application/json' \ --data-raw '{ "allow_downstream_configuration": false, "enforcement": "disabled", "environment": { "id": 2 }, "name": "Check Commits", "script": "scripts/commit_check.sh", "script_repository": { "full_name": "DevIT/hooks" } }'

{ "allow_downstream_configuration": true, "enforcement": "string", "environment": { "created_at": "string", "default_environment": true, "download": { "downloaded_at": "string", "message": "string", "state": "string", "url": "string" }, "hooks_count": 0, "html_url": "string", "id": 0, "image_url": "string", "name": "string", "url": "string" }, "id": 0, "name": "string", "script": "string", "script_repository": { "full_name": "string", "html_url": "string", "id": 0, "url": "string" } }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

allow_downstream_configuration

boolean

可选

Whether enforcement can be overridden at the org or repo level. default: false

enforcement

string

可选

The state of enforcement for this hook. default: disabled

environment

object

必需

The pre-receive environment where the script is executed.

额外字段

integer | number | string | boolean

可选

name

string

必需

The name of the hook.

script

string

必需

The script that the hook runs.

script_repository

object

必需

The GitHub repository where the script is kept.

额外字段

integer | number | string | boolean

可选

示例

返回响应

🟢201Response

application/json

Body

allow_downstream_configuration

boolean

可选

enforcement

string

可选

environment

object

可选

created_at

string

可选

default_environment

boolean

可选

download

object

可选

hooks_count

integer

可选

html_url

string

可选

integer

可选

image_url

string

可选

name

string

可选

url

string

可选

integer

可选

name

string

可选

script

string

可选

script_repository

object

可选

full_name

string

可选

html_url

string

可选

integer

可选

url

string

可选