# 适用于组织预接收挂钩的 REST API 终结点

使用 REST API 查看和修改组织可用的预接收挂钩的强制执行。

## 关于组织预接收挂钩

> \[!NOTE]
> 这些终结点仅支持使用 personal access token (classic) 进行身份验证。 有关详细信息，请参阅“[管理个人访问令牌](/zh/enterprise-server@3.22/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)”。

### 对象属性

| 名称                               | 类型        | 说明           |
| -------------------------------- | --------- | ------------ |
| `name`                           | `string`  | 挂钩的名称。       |
| `enforcement`                    | `string`  | 此仓库中挂钩的实施状态。 |
| `allow_downstream_configuration` | `boolean` | 仓库是否可以覆盖实施。  |
| `configuration_url`              | `string`  | 设置实施的端点 URL。 |

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

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

> \[!NOTE]
> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2026-03-10`. Curl examples below omit these standard headers for brevity.

## List pre-receive hooks for an organization

```
GET /orgs/{org}/pre-receive-hooks
```

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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`per_page`** (integer)
  The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

* **`direction`** (string)
  The direction to sort the results by.
  Default: `desc`
  Can be one of: `asc`, `desc`

* **`sort`** (string)
  The sort order for the response collection.
  Default: `created`
  Can be one of: `created`, `updated`, `name`

### HTTP response status codes

* **200** - OK

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks
```

**Response schema (Status: 200):**

Array of objects:

* `id`: integer
* `name`: string
* `enforcement`: string
* `configuration_url`: string
* `allow_downstream_configuration`: boolean

## Get a pre-receive hook for an organization

```
GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`pre_receive_hook_id`** (string) (required)
  The unique identifier of the pre-receive hook.

### HTTP response status codes

* **200** - OK

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
```

**Response schema (Status: 200):**

* `id`: integer
* `name`: string
* `enforcement`: string
* `configuration_url`: string
* `allow_downstream_configuration`: boolean

## Update pre-receive hook enforcement for an organization

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

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

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`pre_receive_hook_id`** (string) (required)
  The unique identifier of the pre-receive hook.

#### Body parameters

* **`enforcement`** (string)
  The state of enforcement for the hook on this repository.

* **`allow_downstream_configuration`** (boolean)
  Whether repositories can override enforcement.

### HTTP response status codes

* **200** - OK

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X PATCH \
  http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{
  "enforcement": "enabled",
  "allow_downstream_configuration": false
}'
```

**Response schema (Status: 200):**

Same response schema as [Get a pre-receive hook for an organization](#get-a-pre-receive-hook-for-an-organization).

## Remove pre-receive hook enforcement for an organization

```
DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
```

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

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`pre_receive_hook_id`** (string) (required)
  The unique identifier of the pre-receive hook.

### HTTP response status codes

* **200** - OK

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X DELETE \
  http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
```

**Response schema (Status: 200):**

Same response schema as [Get a pre-receive hook for an organization](#get-a-pre-receive-hook-for-an-organization).