GitHub Copilot Copilot API
Endpoints to manage Copilot using the REST API.
Operations 44
GET
/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day
Get Copilot enterprise usage metrics for a specific day
#
GET
/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest
Get Copilot enterprise usage metrics
#
GET
/enterprises/{enterprise}/copilot/metrics/reports/repos-1-day
Get Copilot enterprise repository report for a specific day
#
GET
/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day
Get Copilot enterprise user-teams report for a specific day
#
GET
/enterprises/{enterprise}/copilot/metrics/reports/users-1-day
Get Copilot users usage metrics for a specific day
#
GET
/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest
Get Copilot users usage metrics
#
GET
/enterprises/{enterprise}/copilot/policies/code-review
Get the Copilot code review policy for an enterprise
#
PUT
/enterprises/{enterprise}/copilot/policies/code-review
Set the Copilot code review policy for an enterprise
#
PUT
/enterprises/{enterprise}/copilot/policies/coding_agent
Set the coding agent policy for an enterprise
#
POST
/enterprises/{enterprise}/copilot/policies/coding_agent/organizations
Add organizations to the enterprise coding agent policy
#
DELETE
/enterprises/{enterprise}/copilot/policies/coding_agent/organizations
Remove organizations from the enterprise coding agent policy
#
POST
/orgs/{org}/copilot/billing/selected_teams
Add teams to the Copilot subscription for an organization
#
DELETE
/orgs/{org}/copilot/billing/selected_teams
Remove teams from the Copilot subscription for an organization
#
POST
/orgs/{org}/copilot/billing/selected_users
Add users to the Copilot subscription for an organization
#
DELETE
/orgs/{org}/copilot/billing/selected_users
Remove users from the Copilot subscription for an organization
#
GET
/orgs/{org}/copilot/code-review/runner
Get the Copilot code review runner configuration for an organization
#
PUT
/orgs/{org}/copilot/code-review/runner
Set the Copilot code review runner configuration for an organization
#
PATCH
/orgs/{org}/copilot/code-review/settings
Update Copilot code review settings for an organization
#
GET
/orgs/{org}/copilot/coding-agent/permissions
Get Copilot cloud agent permissions for an organization
#
PUT
/orgs/{org}/copilot/coding-agent/permissions
Set Copilot cloud agent permissions for an organization
#
GET
/orgs/{org}/copilot/coding-agent/permissions/repositories
List repositories enabled for Copilot cloud agent in an organization
#
PUT
/orgs/{org}/copilot/coding-agent/permissions/repositories
Set selected repositories for Copilot cloud agent in an organization
#
PUT
/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}
Enable a repository for Copilot cloud agent in an organization
#
DELETE
/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}
Disable a repository for Copilot cloud agent in an organization
#
GET
/orgs/{org}/copilot/metrics/reports/organization-1-day
Get Copilot organization usage metrics for a specific day
#
GET
/orgs/{org}/copilot/metrics/reports/organization-28-day/latest
Get Copilot organization usage metrics
#
GET
/orgs/{org}/copilot/metrics/reports/repos-1-day
Get Copilot organization repository report for a specific day
#
GET
/orgs/{org}/copilot/metrics/reports/user-teams-1-day
Get Copilot organization user-teams report for a specific day
#
GET
/orgs/{org}/copilot/metrics/reports/users-1-day
Get Copilot organization users usage metrics for a specific day
#
GET
/orgs/{org}/copilot/metrics/reports/users-28-day/latest
Get Copilot organization users usage metrics
#
GET
/orgs/{org}/copilot/policies/code-review
Get the Copilot code review policy for an organization
#
PUT
/orgs/{org}/copilot/policies/code-review
Set the Copilot code review policy for an organization
#
DELETE
/orgs/{org}/teams/{team_slug}/copilot/customizations
Delete Copilot customizations for a team
#
GET
/repos/{owner}/{repo}/copilot/cloud-agent/configuration
Get Copilot cloud agent configuration for a repository
#
GET
/repos/{owner}/{repo}/copilot/code-review/settings
Get Copilot code review settings for a repository
#
PATCH
/repos/{owner}/{repo}/copilot/code-review/settings
Update Copilot code review settings for a repository
#
Documentation
Documentation
https://docs.github.com/en/rest/copilot
Authentication
https://docs.github.com/en/rest/authentication
GettingStarted
https://docs.github.com/en/copilot/quickstart
Documentation
https://docs.github.com/en/rest/copilot/copilot-for-business
Documentation
https://docs.github.com/en/rest/copilot/copilot-user-management
Documentation
https://docs.github.com/en/rest/copilot/copilot-metrics
Documentation
https://docs.github.com/en/rest/copilot/copilot-usage-metrics
Documentation
https://docs.github.com/en/rest/copilot/copilot-content-exclusion-management
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/github-copilot/json-schema/github-copilot-minimal-repository-schema.json
JSONSchema
https://artifacts.apis.io/github-copilot/json-schema/github-copilot-copilot-seat-details-schema.json
JSONSchema
https://artifacts.apis.io/github-copilot/json-schema/github-copilot-repository-copilot-code-review-settings-schema.json
JSONSchema
https://artifacts.apis.io/github-copilot/json-schema/github-copilot-organization-copilot-code-review-settings-schema.json
JSONSchema
https://artifacts.apis.io/github-copilot/json-schema/github-copilot-copilot-organization-details-schema.json
JSONSchema
https://artifacts.apis.io/github-copilot/json-schema/github-copilot-organization-copilot-code-review-runner-schema.json