組織の pre-receive フック用の REST API エンドポイント
REST API を使用して、組織で使用可能な pre-receive フックの適用を表示および変更します。
組織の pre-receive フックについて
これらのエンドポイントでは、personal access token (classic) を使う認証のみがサポートされます。 詳しくは、「個人用アクセス トークンを管理する」を参照してください。
オブジェクトの属性
名前 | 種類 | 説明 |
---|---|---|
name | string | フックの名前。 |
enforcement | string | このリポジトリでのフックの適用状態。 |
allow_downstream_configuration | boolean | リポジトリが適用をオーバーライドできるかどうか。 |
configuration_url | string | 適用設定されているエンドポイントの URL。 |
enforcement
に有効な値は、enabled
、disabled
、testing
です。 disabled
は、pre-receive フックが実行されないことを示します。 enabled
は、それが実行され、ゼロ以外の状態になるプッシュを拒否することを示します。 testing
は、スクリプトは実行されるが、プッシュが拒否されないことを示します。
configuration_url
は、このエンドポイントまたはこのフックのグローバル構成へのリンクです。 サイトアドミンのみがグローバル設定にアクセスできます。
List pre-receive hooks for an organization
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.
"List pre-receive hooks for an organization" のきめ細かいアクセス トークン
このエンドポイントは、次の粒度の細かいトークンの種類で動作します:
粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:
- "Pre-receive hooks" organization permissions (read)
"List pre-receive hooks for an organization" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
名前, Type, 説明 |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
direction string The direction to sort the results by. Default: 次のいずれかにできます: |
sort string The sort order for the response collection. Default: 次のいずれかにできます: |
"List pre-receive hooks for an organization" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
"List pre-receive hooks for an organization" のコード サンプル
要求の例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks
Response
Get a pre-receive hook for an organization
"Get a pre-receive hook for an organization" のきめ細かいアクセス トークン
このエンドポイントは、次の粒度の細かいトークンの種類で動作します:
粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:
- "Pre-receive hooks" organization permissions (read)
"Get a pre-receive hook for an organization" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
pre_receive_hook_id integer 必須The unique identifier of the pre-receive hook. |
"Get a pre-receive hook for an organization" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
"Get a pre-receive hook for an organization" のコード サンプル
要求の例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
Response
Update pre-receive hook enforcement for an organization
For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement
and allow_downstream_configuration
"Update pre-receive hook enforcement for an organization" のきめ細かいアクセス トークン
このエンドポイントは、次の粒度の細かいトークンの種類で動作します:
粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:
- "Pre-receive hooks" organization permissions (write)
"Update pre-receive hook enforcement for an organization" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
pre_receive_hook_id integer 必須The unique identifier of the pre-receive hook. |
名前, Type, 説明 |
---|
enforcement string The state of enforcement for the hook on this repository. |
allow_downstream_configuration boolean Whether repositories can override enforcement. |
"Update pre-receive hook enforcement for an organization" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
"Update pre-receive hook enforcement for an organization" のコード サンプル
要求の例
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
-d '{"enforcement":"enabled","allow_downstream_configuration":false}'
Response
Remove pre-receive hook enforcement for an organization
Removes any overrides for this hook at the org level for this org.
"Remove pre-receive hook enforcement for an organization" のきめ細かいアクセス トークン
このエンドポイントは、次の粒度の細かいトークンの種類で動作します:
粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:
- "Pre-receive hooks" organization permissions (write)
"Remove pre-receive hook enforcement for an organization" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
pre_receive_hook_id integer 必須The unique identifier of the pre-receive hook. |
"Remove pre-receive hook enforcement for an organization" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
"Remove pre-receive hook enforcement for an organization" のコード サンプル
要求の例
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
Response