Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

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.

Fine-grained access tokens for "Get Copilot cloud agent configuration for a repository"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Copilot agent settings" repository permissions (read)

Parameters for "Get Copilot cloud agent configuration for a repository"

Headers
Name, Type, Description
accept string

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

Path parameters
Name, Type, Description
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

HTTP response status codes for "Get Copilot cloud agent configuration for a repository"

Status codeDescription
200

OK

401

Requires authentication

403

Forbidden

404

Resource not found

500

Internal Error

Code samples for "Get Copilot cloud agent configuration for a repository"

Request examples

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": [] }