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

List enterprise Actions policies

List all Actions policies for an enterprise.

Tokens de acesso granulares para "List enterprise Actions policies"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "List enterprise Actions policies"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

Códigos de status de resposta HTTP para "List enterprise Actions policies"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List enterprise Actions policies"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Create an enterprise Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Create an enterprise Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Nome, Tipo, Descrição

name string Obrigatório

The name of the policy.

enforcement string Obrigatório

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.

Pode ser um dos: 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:

Nome, Tipo, Descrição

organization_name_and_repository_name object

Conditions to target organizations by name and repositories by name

Properties of organization_name_and_repository_name

Nome, Tipo, Descrição

organization_name object Obrigatório

Properties of organization_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_name object Obrigatório

Properties of organization_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_id object Obrigatório

Properties of organization_id

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_id object Obrigatório

Properties of organization_id

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_property object Obrigatório

Properties of organization_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório 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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório The values to match for the organization property

repository_name object Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_property object Obrigatório

Properties of organization_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório 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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório The values to match for the organization property

repository_property object Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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:

Nome, Tipo, Descrição

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_actions_actors

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_actors array of objects Obrigatório

Select the actors who can run Actions workflows.

Properties of allowed_actors

Nome, Tipo, Descrição
`id` integer Obrigatório ID of the actor authorized to trigger Actions workflows.
`type` string Obrigatório The type of the actor Pode ser um dos: `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

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_action_events

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_events array of strings Obrigatório

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

Códigos de status de resposta HTTP para "Create an enterprise Actions policy"

Código de status	Descrição
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Create an enterprise Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Get an enterprise Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Get an enterprise Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`policy_id` integer Obrigatório The ID of the policy.

Códigos de status de resposta HTTP para "Get an enterprise Actions policy"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get an enterprise Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Update an enterprise Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Update an enterprise Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`policy_id` integer Obrigatório The ID of the policy.

Nome, Tipo, Descrição

name string

The name of the policy.

enforcement string

Pode ser um dos: disabled, active, evaluate

conditions object

Can be one of these objects:

Nome, Tipo, Descrição

organization_name_and_repository_name object

Conditions to target organizations by name and repositories by name

Properties of organization_name_and_repository_name

Nome, Tipo, Descrição

organization_name object Obrigatório

Properties of organization_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_name object Obrigatório

Properties of organization_name

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_id object Obrigatório

Properties of organization_id

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_id object Obrigatório

Properties of organization_id

Nome, Tipo, Descrição
`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 Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_property object Obrigatório

Properties of organization_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório 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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório The values to match for the organization property

repository_name object Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

organization_property object Obrigatório

Properties of organization_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório 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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the organization property to target
`property_values` array of strings Obrigatório The values to match for the organization property

repository_property object Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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:

Nome, Tipo, Descrição

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_actions_actors

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_actors array of objects Obrigatório

Select the actors who can run Actions workflows.

Properties of allowed_actors

Nome, Tipo, Descrição
`id` integer Obrigatório ID of the actor authorized to trigger Actions workflows.
`type` string Obrigatório The type of the actor Pode ser um dos: `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

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_action_events

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_events array of strings Obrigatório

Códigos de status de resposta HTTP para "Update an enterprise Actions policy"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Update an enterprise Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Delete an enterprise Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" enterprise permissions (write)

Parâmetros para "Delete an enterprise Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`policy_id` integer Obrigatório The ID of the policy.

Códigos de status de resposta HTTP para "Delete an enterprise Actions policy"

Código de status	Descrição
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Delete an enterprise Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "List organization Actions policies"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "List organization Actions policies"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`
`has_parents` boolean Include policies configured at higher levels that apply to this organization Padrão: `true`

Códigos de status de resposta HTTP para "List organization Actions policies"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List organization Actions policies"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Create an organization Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Create an organization Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Nome, Tipo, Descrição

name string Obrigatório

The name of the policy.

enforcement string Obrigatório

Pode ser um dos: 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:

Nome, Tipo, Descrição

Repository ruleset conditions for repository names object

Parameters for a repository name condition

Properties of Repository ruleset conditions for repository names

Nome, Tipo, Descrição

repository_name object Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

repository_id object Obrigatório

Properties of repository_id

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

repository_property object Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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:

Nome, Tipo, Descrição

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_actions_actors

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_actors array of objects Obrigatório

Select the actors who can run Actions workflows.

Properties of allowed_actors

Nome, Tipo, Descrição
`id` integer Obrigatório ID of the actor authorized to trigger Actions workflows.
`type` string Obrigatório The type of the actor Pode ser um dos: `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

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_action_events

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_events array of strings Obrigatório

Códigos de status de resposta HTTP para "Create an organization Actions policy"

Código de status	Descrição
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Create an organization Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Get an organization Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Get an organization Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`policy_id` integer Obrigatório The ID of the policy.

Códigos de status de resposta HTTP para "Get an organization Actions policy"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get an organization Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Update an organization Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Update an organization Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`policy_id` integer Obrigatório The ID of the policy.

Nome, Tipo, Descrição

name string

The name of the policy.

enforcement string

Pode ser um dos: 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:

Nome, Tipo, Descrição

Repository ruleset conditions for repository names object

Parameters for a repository name condition

Properties of Repository ruleset conditions for repository names

Nome, Tipo, Descrição

repository_name object Obrigatório

Properties of repository_name

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

repository_id object Obrigatório

Properties of repository_id

Nome, Tipo, Descrição
`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

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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

Nome, Tipo, Descrição

repository_property object Obrigatório

Properties of repository_property

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `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

Nome, Tipo, Descrição
`name` string Obrigatório The name of the repository property to target
`property_values` array of strings Obrigatório The values to match for the repository property
`source` string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: `custom`, `system`

workflow_path object

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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:

Nome, Tipo, Descrição

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_actions_actors

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_actors array of objects Obrigatório

Select the actors who can run Actions workflows.

Properties of allowed_actors

Nome, Tipo, Descrição
`id` integer Obrigatório ID of the actor authorized to trigger Actions workflows.
`type` string Obrigatório The type of the actor Pode ser um dos: `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

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_action_events

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_events array of strings Obrigatório

Códigos de status de resposta HTTP para "Update an organization Actions policy"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Update an organization Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Delete an organization Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" organization permissions (write)

Parâmetros para "Delete an organization Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`policy_id` integer Obrigatório The ID of the policy.

Códigos de status de resposta HTTP para "Delete an organization Actions policy"

Código de status	Descrição
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Delete an organization Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "List repository Actions policies"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "List repository Actions policies"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`
`has_parents` boolean Include policies configured at higher levels that apply to this repository Padrão: `true`

Códigos de status de resposta HTTP para "List repository Actions policies"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List repository Actions policies"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Create a repository Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Create a repository Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Nome, Tipo, Descrição

name string Obrigatório

The name of the policy.

enforcement string Obrigatório

Pode ser um dos: 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:

Nome, Tipo, Descrição

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

Nome, Tipo, Descrição

workflow_path object Obrigatório

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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:

Nome, Tipo, Descrição

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_actions_actors

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_actors array of objects Obrigatório

Select the actors who can run Actions workflows.

Properties of allowed_actors

Nome, Tipo, Descrição
`id` integer Obrigatório ID of the actor authorized to trigger Actions workflows.
`type` string Obrigatório The type of the actor Pode ser um dos: `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

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_action_events

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_events array of strings Obrigatório

Códigos de status de resposta HTTP para "Create a repository Actions policy"

Código de status	Descrição
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Create a repository Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Get a repository Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Get a repository Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`policy_id` integer Obrigatório The ID of the policy.

Códigos de status de resposta HTTP para "Get a repository Actions policy"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Get a repository Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Update a repository Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Update a repository Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`policy_id` integer Obrigatório The ID of the policy.

Nome, Tipo, Descrição

name string

The name of the policy.

enforcement string

Pode ser um dos: 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:

Nome, Tipo, Descrição

object

Properties of

Actions policy workflow path condition object

Properties of Actions policy workflow path condition

Nome, Tipo, Descrição

workflow_path object Obrigatório

Properties of workflow_path

Nome, Tipo, Descrição
`include` array of strings Obrigatório 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 Obrigatório 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:

Nome, Tipo, Descrição

restrict_actions_actors object

Choose specific actors that are authorized to trigger Actions workflows.

Properties of restrict_actions_actors

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_actions_actors

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_actors array of objects Obrigatório

Select the actors who can run Actions workflows.

Properties of allowed_actors

Nome, Tipo, Descrição
`id` integer Obrigatório ID of the actor authorized to trigger Actions workflows.
`type` string Obrigatório The type of the actor Pode ser um dos: `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

Nome, Tipo, Descrição

type string Obrigatório

Valor: restrict_action_events

parameters object

Properties of parameters

Nome, Tipo, Descrição

allowed_events array of strings Obrigatório

Códigos de status de resposta HTTP para "Update a repository Actions policy"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Update a repository Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso granulares para "Delete a repository Actions policy"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Administration" repository permissions (write)

Parâmetros para "Delete a repository Actions policy"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`policy_id` integer Obrigatório The ID of the policy.

Códigos de status de resposta HTTP para "Delete a repository Actions policy"

Código de status	Descrição
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Delete a repository Actions policy"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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