PUT/enterprises/{enterprise}/copilot/policies/coding_agent

Set the coding agent policy for an enterprise

Sets the policy for Copilot cloud agent usage across an enterprise.

Enterprise owners can configure whether Copilot cloud agent is enabled for all organizations, disabled for all organizations, configured by individual organization admins, or enabled for selected organizations only.

Only enterprise owners can set the coding agent policy for their enterprise.

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

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

1 parameter · 1 body field

enterprisestringrequired

The slug version of the enterprise name.

The coding agent policy configuration

policy_statestringrequired

The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.

Allowed:enabled_for_all_orgsdisabled_for_all_orgsenabled_for_selected_orgsconfigured_by_org_admins

2 status codes

204A header with no content is returned.

400Bad Request

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 400 is returned: Bad Request.

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.codingAgent.update({
  enterprise: "example",
  policyState: "example",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors