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

Attach a configuration to repositories

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.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 2 body fields

orgstringrequired

The organization name. The name is not case sensitive.

configuration_idintegerrequired

The unique identifier of the code security configuration.

scopestringrequired

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`

Allowed:allall_without_configurationspublicprivate_or_internalselected

selected_repository_idsarray<integer>optional

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`.

1 status code

202Accepted

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.attach.create({
  org: "acme-inc",
  configurationId: "c0a80123-4567-89ab-cdef-0123456789ab",
  scope: "example",
  selectedRepositoryIds: "hello-world",
});

{}