code-security

Get a code security configuration

Changed on

Gets a code security configuration available in an organization.

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.

get/orgs/{org}/code-security/configurations/{configuration_id}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

configuration_idinteger required

The unique identifier of the code security configuration.

Response

Response

idinteger

The ID of the code security configuration

namestring

The name of the code security configuration. Must be unique within the organization.

target_type'global' | 'organization' | 'enterprise'

The type of the code security configuration.

descriptionstring nullable

A description of the code security configuration

advanced_security'enabled' | 'disabled' | 'code_security' | 'secret_protection'

The enablement status of GitHub Advanced Security

dependency_graph'enabled' | 'disabled' | 'not_set'

The enablement status of Dependency Graph

dependency_graph_autosubmit_action'enabled' | 'disabled' | 'not_set'

The enablement status of Automatic dependency submission

dependabot_alerts'enabled' | 'disabled' | 'not_set'

The enablement status of Dependabot alerts

dependabot_security_updates'enabled' | 'disabled' | 'not_set'

The enablement status of Dependabot security updates

dependabot_delegated_alert_dismissal'enabled' | 'disabled' | 'not_set' nullable

The enablement status of Dependabot delegated alert dismissal

code_scanning_default_setup'enabled' | 'disabled' | 'not_set'

The enablement status of code scanning default setup

code_scanning_delegated_alert_dismissal'enabled' | 'disabled' | 'not_set'

The enablement status of code scanning delegated alert dismissal

secret_scanning'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning

secret_scanning_push_protection'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning push protection

secret_scanning_delegated_bypass'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning delegated bypass

secret_scanning_validity_checks'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning validity checks

secret_scanning_non_provider_patterns'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning non-provider patterns

secret_scanning_generic_secrets'enabled' | 'disabled' | 'not_set'

The enablement status of Copilot secret scanning

secret_scanning_delegated_alert_dismissal'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning delegated alert dismissal

secret_scanning_extended_metadata'enabled' | 'disabled' | 'not_set'

The enablement status of secret scanning extended metadata

private_vulnerability_reporting'enabled' | 'disabled' | 'not_set'

The enablement status of private vulnerability reporting

enforcement'enforced' | 'unenforced' | 'enterprise_enforced'

The enforcement status for a security configuration

urlstring uri

The URL of the configuration

html_urlstring uri

The URL of the configuration

created_atstring date-time
updated_atstring date-time

Changes

  • 2022-11-28a2954a79ff13Revision changes
    • warning

      added the new enterprise_enforced enum value to the response property for the response status

  • 2022-11-28bf794926a84dRevision changes
    • breaking

      the response property became nullable for the status