Skip to main content
REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

保护规则

使用 REST API 创建、配置和删除部署保护规则。

Get all deployment protection rules for an environment

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "Using environments for deployment."

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

“Get all deployment protection rules for an environment”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • actions:read

如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。

“Get all deployment protection rules for an environment”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
environment_name string 必须

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

owner string 必须

The account owner of the repository. The name is not case sensitive.

“Get all deployment protection rules for an environment”的 HTTP 响应状态代码

状态代码说明
200

List of deployment protection rules

“Get all deployment protection rules for an environment”的示例代码

请求示例

get/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules

List of deployment protection rules

Status: 200
{ "total_count": 2, "custom_deployment_protection_rules": [ { "id": 3, "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", "enabled": true, "app": { "id": 1, "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", "slug": "a-custom-app", "integration_url": "https://api.github.com/apps/a-custom-app" } }, { "id": 4, "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", "enabled": true, "app": { "id": 1, "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", "slug": "another-custom-app", "integration_url": "https://api.github.com/apps/another-custom-app" } } ] }

Create a custom deployment protection rule on an environment

Enable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

“Create a custom deployment protection rule on an environment”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • administration:write

“Create a custom deployment protection rule on an environment”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
environment_name string 必须

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

owner string 必须

The account owner of the repository. The name is not case sensitive.

正文参数
名称, 类型, 说明
integration_id integer

The ID of the custom app that will be enabled on the environment.

“Create a custom deployment protection rule on an environment”的 HTTP 响应状态代码

状态代码说明
201

The enabled custom deployment protection rule

“Create a custom deployment protection rule on an environment”的示例代码

请求示例

post/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules \ -d '{"integration_id":5}'

The enabled custom deployment protection rule

Status: 201
{ "id": 3, "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", "enabled": true, "app": { "id": 1, "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", "slug": "a-custom-app", "integration_url": "https://api.github.com/apps/a-custom-app" } }

List custom deployment rule integrations available for an environment

Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.

For more information about environments, see "Using environments for deployment."

For more information about the app that is providing this custom deployment rule, see "GET an app".

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

“List custom deployment rule integrations available for an environment”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • actions:read

如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。

“List custom deployment rule integrations available for an environment”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
environment_name string 必须

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

owner string 必须

The account owner of the repository. The name is not case sensitive.

查询参数
名称, 类型, 说明
page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

默认: 1

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

默认: 30

“List custom deployment rule integrations available for an environment”的 HTTP 响应状态代码

状态代码说明
200

A list of custom deployment rule integrations available for this environment.

“List custom deployment rule integrations available for an environment”的示例代码

请求示例

get/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules/apps

A list of custom deployment rule integrations available for this environment.

Status: 200
[ { "total_count": 2 }, { "available_custom_deployment_protection_rule_integrations": [ { "id": 1, "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", "slug": "a-custom-app", "integration_url": "https://api.github.com/apps/a-custom-app" }, { "id": 2, "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", "slug": "another-custom-app", "integration_url": "https://api.github.com/apps/another-custom-app" } ] } ]

Get a custom deployment protection rule

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "Using environments for deployment."

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

“Get a custom deployment protection rule”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • actions:read

如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。

“Get a custom deployment protection rule”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

environment_name string 必须

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

protection_rule_id integer 必须

The unique identifier of the protection rule.

“Get a custom deployment protection rule”的 HTTP 响应状态代码

状态代码说明
200

OK

“Get a custom deployment protection rule”的示例代码

请求示例

get/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules/PROTECTION_RULE_ID

Response

Status: 200
{ "id": 3, "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", "enabled": true, "app": { "id": 1, "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", "slug": "a-custom-app", "integration_url": "https://api.github.com/apps/a-custom-app" } }

Disable a custom protection rule for an environment

Disables a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

“Disable a custom protection rule for an environment”的细粒度访问令牌

此终结点适用于以下令牌类型:

令牌必须具有以下权限集:

  • administration:write

“Disable a custom protection rule for an environment”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
environment_name string 必须

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

owner string 必须

The account owner of the repository. The name is not case sensitive.

protection_rule_id integer 必须

The unique identifier of the protection rule.

“Disable a custom protection rule for an environment”的 HTTP 响应状态代码

状态代码说明
204

No Content

“Disable a custom protection rule for an environment”的示例代码

请求示例

delete/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment_protection_rules/PROTECTION_RULE_ID

Response

Status: 204