GitHub API (unofficial showcase)

Code Security

Endpoints to manage Code security using the REST API.

Operations

MethodEndpointDescription
GET/enterprises/{enterprise}/code-security/configurationsGet code security configurations for an enterprise
POST/enterprises/{enterprise}/code-security/configurationsCreate a code security configuration for an enterprise
GET/enterprises/{enterprise}/code-security/configurations/defaultsGet default code security configurations for an enterprise
GET/enterprises/{enterprise}/code-security/configurations/{configuration_id}Retrieve a code security configuration of an enterprise
PATCH/enterprises/{enterprise}/code-security/configurations/{configuration_id}Update a custom code security configuration for an enterprise
DELETE/enterprises/{enterprise}/code-security/configurations/{configuration_id}Delete a code security configuration for an enterprise
POST/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attachAttach an enterprise configuration to repositories
PUT/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaultsSet a code security configuration as a default for an enterprise
GET/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositoriesGet repositories associated with an enterprise code security configuration
GET/orgs/{org}/code-security/configurationsGet code security configurations for an organization
POST/orgs/{org}/code-security/configurationsCreate a code security configuration
GET/orgs/{org}/code-security/configurations/defaultsGet default code security configurations
DELETE/orgs/{org}/code-security/configurations/detachDetach configurations from repositories
GET/orgs/{org}/code-security/configurations/{configuration_id}Get a code security configuration
PATCH/orgs/{org}/code-security/configurations/{configuration_id}Update a code security configuration
DELETE/orgs/{org}/code-security/configurations/{configuration_id}Delete a code security configuration
POST/orgs/{org}/code-security/configurations/{configuration_id}/attachAttach a configuration to repositories
PUT/orgs/{org}/code-security/configurations/{configuration_id}/defaultsSet a code security configuration as a default for an organization
GET/orgs/{org}/code-security/configurations/{configuration_id}/repositoriesGet repositories associated with a code security configuration
GET/repos/{owner}/{repo}/code-security-configurationGet the code security configuration associated with a repository

Example

Get code security configurations for an enterprise, with the TypeScript SDK:

ts
import { GitHubV3REST } from "github";

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

const result = await client.codeSecurity.getConfigurationsForEnterprise({
  enterprise: "enterprise",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.