组织预接收挂钩

组织预接收挂钩 API 允许您查看和修改组织可用的预接收挂钩的实施。

对象属性

名称	类型	描述
`name`	`字符串`	挂钩的名称。
`enforcement`	`字符串`	此仓库中挂钩的实施状态。
`allow_downstream_configuration`	`布尔值`	仓库是否可以覆盖实施。
`configuration_url`	`字符串`	设置实施的端点 URL。

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

configuration_url 可能是此端点或此挂钩的全局配置的链接。只有站点管理员才能访问全局配置。

List pre-receive hooks for an organization

使用 GitHub Apps

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

参数

� �头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended. 查看预览通知
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
查询参数
名称, 类型, 描述
`per_page`integer The number of results per page (max 100). 默认值: `30`
`page`integer Page number of the results to fetch. 默认值: `1`
`direction`string The direction to sort the results by. 默认值: `desc` 可以是以下其中之一: `asc`, `desc`
`sort`string The sort order for the response collection. 默认值: `created` 可以是以下其中之一: `created`, `updated`, `name`

HTTP 响应状态代� �

状态代� �	描述
`200`	OK

代� �示例

get/orgs/{org}/pre-receive-hooks

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

Response

Status: 200

[
  {
    "id": 42,
    "name": "Check Commits",
    "enforcement": "disabled",
    "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
    "allow_downstream_configuration": true
  }
]

预览通知

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview

Get a pre-receive hook for an organization

使用 GitHub Apps

参数

� �头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended. 查看预览通知
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`pre_receive_hook_id`integer必选 The unique identifier of the pre-receive hook.

HTTP 响应状态代� �

状态代� �	描述
`200`	OK

代� �示例

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

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

Response

Status: 200

{
  "id": 42,
  "name": "Check Commits",
  "enforcement": "disabled",
  "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
  "allow_downstream_configuration": true
}

预览通知

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview

Update pre-receive hook enforcement for an organization

使用 GitHub Apps

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

参数

� �头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended. 查看预览通知
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`pre_receive_hook_id`integer必选 The unique identifier of the pre-receive hook.
正文参数
名称, 类型, 描述
`enforcement`string The state of enforcement for the hook on this repository.
`allow_downstream_configuration`boolean Whether repositories can override enforcement.

HTTP 响应状态代� �

状态代� �	描述
`200`	OK

代� �示例

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

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{"enforcement":"enabled","allow_downstream_configuration":false}'

Response

Status: 200

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

预览通知

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview

Remove pre-receive hook enforcement for an organization

使用 GitHub Apps

Removes any overrides for this hook at the org level for this org.

参数

� �头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended. 查看预览通知
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`pre_receive_hook_id`integer必选 The unique identifier of the pre-receive hook.

HTTP 响应状态代� �

状态代� �	描述
`200`	OK

代� �示例

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

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

Response

Status: 200

{
  "id": 42,
  "name": "Check Commits",
  "enforcement": "disabled",
  "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
  "allow_downstream_configuration": true
}

预览通知

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview