Configurations - GitHub Enterprise Server 3.16 Docs

Get code security configurations for an enterprise

Lists all code security configurations available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

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

Note

The enablement status will only be returned for installed security products.

Fine-grained access tokens for "Get code security configurations for an enterprise"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Get code security configurations for an enterprise"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`enterprise` string Required The slug version of the enterprise name.

Query parameters
Name, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`before` string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
`after` string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

HTTP response status codes for "Get code security configurations for an enterprise"

Status code	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "Get code security configurations for an enterprise"

Request example

get/enterprises/{enterprise}/code-security/configurations

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/code-security/configurations

Response

Status: 200

[
  {
    "id": 1326,
    "target_type": "enterprise",
    "name": "High risk settings",
    "description": "This is a code security configuration for octo-enterprise high risk repositories",
    "advanced_security": "enabled",
    "dependency_graph": "enabled",
    "dependabot_alerts": "enabled",
    "dependabot_security_updates": "enabled",
    "code_scanning_default_setup": "enabled",
    "code_scanning_default_setup_options": {
      "runner_type": "not_set",
      "runner_label": null
    },
    "secret_scanning": "enabled",
    "secret_scanning_push_protection": "enabled",
    "secret_scanning_validity_checks": "disabled",
    "enforcement": "enforced",
    "url": "https://HOSTNAME/enterprises/octo-enterprise/code-security/configurations/1326",
    "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit",
    "created_at": "2024-05-10T00:00:00Z",
    "updated_at": "2024-05-10T00:00:00Z"
  },
  {
    "id": 1327,
    "target_type": "enterprise",
    "name": "Low risk settings",
    "description": "This is a code security configuration for octo-enterprise low risk repositories",
    "advanced_security": "enabled",
    "dependency_graph": "enabled",
    "dependabot_alerts": "enabled",
    "dependabot_security_updates": "enabled",
    "code_scanning_default_setup": "enabled",
    "code_scanning_default_setup_options": {
      "runner_type": "not_set",
      "runner_label": null
    },
    "secret_scanning": "enabled",
    "secret_scanning_push_protection": "enabled",
    "secret_scanning_validity_checks": "disabled",
    "enforcement": "unenforced",
    "url": "https://HOSTNAME/enterprises/octo-enterprise/code-security/configurations/1327",
    "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1327/edit",
    "created_at": "2024-05-10T00:00:00Z",
    "updated_at": "2024-05-10T00:00:00Z"
  }
]

Create a code security configuration for an enterprise

Creates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

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

Note

Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.

Fine-grained access tokens for "Create a code security configuration for an enterprise"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Create a code security configuration for an enterprise"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`enterprise` string Required The slug version of the enterprise name.

Body parameters
Name, Type, Description
`name` string Required The name of the code security configuration. Must be unique within the enterprise.
`description` string Required A description of the code security configuration
`advanced_security` string The enablement status of GitHub Advanced Security Default: `disabled` Can be one of: `enabled`, `disabled`
`dependency_graph` string The enablement status of Dependency Graph. Dependency Graph is not configurable in GitHub Enterprise Server. Default: `enabled` Can be one of: `enabled`, `disabled`, `not_set`