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.

Servers

Path parameters

Name Type Required Description
configuration_id Integer Yes

The unique identifier of the code security configuration.

org String Yes

The organization name. The name is not case sensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
scope String Yes

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

Possible values:

  • "public"
  • "all_without_configurations"
  • "selected"
  • "private_or_internal"
  • "all"
selected_repository_ids[] Array No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.