このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2022-10-12. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせく� さい。

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

Repository Pre-receive Hooks

The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.

Object attributes

Name	Type	Description
`name`	`string`	The name of the hook.
`enforcement`	`string`	The state of enforcement for the hook on this repository.
`configuration_url`	`string`	URL for the endpoint where enforcement is set.

Possible values for enforcement are enabled, disabled andtesting. disabled indicates the pre-receive hook will not run. enabled indicates it will run and reject any pushes that result in a non-zero status. testing means the script will run but will not cause any pushes to be rejected.

configuration_url may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at configuration_url is determined at the owner or site admin level.

List pre-receive hooks for a repository

次のもので機能します GitHub Apps

List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.

パラメーター

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Query parameters
Name, Type, Description
`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 Default: `created` Can be one of: `created`, `updated`, `name`

HTTP 応答状態コード

status code	説明
`200`	OK

コードサンプル

get/repos/{owner}/{repo}/pre-receive-hooks

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

Response

Status: 200

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

プレビュー通知

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 a repository

次のもので機能します GitHub Apps

パラメーター

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.

HTTP 応答状態コード

status code	説明
`200`	OK

コードサンプル

get/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/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/orgs/octocat/pre-receive-hooks/42"
}

プレビュー通知

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 a repository

次のもので機能します GitHub Apps

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

パラメーター

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.
Body parameters
Name, Type, Description
`enforcement`string The state of enforcement for the hook on this repository. Can be one of: `enabled`, `disabled`, `testing`

HTTP 応答状態コード

status code	説明
`200`	OK

コードサンプル

patch/repos/{owner}/{repo}/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/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{"enforcement":"enabled"}'

Response

Status: 200

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

プレビュー通知

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 a repository

次のもので機能します GitHub Apps

Deletes any overridden enforcement on this repository for the specified hook.

Responds with effective values inherited from owner and/or global level.

パラメーター

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.

HTTP 応答状態コード

status code	説明
`200`	Responds with effective values inherited from owner and/or global level.

コードサンプル

delete/repos/{owner}/{repo}/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/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Responds with effective values inherited from owner and/or global level.

Status: 200

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

プレビュー通知

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