POST /enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach

Attaches an enterprise code security configuration to 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 for the enterprise to use this endpoint.

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

Servers

Path parameters

Name Type Required Description
configuration_id Integer Yes

The unique identifier of the code security configuration.

enterprise String Yes

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

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.

Possible values:

  • "all_without_configurations"
  • "all"

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.