Конечные точки REST API для настройки команды Copilot

Get Copilot customizations for a team

Note

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

Gets the GitHub-managed Copilot customizations of a team.

The authenticated user must be an organization owner or a team maintainer. Teams that keep their customizations in a repository return 409.

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

Детализированные токены доступа для «Get Copilot customizations for a team»

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

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

"Copilot agent settings" organization permissions (read)

Параметры для «Get Copilot customizations for a team»

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

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

HTTP-коды статуса ответа для «Get Copilot customizations for a team»

Код состояния	Description
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error
`503`	Service unavailable

Примеры кода для «Get Copilot customizations for a team»

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

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

get/orgs/{org}/teams/{team_slug}/copilot/customizations

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/teams/TEAM_SLUG/copilot/customizations

Response

Status: 200

{
  "pluginAssignments": {
    "code-review@acme-marketplace": {
      "state": "defaultEnabled"
    }
  },
  "extraKnownMarketplaces": {
    "acme-marketplace": {
      "source": {
        "source": "github",
        "repo": "acme/copilot-marketplace"
      }
    }
  }
}

Set Copilot customizations for a team

Note

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

Replaces the GitHub-managed Copilot customizations of a team, creating them on the first write.

The authenticated user must be an organization owner or a team maintainer. Teams that keep their customizations in a repository return 409. Documents that fail validation return 422 with the reason.

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

Детализированные токены доступа для «Set Copilot customizations for a team»

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

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

"Copilot agent settings" organization permissions (write)

Параметры для «Set Copilot customizations for a team»

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

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

Имя., Тип, Description

pluginAssignments object

Plugins assigned to the team, keyed by PLUGIN@MARKETPLACE.

Properties of pluginAssignments

Имя., Тип, Description

key object

A user-defined key to represent an item in pluginAssignments.

Properties of key

Имя., Тип, Description
`state` string The assignment state. значение: `defaultEnabled`

extraKnownMarketplaces object

Additional plugin marketplaces available to the team, keyed by marketplace name.

Properties of extraKnownMarketplaces

Имя., Тип, Description
`key` object A user-defined key to represent an item in `extraKnownMarketplaces`.

HTTP-коды статуса ответа для «Set Copilot customizations for a team»

Код состояния	Description
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error
`503`	Service unavailable

Примеры кода для «Set Copilot customizations for a team»

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

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

put/orgs/{org}/teams/{team_slug}/copilot/customizations

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/teams/TEAM_SLUG/copilot/customizations \
  -d '{"pluginAssignments":{"code-review@acme-marketplace":{"state":"defaultEnabled"}},"extraKnownMarketplaces":{"acme-marketplace":{"source":{"source":"github","repo":"acme/copilot-marketplace"}}}}'

Response

Status: 200

{
  "pluginAssignments": {
    "code-review@acme-marketplace": {
      "state": "defaultEnabled"
    }
  },
  "extraKnownMarketplaces": {
    "acme-marketplace": {
      "source": {
        "source": "github",
        "repo": "acme/copilot-marketplace"
      }
    }
  }
}

Delete Copilot customizations for a team

Note

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

Deletes the GitHub-managed Copilot customizations of a team. Deleting customizations that don't exist succeeds.

The authenticated user must be an organization owner or a team maintainer. Teams that keep their customizations in a repository return 409.

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

Детализированные токены доступа для «Delete Copilot customizations for a team»

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

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

"Copilot agent settings" organization permissions (write)

Параметры для «Delete Copilot customizations for a team»

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

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

HTTP-коды статуса ответа для «Delete Copilot customizations for a team»

Код состояния	Description
`204`	No Content
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error
`503`	Service unavailable

Примеры кода для «Delete Copilot customizations for a team»

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

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

delete/orgs/{org}/teams/{team_slug}/copilot/customizations

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/teams/TEAM_SLUG/copilot/customizations

Response

Status: 204

Конечные точки REST API для настройки команды Copilot

Get Copilot customizations for a team

Детализированные токены доступа для «Get Copilot customizations for a team»

Параметры для «Get Copilot customizations for a team»

HTTP-коды статуса ответа для «Get Copilot customizations for a team»

Примеры кода для «Get Copilot customizations for a team»

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

Response

Set Copilot customizations for a team

Детализированные токены доступа для «Set Copilot customizations for a team»

Параметры для «Set Copilot customizations for a team»

HTTP-коды статуса ответа для «Set Copilot customizations for a team»

Примеры кода для «Set Copilot customizations for a team»

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

Response

Delete Copilot customizations for a team

Детализированные токены доступа для «Delete Copilot customizations for a team»

Параметры для «Delete Copilot customizations for a team»

HTTP-коды статуса ответа для «Delete Copilot customizations for a team»

Примеры кода для «Delete Copilot customizations for a team»

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

Response

Была ли эта документация полезной?

По-прежнему нужна помощь?