Get Copilot content exclusion rules for an organization

GET

/orgs/{org}/copilot/content_exclusion

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

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Responses

200

OK

Media type application/json

Copilot Organization Content Exclusion Details

List all Copilot Content Exclusion rules for an organization.

object

key

additional properties

Array<string>

Examples

Example default

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

401

Requires authentication

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Internal Error

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}