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

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.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

ownerstringrequired

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

repostringrequired

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

5 status codes

200Response

mcp_configurationobjectrequired

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.

enabled_toolsobjectrequired

The enabled review tools for Copilot cloud agent.

require_actions_workflow_approvalbooleanrequired

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

is_firewall_enabledbooleanrequired

Whether the firewall is enabled.

is_firewall_recommended_allowlist_enabledbooleanrequired

Whether the firewall recommended allowlist is enabled.

custom_allowlistarray<string>required

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

is_automations_enabledbooleanrequired

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_triggersbooleanrequired

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.

401Requires authentication

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

500Internal Error

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 500 is returned: Internal Error.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.configuration.list({
  owner: "octocat",
  repo: "hello-world",
});

{
  "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": [],
  "is_automations_enabled": true,
  "require_write_access_for_automation_triggers": true
}

Request

Response

Errors