REST API endpoints for Copilot cloud agent repository management

Use the REST API to manage repository-level settings for Copilot-Cloud-Agent.

Get Copilot cloud agent configuration for a repository

Note

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

Gets the Copilot cloud agent configuration for a repository, including MCP server configuration, enabled review tools, Actions workflow approval settings, and firewall configuration.

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

Feinkörnige Zugriffstoken für "Get Copilot cloud agent configuration for a repository"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

"Copilot agent settings" repository permissions (read)

Parameter für "Get Copilot cloud agent configuration for a repository"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Get Copilot cloud agent configuration for a repository"

Statuscode	BESCHREIBUNG
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Codebeispiele für "Get Copilot cloud agent configuration for a repository"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Beispiele für Anfragen

Select the example type

get/repos/{owner}/{repo}/copilot/cloud-agent/configuration

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/copilot/cloud-agent/configuration

Default configuration

Status: 200

{
  "mcp_configuration": null,
  "enabled_tools": {
    "codeql": true,
    "copilot_code_review": true,
    "secret_scanning": true,
    "dependency_vulnerability_checks": true
  },
  "require_actions_workflow_approval": true,
  "is_firewall_enabled": true,
  "is_firewall_recommended_allowlist_enabled": true,
  "custom_allowlist": []
}