PUT/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults

Set a code security configuration as a default for an enterprise

Sets a code security configuration as a default to be applied to new repositories in your enterprise.

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

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.

2 parameters · 1 body field

enterprisestringrequired

The slug version of the enterprise name.

configuration_idintegerrequired

The unique identifier of the code security configuration.

default_for_new_reposstringoptional

Specify which types of repository this security configuration should be applied to by default.

Allowed:allnoneprivate_and_internalpublic

4 status codes

200Default successfully changed.

default_for_new_reposstringoptional

Specifies which types of repository this security configuration is applied to by default.

Allowed:allnoneprivate_and_internalpublic

configurationobjectoptional

A code security configuration

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed because a public default is not supported in the current environment.

messagestringrequired

documentation_urlstringrequired

errorsarray<string>optional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed because a public default is not supported in the current environment.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.defaults.update({
  enterprise: "example",
  configurationId: "c0a80123-4567-89ab-cdef-0123456789ab",
  defaultForNewRepos: "hello-world",
});

{
  "default_for_new_repos": "all",
  "configuration": {
    "value": {
      "id": 1325,
      "target_type": "organization",
      "name": "octo-org recommended settings",
      "description": "This is a code security configuration for octo-org",
      "advanced_security": "enabled",
      "dependency_graph": "enabled",
      "dependency_graph_autosubmit_action": "enabled",
      "dependency_graph_autosubmit_action_options": {
        "labeled_runners": false
      },
      "dependabot_alerts": "enabled",
      "dependabot_security_updates": "not_set",
      "code_scanning_default_setup": "disabled",
      "code_scanning_default_setup_options": {
        "runner_type": "not_set",
        "runner_label": null
      },
      "code_scanning_options": {
        "allow_advanced": false
      },
      "code_scanning_delegated_alert_dismissal": "disabled",
      "secret_scanning": "enabled",
      "secret_scanning_push_protection": "enabled",
      "secret_scanning_delegated_bypass": "enabled",
      "secret_scanning_delegated_bypass_options": {
        "reviewers": [
          {
            "security_configuration_id": 1325,
            "reviewer_id": 5678,
            "reviewer_type": "TEAM"
          }
        ]
      },
      "secret_scanning_validity_checks": "disabled",
      "secret_scanning_non_provider_patterns": "disabled",
      "secret_scanning_generic_secrets": "disabled",
      "secret_scanning_delegated_alert_dismissal": "disabled",
      "private_vulnerability_reporting": "disabled",
      "enforcement": "enforced",
      "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325",
      "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325",
      "created_at": "2024-05-01T00:00:00Z",
      "updated_at": "2024-05-01T00:00:00Z"
    }
  }
}

Request

Response

Errors