copilot

Get Copilot cloud agent configuration for a repository

Changed on

[!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.

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/copilot/cloud-agent/configuration
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

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

Response

Response

mcp_configurationobject nullable required

The user-supplied MCP server configuration for the repository, as a free-form JSON object. This will be set to null if no configuration has been set.

The shape of a valid MCP configuration may evolve over time, so this property is intentionally not strictly typed. Clients should not assume a fixed schema.

require_actions_workflow_approvalboolean required

Whether Actions workflow approval is required for Copilot cloud agent pull requests.

is_firewall_enabledboolean required

Whether the firewall is enabled.

is_firewall_recommended_allowlist_enabledboolean required

Whether the firewall recommended allowlist is enabled.

custom_allowliststring[] required

A list of custom allowlist entries, as hosts or URLs, that the firewall will allow the Copilot cloud agent to access.

is_automations_enabledboolean required

Whether automations are enabled in this repository. When true, users can create automations that automatically run agents on a schedule or in response to events like new issues or updated pull requests.

require_write_access_for_automation_triggersboolean required

Whether write access is required for automation triggers. When true, automations will only run if the user triggering the event has write access to the repository. When false, users can create automations that listen for events triggered by users without write access.

Changes

  • 2022-11-2837bb7bcfab4bRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2022-11-2878c4b7d08f97Revision changes
    • info

      endpoint added