预接收挂钩

使用 REST API 创建、列出、更新和删除预接收挂钩。

关于预接收挂钩

这些终结点仅适用于经过身份验证的网站管理员。普通用户将收到 404 响应。

对象属性

预接收挂钩

名称	类型	说明
`name`	`string`	挂钩的名称。
`script`	`string`	挂钩运行的脚本。
`script_repository`	`object`	保存脚本的 GitHub 仓库。
`environment`	`object`	执行脚本的预接收环境。
`enforcement`	`string`	此挂钩的实施状态。
`allow_downstream_configuration`	`boolean`	是否可以在组织或仓库级别上覆盖实施。

强制执行的可能值为 enabled、disabled 和 testing。 disabled 表示预接收挂钩不会运行。 enabled 表示它将运行并拒绝任何导致非零状态的推送。 testing 表示脚本将运行但不会导致任何推送被拒绝。

List pre-receive hooks

Parameters

Headers
名称, Type, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
Query parameters
名称, Type, 说明
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`
`direction`string The direction to sort the results by. Default: `desc` Can be one of: `asc`, `desc`
`sort`string The property to sort the results by. Default: `created` Can be one of: `created`, `updated`, `name`

HTTP response status codes

Status code	说明
`200`	OK

Code samples

get/admin/pre-receive-hooks

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks

Response

Status: 200

[
  {
    "id": 1,
    "name": "Check Commits",
    "enforcement": "disabled",
    "script": "scripts/commmit_check.sh",
    "script_repository": {
      "id": 595,
      "full_name": "DevIT/hooks",
      "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
      "html_url": "https://github.example.com/DevIT/hooks"
    },
    "environment": {
      "id": 2,
      "name": "DevTools Hook Env",
      "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
      "html_url": "https://github.example.com/admin/pre-receive-environments/2",
      "default_environment": false,
      "created_at": "2016-05-20T11:35:45-05:00",
      "hooks_count": 1,
      "download": {
        "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
        "state": "success",
        "downloaded_at": "2016-05-26T07:42:53-05:00",
        "message": null
      }
    },
    "allow_downstream_configuration": false
  }
]

Create a pre-receive hook

Parameters

Headers
名称, Type, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
Body parameters
名称, Type, 说明
`name`stringRequired The name of the hook.
`script`stringRequired The script that the hook runs.
`script_repository`objectRequired The GitHub repository where the script is kept.
`environment`objectRequired The pre-receive environment where the script is executed.
`enforcement`string The state of enforcement for this hook. default: `disabled`
`allow_downstream_configuration`boolean Whether enforcement can be overridden at the org or repo level. default: `false`

HTTP response status codes

Status code	说明
`201`	Created

Code samples

post/admin/pre-receive-hooks

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks \
  -d '{"name":"Check Commits","script":"scripts/commit_check.sh","enforcement":"disabled","allow_downstream_configuration":false,"script_repository":{"full_name":"DevIT/hooks"},"environment":{"id":2}}'

Response

Status: 201

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 2,
    "name": "DevTools Hook Env",
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "default_environment": false,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": false
}

Get a pre-receive hook

Parameters

Headers
名称, Type, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名称, Type, 说明
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.

HTTP response status codes

Status code	说明
`200`	OK

Code samples

get/admin/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 200

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 2,
    "name": "DevTools Hook Env",
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "default_environment": false,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": false
}

Update a pre-receive hook

Parameters

Headers
名称, Type, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名称, Type, 说明
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.
Body parameters
名称, Type, 说明
`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.
`environment`object The pre-receive environment where the script is executed.
`enforcement`string The state of enforcement for this hook.
`allow_downstream_configuration`boolean Whether enforcement can be overridden at the org or repo level.

HTTP response status codes

Status code	说明
`200`	OK

Code samples

patch/admin/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{"name":"Check Commits","environment":{"id":1},"allow_downstream_configuration":true}'

Response

Status: 200

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 1,
    "name": "Default",
    "image_url": "githubenterprise://internal",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
    "html_url": "https://github.example.com/admin/pre-receive-environments/1",
    "default_environment": true,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": true
}

Delete a pre-receive hook

Parameters

Headers
名称, Type, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名称, Type, 说明
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.

HTTP response status codes

Status code	说明
`204`	No Content

Code samples

delete/admin/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 204