Skip to content
CrowdStrike Developer Center

Code Security

Operations for the Code Security service collection.

LanguageLast Update
Pythonv1.6.6
PowerShell
Go
TypeScript
Rust
Ruby

Table of Contents

Section titled “Table of Contents”
OperationDescription
CreateBranchConfig
create_branch_config		Create a new branch config
CreateExclusionRule
create_scm_exclusion_rule		Create an exclusion rule
DeleteBranchConfig
delete_branch_config		Delete a branch config, or exclude a specific repository from a connection-level config when repository_id query param is provided
DeleteExclusionRule
delete_scm_exclusion_rule		Delete an exclusion rule
DeleteSCMConnection
delete_scm_connection		Delete an SCM connection
ExchangeGitHubAppCode
exchange_github_app_code		Exchange a GitHub App manifest code or complete registration after installation
GetBranchConfig
get_branch_config		Get branch config for a connection or repository
GetSCMConnection
get_scm_connection		Get an SCM connection by UUID
GetSCMRepositoryAggregates
get_scm_repository_aggregates		Get distinct values with counts for a repository field
ListExclusionRules
list_scm_exclusion_rules		List exclusion rules for a connection
ListSCMConnections
list_scm_connections		List SCM connections for a customer
ListSCMRepositories
list_scm_repositories		List discovered SCM repositories for a customer
RegisterSCMApp
register_scm_app		Register a GitHub App via the wizard flow
TriggerSCMSync
trigger_scm_sync		Trigger an immediate sync for a connection
UpdateBranchConfig
update_branch_config		Update an existing branch config

CreateBranchConfig

Section titled “CreateBranchConfig”

Create a new branch config

Method POST
Route /scm-integration/entities/branch-configs/v1
Scope Code Security Scm Integration: WRITE
PEP 8 create_branch_config
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.create_branch_config()
print(response)
Responses
{}

CreateExclusionRule

Section titled “CreateExclusionRule”

Create an exclusion rule

Method POST
Route /scm-integration/entities/exclusions/v1
Scope Code Security Scm Integration: WRITE
PEP 8 create_scm_exclusion_rule
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.create_scm_exclusion_rule()
print(response)
Responses
{}

DeleteBranchConfig

Section titled “DeleteBranchConfig”

Delete a branch config, or exclude a specific repository from a connection-level config when repository_id query param is provided

Method DELETE
Route /scm-integration/entities/branch-configs/v1
Scope Code Security Scm Integration: WRITE
PEP 8 delete_branch_config

Parameters

Section titled “Parameters”
ids query · string
Branch config UUID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']


response = falcon.delete_branch_config(ids=id_list)
print(response)
Responses
{}

DeleteExclusionRule

Section titled “DeleteExclusionRule”

Delete an exclusion rule

Method DELETE
Route /scm-integration/entities/exclusions/v1/{id}
Scope Code Security Scm Integration: WRITE
PEP 8 delete_scm_exclusion_rule

Parameters

Section titled “Parameters”
id path · string
Exclusion rule UUID
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.delete_scm_exclusion_rule(id="string")
print(response)
Responses
{}

DeleteSCMConnection

Section titled “DeleteSCMConnection”

Delete an SCM connection

Method DELETE
Route /scm-integration/entities/connections/v1/{uuid}
Scope Code Security Scm Integration: WRITE
PEP 8 delete_scm_connection

Parameters

Section titled “Parameters”
uuid path · string
Connection UUID
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.delete_scm_connection(uuid="string")
print(response)
Responses
{}

ExchangeGitHubAppCode

Section titled “ExchangeGitHubAppCode”

Exchange a GitHub App manifest code or complete registration after installation

Method POST
Route /scm-integration/github-apps/exchange/v1
Scope Code Security Scm Integration: WRITE
PEP 8 exchange_github_app_code

Parameters

Section titled “Parameters”
body body · dictionary
Full body payload as JSON formatted dictionary.
code body · string
The code value.
installation_id body · string
The installation_id value.
org body · string
The org value.
state body · string
The state value.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.exchange_github_app_code(code="string",
                                           installation_id="string",
                                           org="string",
                                           state="string")
print(response)
Responses
{}

GetBranchConfig

Section titled “GetBranchConfig”

Get branch config for a connection or repository

Method GET
Route /scm-integration/entities/branch-configs/v1
Scope Code Security Scm Integration: READ
PEP 8 get_branch_config

Parameters

Section titled “Parameters”
connection_id query · string
Connection UUID
repository_ids query · string
Comma-separated Repository UUIDs (optional, for per-repo or bulk query)
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.get_branch_config(connection_id="string",
                                    repository_ids="string")
print(response)
Responses
[
  {
    "connection_id": "string",
    "created_at": "string",
    "id": "string",
    "mode": "string",
    "patterns": [],
    "repository_id": "string",
    "updated_at": "string"
  }
]

GetSCMConnection

Section titled “GetSCMConnection”

Get an SCM connection by UUID

Method GET
Route /scm-integration/entities/connections/v1/{uuid}
Scope Code Security Scm Integration: READ
PEP 8 get_scm_connection

Parameters

Section titled “Parameters”
uuid path · string
Connection UUID
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.get_scm_connection(uuid="string")
print(response)
Responses
{}

GetSCMRepositoryAggregates

Section titled “GetSCMRepositoryAggregates”

Get distinct values with counts for a repository field

Method GET
Route /scm-integration/aggregates/repositories/values-by-field/v1
Scope Code Security Scm Inventory: READ
PEP 8 get_scm_repository_aggregates

Parameters

Section titled “Parameters”
field query · string
Field to aggregate: name, primary_language, visibility, artifact_types, topics, owner_org, default_branch
filter query · string
FQL filter expression to scope aggregation
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.get_scm_repository_aggregates(field="string", filter="string")
print(response)
Responses
{}

ListExclusionRules

Section titled “ListExclusionRules”

List exclusion rules for a connection

Method GET
Route /scm-integration/entities/exclusions/v1
Scope Code Security Scm Integration: READ
PEP 8 list_scm_exclusion_rules

Parameters

Section titled “Parameters”
connection_id query · string
Connection UUID to list rules for
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.list_scm_exclusion_rules(connection_id="string")
print(response)
Responses
{}

ListSCMConnections

Section titled “ListSCMConnections”

List SCM connections for a customer

Method GET
Route /scm-integration/entities/connections/v1
Scope Code Security Scm Integration: READ
PEP 8 list_scm_connections

Parameters

Section titled “Parameters”
provider query · string
Filter by provider (github, gitlab, azure_devops)
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.list_scm_connections(provider="string")
print(response)
Responses
{}

ListSCMRepositories

Section titled “ListSCMRepositories”

List discovered SCM repositories for a customer

Method GET
Route /scm-integration/entities/repositories/v1
Scope Code Security Scm Inventory: READ
PEP 8 list_scm_repositories

Parameters

Section titled “Parameters”
filter query · string
FQL filter expression
sort query · string
Sort field and direction in field.direction format (e.g. name.asc, created_date.desc)
limit query · integer
Maximum records to return (default 100, max 500)
offset query · integer
Starting offset for pagination
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.list_scm_repositories(filter="string",
                                        sort="string",
                                        limit=integer,
                                        offset=integer)
print(response)
Responses
{}

RegisterSCMApp

Section titled “RegisterSCMApp”

Register a GitHub App via the wizard flow

Method POST
Route /scm-integration/registrations
Scope Code Security Scm Integration: WRITE
PEP 8 register_scm_app

Parameters

Section titled “Parameters”
body body · dictionary
Full body payload as JSON formatted dictionary.
app_id body · string
The app_id value.
installation_id body · string
The installation_id value.
org body · string
The org value.
private_key body · string
The private_key value.
webhook_secret body · string
The webhook_secret value.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.register_scm_app(app_id="string",
                                   installation_id="string",
                                   org="string",
                                   private_key="string",
                                   webhook_secret="string")
print(response)
Responses
{}

TriggerSCMSync

Section titled “TriggerSCMSync”

Trigger an immediate sync for a connection

Method POST
Route /scm-integration/entities/connections/v1/{uuid}/sync
Scope Code Security Scm Integration: WRITE
PEP 8 trigger_scm_sync

Parameters

Section titled “Parameters”
uuid path · string
Connection UUID
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.trigger_scm_sync(uuid="string")
print(response)
Responses
{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": {}
}

UpdateBranchConfig

Section titled “UpdateBranchConfig”

Update an existing branch config

Method PATCH
Route /scm-integration/entities/branch-configs/v1
Scope Code Security Scm Integration: WRITE
PEP 8 update_branch_config

Parameters

Section titled “Parameters”
id query · string
Branch config UUID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import CodeSecurity


falcon = CodeSecurity(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )


response = falcon.update_branch_config(id="string")
print(response)
Responses
{}
© 2026 CrowdStrike, Inc. All rights reserved. Privacy Notice Cookie Notice Terms of Use