REST API endpoints for GitHub Actions policies - GitHub Enterprise Cloud Docs

List enterprise Actions policies

List all Actions policies for an enterprise.

“List enterprise Actions policies”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Enterprise administration" enterprise permissions (write)

“”List enterprise Actions policies 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`

“List enterprise Actions policies”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“List enterprise Actions policies”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/enterprises/{enterprise}/actions/policies

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/actions/policies

Response

Status: 200

{
  "total_count": 2,
  "policies": [
    {
      "id": 1,
      "name": "Restrict workflow modifications",
      "target": "actions",
      "source_type": "Enterprise",
      "source": "enterprise",
      "enforcement": "active",
      "node_id": "RUL_lA",
      "_links": {
        "self": {
          "href": "https://api.github.com/enterprises/enterprise/actions/policies/1"
        },
        "html": {
          "href": "https://github.com/enterprises/enterprise/settings/policies/actions/1"
        }
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Restrict workflow events",
      "target": "actions",
      "source_type": "Enterprise",
      "source": "enterprise",
      "enforcement": "evaluate",
      "node_id": "RUL_lB",
      "_links": {
        "self": {
          "href": "https://api.github.com/enterprises/enterprise/actions/policies/2"
        },
        "html": {
          "href": "https://github.com/enterprises/enterprise/settings/policies/actions/2"
        }
      },
      "created_at": "2024-01-15T11:00:00Z",
      "updated_at": "2024-01-15T11:00:00Z"
    }
  ]
}

Create an enterprise Actions policy

Create an Actions policy for an enterprise. Omitting workflow_path targets all workflows without storing an explicit condition.

“Create an enterprise Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Enterprise administration" enterprise permissions (write)

“”Create an enterprise Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

名称, 类型, 说明

name string 必须

The name of the policy.

enforcement string 必须

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. evaluate is not available for the repository target.

可以是以下选项之一: disabled, active, evaluate

conditions object

Conditions for an enterprise Actions policy. The conditions object supports one organization target (organization_name, organization_id, or organization_property) combined with one repository target (repository_name or repository_property), and may also contain workflow_path.

Can be one of these objects:

名称, 类型, 说明

organization_name_and_repository_name object

Conditions to target organizations by name and repositories by name

Properties of organization_name_and_repository_name

名称, 类型, 说明

organization_name object 必须

Properties of organization_name

名称, 类型, 说明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_name_and_repository_property object

Conditions to target organizations by name and repositories by property

Properties of organization_name_and_repository_property

名称, 类型, 说明

organization_name object 必须

Properties of organization_name

名称, 类型, 说明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_id_and_repository_name object

Conditions to target organizations by id and repositories by name

Properties of organization_id_and_repository_name

名称, 类型, 说明

organization_id object 必须

Properties of organization_id

名称, 类型, 说明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_id_and_repository_property object

Conditions to target organizations by id and repositories by property

Properties of organization_id_and_repository_property

名称, 类型, 说明

organization_id object 必须

Properties of organization_id

名称, 类型, 说明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_property_and_repository_name object

Conditions to target organizations by property and repositories by name

Properties of organization_property_and_repository_name

名称, 类型, 说明

organization_property object 必须

Properties of organization_property

名称, 类型, 说明

include array of objects

The organization properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

exclude array of objects

The organization properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_property_and_repository_property object

Conditions to target organizations by property and repositories by property

Properties of organization_property_and_repository_property

名称, 类型, 说明

organization_property object 必须

Properties of organization_property

名称, 类型, 说明

include array of objects

The organization properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

exclude array of objects

The organization properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

rules array of objects

An array of rules within the policy.

Can be one of these objects:

名称, 类型, 说明

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

名称, 类型, 说明

type string 必须

值: restrict_actions_actors

parameters object

Properties of parameters

名称, 类型, 说明

allowed_actors array of objects 必须

Select the actors who can run Actions workflows.

Properties of allowed_actors

名称, 类型, 说明
`id` integer 必须 ID of the actor authorized to trigger Actions workflows.
`type` string 必须 The type of the actor 可以是以下选项之一: `User`, `Bot`, `Team`, `BusinessTeam`, `EnterpriseTeam`, `IntegrationInstallation`, `App`, `RepositoryRole`

restrict_action_events object

Choose specific GitHub events that will trigger Actions workflows.

Properties of restrict_action_events

名称, 类型, 说明

type string 必须

值: restrict_action_events

parameters object

Properties of parameters

名称, 类型, 说明

allowed_events array of strings 必须

Select the events that can trigger Actions workflows. Supported values are: branch_protection_rule, check_run, check_suite, create, delete, deployment, deployment_status, discussion, discussion_comment, fork, gollum, image_version, issue_comment, issues, label, merge_group, milestone, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, pull_request_target, push, registry_package, release, repository_dispatch, schedule, status, watch, workflow_call, workflow_dispatch, workflow_run

“Create an enterprise Actions policy”的 HTTP 响应状态代码

状态代码	说明
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

“Create an enterprise Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

post/enterprises/{enterprise}/actions/policies

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/actions/policies \
  -d '{"name":"Require approved actors","enforcement":"active","rules":[{"type":"restrict_actions_actors","parameters":{"allowed_actors":[{"id":1234,"type":"Team"}]}}]}'

Response

Status: 201

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Get an enterprise Actions policy

Get a specific Actions policy for an enterprise.

“Get an enterprise Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Enterprise administration" enterprise permissions (write)

“”Get an enterprise Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`policy_id` integer 必须 The ID of the policy.

“Get an enterprise Actions policy”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get an enterprise Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/enterprises/{enterprise}/actions/policies/{policy_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/actions/policies/POLICY_ID

Response

Status: 200

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update an enterprise Actions policy

Update an Actions policy for an enterprise. Omitting workflow_path preserves the policy's existing workflow targeting.

“Update an enterprise Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Enterprise administration" enterprise permissions (write)

“”Update an enterprise Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`policy_id` integer 必须 The ID of the policy.

名称, 类型, 说明

name string

The name of the policy.

enforcement string

可以是以下选项之一: disabled, active, evaluate

conditions object

Can be one of these objects:

名称, 类型, 说明

organization_name_and_repository_name object

Conditions to target organizations by name and repositories by name

Properties of organization_name_and_repository_name

名称, 类型, 说明

organization_name object 必须

Properties of organization_name

名称, 类型, 说明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_name_and_repository_property object

Conditions to target organizations by name and repositories by property

Properties of organization_name_and_repository_property

名称, 类型, 说明

organization_name object 必须

Properties of organization_name

名称, 类型, 说明
`include` array of strings Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
`exclude` array of strings Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_id_and_repository_name object

Conditions to target organizations by id and repositories by name

Properties of organization_id_and_repository_name

名称, 类型, 说明

organization_id object 必须

Properties of organization_id

名称, 类型, 说明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_id_and_repository_property object

Conditions to target organizations by id and repositories by property

Properties of organization_id_and_repository_property

名称, 类型, 说明

organization_id object 必须

Properties of organization_id

名称, 类型, 说明
`organization_ids` array of integers The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_property_and_repository_name object

Conditions to target organizations by property and repositories by name

Properties of organization_property_and_repository_name

名称, 类型, 说明

organization_property object 必须

Properties of organization_property

名称, 类型, 说明

include array of objects

The organization properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

exclude array of objects

The organization properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

organization_property_and_repository_property object

Conditions to target organizations by property and repositories by property

Properties of organization_property_and_repository_property

名称, 类型, 说明

organization_property object 必须

Properties of organization_property

名称, 类型, 说明

include array of objects

The organization properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

exclude array of objects

The organization properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the organization property to target
`property_values` array of strings 必须 The values to match for the organization property

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

rules array of objects

An array of rules within the policy.

Can be one of these objects:

名称, 类型, 说明

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

名称, 类型, 说明

type string 必须

值: restrict_actions_actors

parameters object

Properties of parameters

名称, 类型, 说明

allowed_actors array of objects 必须

Select the actors who can run Actions workflows.

Properties of allowed_actors

名称, 类型, 说明
`id` integer 必须 ID of the actor authorized to trigger Actions workflows.
`type` string 必须 The type of the actor 可以是以下选项之一: `User`, `Bot`, `Team`, `BusinessTeam`, `EnterpriseTeam`, `IntegrationInstallation`, `App`, `RepositoryRole`

restrict_action_events object

Choose specific GitHub events that will trigger Actions workflows.

Properties of restrict_action_events

名称, 类型, 说明

type string 必须

值: restrict_action_events

parameters object

Properties of parameters

名称, 类型, 说明

allowed_events array of strings 必须

“Update an enterprise Actions policy”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

“Update an enterprise Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

put/enterprises/{enterprise}/actions/policies/{policy_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/actions/policies/POLICY_ID \
  -d '{"name":"Updated policy name","enforcement":"active"}'

Response

Status: 200

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Delete an enterprise Actions policy

Delete an Actions policy for an enterprise.

“Delete an enterprise Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Enterprise administration" enterprise permissions (write)

“”Delete an enterprise Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`policy_id` integer 必须 The ID of the policy.

“Delete an enterprise Actions policy”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found
`500`	Internal Error

“Delete an enterprise Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

delete/enterprises/{enterprise}/actions/policies/{policy_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/actions/policies/POLICY_ID

Response

Status: 204

List organization Actions policies

List all Actions policies for an organization.

“List organization Actions policies”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" organization permissions (write)

“”List organization Actions policies 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+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). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`
`has_parents` boolean Include policies configured at higher levels that apply to this organization 默认: `true`

“List organization Actions policies”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“List organization Actions policies”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/orgs/{org}/actions/policies

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/actions/policies

Response

Status: 200

{
  "total_count": 2,
  "policies": [
    {
      "id": 1,
      "name": "Restrict workflow modifications",
      "target": "actions",
      "source_type": "Enterprise",
      "source": "enterprise",
      "enforcement": "active",
      "node_id": "RUL_lA",
      "_links": {
        "self": {
          "href": "https://api.github.com/enterprises/enterprise/actions/policies/1"
        },
        "html": {
          "href": "https://github.com/enterprises/enterprise/settings/policies/actions/1"
        }
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Restrict workflow events",
      "target": "actions",
      "source_type": "Enterprise",
      "source": "enterprise",
      "enforcement": "evaluate",
      "node_id": "RUL_lB",
      "_links": {
        "self": {
          "href": "https://api.github.com/enterprises/enterprise/actions/policies/2"
        },
        "html": {
          "href": "https://github.com/enterprises/enterprise/settings/policies/actions/2"
        }
      },
      "created_at": "2024-01-15T11:00:00Z",
      "updated_at": "2024-01-15T11:00:00Z"
    }
  ]
}

Create an organization Actions policy

Create an Actions policy for an organization. Omitting workflow_path targets all workflows without storing an explicit condition.

“Create an organization Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" organization permissions (write)

“”Create an organization Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.

名称, 类型, 说明

name string 必须

The name of the policy.

enforcement string 必须

可以是以下选项之一: disabled, active, evaluate

conditions object

Conditions for an organization Actions policy. The conditions object should contain one of repository_name, repository_id, or repository_property, and may also contain workflow_path.

Can be one of these objects:

名称, 类型, 说明

Repository ruleset conditions for repository names object

Parameters for a repository name condition

Properties of Repository ruleset conditions for repository names

名称, 类型, 说明

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

Repository ruleset conditions for repository IDs object

Parameters for a repository ID condition

Properties of Repository ruleset conditions for repository IDs

名称, 类型, 说明

repository_id object 必须

Properties of repository_id

名称, 类型, 说明
`repository_ids` array of integers The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

Repository ruleset conditions for repository properties object

Parameters for a repository property condition

Properties of Repository ruleset conditions for repository properties

名称, 类型, 说明

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

rules array of objects

An array of rules within the policy.

Can be one of these objects:

名称, 类型, 说明

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

名称, 类型, 说明

type string 必须

值: restrict_actions_actors

parameters object

Properties of parameters

名称, 类型, 说明

allowed_actors array of objects 必须

Select the actors who can run Actions workflows.

Properties of allowed_actors

名称, 类型, 说明
`id` integer 必须 ID of the actor authorized to trigger Actions workflows.
`type` string 必须 The type of the actor 可以是以下选项之一: `User`, `Bot`, `Team`, `BusinessTeam`, `EnterpriseTeam`, `IntegrationInstallation`, `App`, `RepositoryRole`

restrict_action_events object

Choose specific GitHub events that will trigger Actions workflows.

Properties of restrict_action_events

名称, 类型, 说明

type string 必须

值: restrict_action_events

parameters object

Properties of parameters

名称, 类型, 说明

allowed_events array of strings 必须

“Create an organization Actions policy”的 HTTP 响应状态代码

状态代码	说明
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

“Create an organization Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

post/orgs/{org}/actions/policies

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/actions/policies \
  -d '{"name":"Require approved actors","enforcement":"active","rules":[{"type":"restrict_actions_actors","parameters":{"allowed_actors":[{"id":1234,"type":"Team"}]}}]}'

Response

Status: 201

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Get an organization Actions policy

Get a specific Actions policy for an organization.

“Get an organization Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" organization permissions (write)

“”Get an organization Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`policy_id` integer 必须 The ID of the policy.

“Get an organization Actions policy”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get an organization Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/orgs/{org}/actions/policies/{policy_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/actions/policies/POLICY_ID

Response

Status: 200

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update an organization Actions policy

Update an Actions policy for an organization. Omitting workflow_path preserves the policy's existing workflow targeting.

“Update an organization Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" organization permissions (write)

“”Update an organization Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`policy_id` integer 必须 The ID of the policy.

名称, 类型, 说明

name string

The name of the policy.

enforcement string

可以是以下选项之一: disabled, active, evaluate

conditions object

Conditions for an organization Actions policy. The conditions object should contain one of repository_name, repository_id, or repository_property, and may also contain workflow_path.

Can be one of these objects:

名称, 类型, 说明

Repository ruleset conditions for repository names object

Parameters for a repository name condition

Properties of Repository ruleset conditions for repository names

名称, 类型, 说明

repository_name object 必须

Properties of repository_name

名称, 类型, 说明
`include` array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
`exclude` array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
`protected` boolean Whether renaming of target repositories is prevented.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

Repository ruleset conditions for repository IDs object

Parameters for a repository ID condition

Properties of Repository ruleset conditions for repository IDs

名称, 类型, 说明

repository_id object 必须

Properties of repository_id

名称, 类型, 说明
`repository_ids` array of integers The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

Repository ruleset conditions for repository properties object

Parameters for a repository property condition

Properties of Repository ruleset conditions for repository properties

名称, 类型, 说明

repository_property object 必须

Properties of repository_property

名称, 类型, 说明

include array of objects

The repository properties and values to include. All of these properties must match for the condition to pass.

Properties of include

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

exclude array of objects

The repository properties and values to exclude. The condition will not pass if any of these properties match.

Properties of exclude

名称, 类型, 说明
`name` string 必须 The name of the repository property to target
`property_values` array of strings 必须 The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. 可以是以下选项之一: `custom`, `system`

workflow_path object

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

rules array of objects

An array of rules within the policy.

Can be one of these objects:

名称, 类型, 说明

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

名称, 类型, 说明

type string 必须

值: restrict_actions_actors

parameters object

Properties of parameters

名称, 类型, 说明

allowed_actors array of objects 必须

Select the actors who can run Actions workflows.

Properties of allowed_actors

名称, 类型, 说明
`id` integer 必须 ID of the actor authorized to trigger Actions workflows.
`type` string 必须 The type of the actor 可以是以下选项之一: `User`, `Bot`, `Team`, `BusinessTeam`, `EnterpriseTeam`, `IntegrationInstallation`, `App`, `RepositoryRole`

restrict_action_events object

Choose specific GitHub events that will trigger Actions workflows.

Properties of restrict_action_events

名称, 类型, 说明

type string 必须

值: restrict_action_events

parameters object

Properties of parameters

名称, 类型, 说明

allowed_events array of strings 必须

“Update an organization Actions policy”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

“Update an organization Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

put/orgs/{org}/actions/policies/{policy_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/actions/policies/POLICY_ID \
  -d '{"name":"Updated policy name","enforcement":"active"}'

Response

Status: 200

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Delete an organization Actions policy

Delete an Actions policy for an organization.

“Delete an organization Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" organization permissions (write)

“”Delete an organization Actions policy 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`policy_id` integer 必须 The ID of the policy.

“Delete an organization Actions policy”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found
`500`	Internal Error

“Delete an organization Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

delete/orgs/{org}/actions/policies/{policy_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/actions/policies/POLICY_ID

Response

Status: 204

List repository Actions policies

List all Actions policies for a repository.

“List repository Actions policies”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“”List repository Actions policies 的参数

标头
名称, 类型, 说明
`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.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`
`has_parents` boolean Include policies configured at higher levels that apply to this repository 默认: `true`

“List repository Actions policies”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“List repository Actions policies”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/repos/{owner}/{repo}/actions/policies

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/actions/policies

Response

Status: 200

{
  "total_count": 2,
  "policies": [
    {
      "id": 1,
      "name": "Restrict workflow modifications",
      "target": "actions",
      "source_type": "Enterprise",
      "source": "enterprise",
      "enforcement": "active",
      "node_id": "RUL_lA",
      "_links": {
        "self": {
          "href": "https://api.github.com/enterprises/enterprise/actions/policies/1"
        },
        "html": {
          "href": "https://github.com/enterprises/enterprise/settings/policies/actions/1"
        }
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Restrict workflow events",
      "target": "actions",
      "source_type": "Enterprise",
      "source": "enterprise",
      "enforcement": "evaluate",
      "node_id": "RUL_lB",
      "_links": {
        "self": {
          "href": "https://api.github.com/enterprises/enterprise/actions/policies/2"
        },
        "html": {
          "href": "https://github.com/enterprises/enterprise/settings/policies/actions/2"
        }
      },
      "created_at": "2024-01-15T11:00:00Z",
      "updated_at": "2024-01-15T11:00:00Z"
    }
  ]
}

Create a repository Actions policy

Create an Actions policy for a repository. Omitting workflow_path targets all workflows without storing an explicit condition.

“Create a repository Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“”Create a repository Actions policy 的参数

标头
名称, 类型, 说明
`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.

名称, 类型, 说明

name string 必须

The name of the policy.

enforcement string 必须

可以是以下选项之一: disabled, active, evaluate

conditions object

Conditions for a repository Actions policy. The object may be empty to preserve or use the default workflow targeting, or contain only workflow_path.

Can be one of these objects:

名称, 类型, 说明

object

Properties of

Actions policy workflow path condition object

Parameters for an Actions policy workflow path condition. Omitting workflow_path when creating a policy targets all workflows without storing an explicit condition. Omitting it when updating a policy preserves the existing workflow targeting. For new or changed workflow conditions, the API requires at least one included or excluded pattern. This is validated server-side rather than by this schema, which can also describe existing stored conditions.

Properties of Actions policy workflow path condition

名称, 类型, 说明

workflow_path object 必须

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

rules array of objects

An array of rules within the policy.

Can be one of these objects:

名称, 类型, 说明

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

名称, 类型, 说明

type string 必须

值: restrict_actions_actors

parameters object

Properties of parameters

名称, 类型, 说明

allowed_actors array of objects 必须

Select the actors who can run Actions workflows.

Properties of allowed_actors

名称, 类型, 说明
`id` integer 必须 ID of the actor authorized to trigger Actions workflows.
`type` string 必须 The type of the actor 可以是以下选项之一: `User`, `Bot`, `Team`, `BusinessTeam`, `EnterpriseTeam`, `IntegrationInstallation`, `App`, `RepositoryRole`

restrict_action_events object

Choose specific GitHub events that will trigger Actions workflows.

Properties of restrict_action_events

名称, 类型, 说明

type string 必须

值: restrict_action_events

parameters object

Properties of parameters

名称, 类型, 说明

allowed_events array of strings 必须

“Create a repository Actions policy”的 HTTP 响应状态代码

状态代码	说明
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

“Create a repository Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

post/repos/{owner}/{repo}/actions/policies

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/actions/policies \
  -d '{"name":"Require approved actors","enforcement":"active","rules":[{"type":"restrict_actions_actors","parameters":{"allowed_actors":[{"id":1234,"type":"Team"}]}}]}'

Response

Status: 201

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Get a repository Actions policy

Get a specific Actions policy for a repository.

“Get a repository Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“”Get a repository Actions policy 的参数

标头
名称, 类型, 说明
`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.
`policy_id` integer 必须 The ID of the policy.

“Get a repository Actions policy”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get a repository Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

get/repos/{owner}/{repo}/actions/policies/{policy_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/actions/policies/POLICY_ID

Response

Status: 200

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update a repository Actions policy

Update an Actions policy for a repository. Omitting workflow_path preserves the policy's existing workflow targeting.

“Update a repository Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“”Update a repository Actions policy 的参数

标头
名称, 类型, 说明
`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.
`policy_id` integer 必须 The ID of the policy.

名称, 类型, 说明

name string

The name of the policy.

enforcement string

可以是以下选项之一: disabled, active, evaluate

conditions object

Conditions for a repository Actions policy. The object may be empty to preserve or use the default workflow targeting, or contain only workflow_path.

Can be one of these objects:

名称, 类型, 说明

object

Properties of

Actions policy workflow path condition object

Properties of Actions policy workflow path condition

名称, 类型, 说明

workflow_path object 必须

Properties of workflow_path

名称, 类型, 说明
`include` array of strings 必须 Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
`exclude` array of strings 必须 Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.

rules array of objects

An array of rules within the policy.

Can be one of these objects:

名称, 类型, 说明

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

名称, 类型, 说明

type string 必须

值: restrict_actions_actors

parameters object

Properties of parameters

名称, 类型, 说明

allowed_actors array of objects 必须

Select the actors who can run Actions workflows.

Properties of allowed_actors

名称, 类型, 说明
`id` integer 必须 ID of the actor authorized to trigger Actions workflows.
`type` string 必须 The type of the actor 可以是以下选项之一: `User`, `Bot`, `Team`, `BusinessTeam`, `EnterpriseTeam`, `IntegrationInstallation`, `App`, `RepositoryRole`

restrict_action_events object

Choose specific GitHub events that will trigger Actions workflows.

Properties of restrict_action_events

名称, 类型, 说明

type string 必须

值: restrict_action_events

parameters object

Properties of parameters

名称, 类型, 说明

allowed_events array of strings 必须

“Update a repository Actions policy”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

“Update a repository Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

put/repos/{owner}/{repo}/actions/policies/{policy_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/actions/policies/POLICY_ID \
  -d '{"name":"Updated policy name","enforcement":"active"}'

Response

Status: 200

{
  "id": 1,
  "name": "Restrict workflow modifications",
  "target": "actions",
  "source_type": "Enterprise",
  "source": "enterprise",
  "enforcement": "active",
  "conditions": {
    "organization_name": {
      "include": [
        "octo-org"
      ],
      "exclude": []
    },
    "repository_name": {
      "include": [
        "octo-repo"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "restrict_actions_actors",
      "parameters": {
        "allowed_actors": [
          {
            "id": 5,
            "type": "User"
          },
          {
            "id": 1234,
            "type": "Team"
          }
        ]
      }
    }
  ],
  "node_id": "RUL_lA",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Delete a repository Actions policy

Delete an Actions policy for a repository.

“Delete a repository Actions policy”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“”Delete a repository Actions policy 的参数

标头
名称, 类型, 说明
`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.
`policy_id` integer 必须 The ID of the policy.

“Delete a repository Actions policy”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found
`500`	Internal Error

“Delete a repository Actions policy”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

delete/repos/{owner}/{repo}/actions/policies/{policy_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/actions/policies/POLICY_ID

Response

Status: 204