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

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

Get feature policies for an organization

Note

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

Use this endpoint to retrieve the Copilot default availability policy for new features and clients for an organization.

The enterprise default is used when the enterprise has set one. Otherwise, the organization's own default is used, and an organization that has not enabled a default is reported as disabled. For more information, see About default availability.

Organization owners can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint. Organization SAML authorization and OAuth app access restrictions also apply.

Детализированные токены доступа для «Get feature policies for an organization»

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

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

  • "Administration" organization permissions (write)

Параметры для «Get feature policies for an organization»

Заголовки
accept string

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

Параметры пути
org string Обязательное поле

The organization name. The name is not case sensitive.

HTTP-коды статуса ответа для «Get feature policies for an organization»

Код состоянияDescription
200

OK

401

Requires authentication

403

Forbidden

404

Resource not found

Примеры кода для «Get feature policies for an organization»

Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.

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

get/orgs/{org}/copilot/feature-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/copilot/feature-policies

OK

Status: 200
{ "default_availability": { "policy_state": "enabled", "editable": true } }

Update feature policies for an organization

Note

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

Use this endpoint to update the Copilot default availability policy for new features and clients for an organization.

An organization can only set its own default while its enterprise has not set one. For more information, see About default availability.

Changing this policy does not change any Copilot feature or client policy that has already been set.

Organization owners can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint. Organization SAML authorization and OAuth app access restrictions also apply.

Детализированные токены доступа для «Update feature policies for an organization»

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

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

  • "Administration" organization permissions (write)

Параметры для «Update feature policies for an organization»

Заголовки
accept string

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

Параметры пути
org string Обязательное поле

The organization name. The name is not case sensitive.

Параметры запроса
default_availability object Обязательное поле
policy_state string Обязательное поле

The organization default policy applied to newly released Copilot features and clients.

Возможные значения: enabled, disabled

HTTP-коды статуса ответа для «Update feature policies for an organization»

Код состоянияDescription
200

OK

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для «Update feature policies for an organization»

Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.

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

patch/orgs/{org}/copilot/feature-policies
curl -L \ -X PATCH \ -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/feature-policies \ -d '{"default_availability":{"policy_state":"enabled"}}'

OK

Status: 200
{ "default_availability": { "policy_state": "enabled", "editable": true } }