REST API endpoints for Copilot content exclusion management

Get Copilot content exclusion rules for an enterprise

Note

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

Gets information about an enterprise's Copilot content exclusion path rules. To configure these settings, go to the enterprise's settings on GitHub. For more information, see "Excluding content from GitHub Copilot."

Enterprise owners can view details about Copilot content exclusion rules for the enterprise.

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

Caution

At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.

Fine-grained access tokens for "Get Copilot content exclusion rules for an enterprise"

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

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

"Enterprise AI controls" enterprise permissions (read)

Parameters for "Get Copilot content exclusion rules for an enterprise"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`enterprise` string Required The slug version of the enterprise name.

HTTP response status codes for "Get Copilot content exclusion rules for an enterprise"

Status code	Description
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Code samples for "Get Copilot content exclusion rules for an enterprise"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

get/enterprises/{enterprise}/copilot/content_exclusion

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/copilot/content_exclusion

OK

Status: 200

{
  "git@github.com:*/copilot": [
    "/__tests__/**"
  ],
  "octo-org/octo-repo": [
    "/src/some-dir/kernel.rs"
  ]
}

Set Copilot content exclusion rules for an enterprise

Note

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

Sets Copilot content exclusion path rules for an enterprise. To configure these settings, go to the enterprise's settings on GitHub. For more information, see "Excluding content from GitHub Copilot."

Enterprise owners can set Copilot content exclusion rules for the enterprise.

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

Caution

At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.

Fine-grained access tokens for "Set Copilot content exclusion rules for an enterprise"

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

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

"Enterprise AI controls" enterprise permissions (write)

Parameters for "Set Copilot content exclusion rules for an enterprise"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`enterprise` string Required The slug version of the enterprise name.

HTTP response status codes for "Set Copilot content exclusion rules for an enterprise"

Status code	Description
`200`	Success
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`413`	Payload Too Large
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Code samples for "Set Copilot content exclusion rules for an enterprise"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

put/enterprises/{enterprise}/copilot/content_exclusion

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/copilot/content_exclusion \
  -d '{"git@github.com:*/copilot":["/__tests__/**"],"octo-org/octo-repo":["/src/some-dir/kernel.rs"]}'

Success

Status: 200

{
  "message": "Content exclusion rules updated successfully."
}

Get Copilot content exclusion rules for an organization

Note

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

Gets information about an organization's Copilot content exclusion path rules. To configure these settings, go to the organization's settings on GitHub. For more information, see "Excluding content from GitHub Copilot."

Organization owners can view details about Copilot content exclusion rules for the organization.

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

Caution

At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.

Fine-grained access tokens for "Get Copilot content exclusion rules for an organization"

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

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

"Copilot content exclusion" organization permissions (read)

Parameters for "Get Copilot content exclusion rules for an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

HTTP response status codes for "Get Copilot content exclusion rules for an organization"

Status code	Description
`200`	OK
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Code samples for "Get Copilot content exclusion rules for an organization"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

get/orgs/{org}/copilot/content_exclusion

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/copilot/content_exclusion

OK

Status: 200

{
  "octo-repo": [
    "/src/some-dir/kernel.rs"
  ]
}

Set Copilot content exclusion rules for an organization

Note

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

Sets Copilot content exclusion path rules for an organization. To configure these settings, go to the organization's settings on GitHub. For more information, see "Excluding content from GitHub Copilot."

Organization owners can set Copilot content exclusion rules for the organization.

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

Caution

At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.

Fine-grained access tokens for "Set Copilot content exclusion rules for an organization"

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

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

"Copilot content exclusion" organization permissions (write)

Parameters for "Set Copilot content exclusion rules for an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

HTTP response status codes for "Set Copilot content exclusion rules for an organization"

Status code	Description
`200`	Success
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`413`	Payload Too Large
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Code samples for "Set Copilot content exclusion rules for an organization"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Request example

put/orgs/{org}/copilot/content_exclusion

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/copilot/content_exclusion \
  -d '{"octo-repo":["/src/some-dir/kernel.rs"]}'

Success

Status: 200

{
  "message": "Content exclusion rules updated successfully."
}