Attach a configuration to repositories

POST

/orgs/{org}/code-security/configurations/{configuration_id}/attach

Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

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

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

configuration_id

required

integer

The unique identifier of the code security configuration.

Request Body ^required

Media type application/json

object

scope

required

The type of repositories to attach the configuration to. selected means the configuration will be attached to only the repositories specified by selected_repository_ids

string

Allowed values: all all_without_configurations public private_or_internal selected

selected_repository_ids

An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the scope is set to selected.

Array<integer>

Examples

Example default

Example for attaching a configuration to some repositories

{
  "scope": "selected",
  "selected_repository_ids": [
    32,
    91
  ]
}

Responses

202

Accepted

Media type application/json

object

Examples

Example default

null