Конечные точки REST API для управления исключением контента Copilot

Используйте API REST для управления правилами исключения контента Copilot.

Get Copilot content exclusion rules for an organization

Note

This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot content exclusion path rules. To configure these settings, go to the organization's settings on GitHub. For more information, see "Excluding content from GitHub Copilot."

Organization owners can view details about Copilot content exclusion rules for the organization.

OAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.

Caution

At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.

Подробные маркеры доступа для "Get Copilot content exclusion rules for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Copilot content exclusion" organization permissions (read)

Параметры для "Get Copilot content exclusion rules for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Коды состояния http-ответа для "Get Copilot content exclusion rules for an organization"

Код состояния	Description
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Примеры кода для "Get Copilot content exclusion rules for an organization"

Пример запроса

get/orgs/{org}/copilot/content_exclusion

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/copilot/content_exclusion

OK

Status: 200

{
  "octo-repo": [
    "/src/some-dir/kernel.rs"
  ]
}

Set Copilot content exclusion rules for an organization

Note

This endpoint is in public preview and is subject to change.

Sets Copilot content exclusion path rules for an organization. To configure these settings, go to the organization's settings on GitHub. For more information, see "Excluding content from GitHub Copilot."

Organization owners can set Copilot content exclusion rules for the organization.

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

Caution

At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.

Подробные маркеры доступа для "Set Copilot content exclusion rules for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Copilot content exclusion" organization permissions (write)

Параметры для "Set Copilot content exclusion rules for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Коды состояния http-ответа для "Set Copilot content exclusion rules for an organization"

Код состояния	Description
`200`	Success
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`413`	Payload Too Large
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Примеры кода для "Set Copilot content exclusion rules for an organization"

Пример запроса

put/orgs/{org}/copilot/content_exclusion

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/copilot/content_exclusion \
  -d '{"octo-repo":["/src/some-dir/kernel.rs"]}'

Success

Status: 200

{
  "message": "Content exclusion rules updated successfully."
}