Skip to content
forgit api docs

Set Copilot content exclusion rules for an organization

PUT
/orgs/{org}/copilot/content_exclusion

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

API method documentation

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

The organization name. The name is not case sensitive.

Request Bodyrequired

Section titled “Request Bodyrequired”

The content exclusion rules to set

Media typeapplication/json
object
key
additional properties
Array
Any of:

The path to the file that will be excluded.

string
Examples
Exampledefault

Example of content exclusion paths

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

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
message
string
Examples
Exampledefault
{
  "message": "Content exclusion rules updated successfully."
}

401

Section titled “401”

Requires authentication

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “404”

Resource not found

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

413

Section titled “413”

Payload Too Large

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “422”

Validation failed, or the endpoint has been spammed.

Media typeapplication/json
Validation Error Simple

Validation Error Simple

object
message
required
string
documentation_url
required
string
errors
Array<string>
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    "example"
  ]
}

500

Section titled “500”

Internal Error

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}