SOsocket-dev
org-settings

Get Socket Basics configuration, including toggles for the various tools it supports.

Socket Basics is a CI/CD security scanning suite that runs on your source code, designed to complement Socket SCA and provide full coverage.

  • SAST - Find issues and risks with your code via static analysis using best in class Open Source tools
  • Secret Scanning - Detected potentially leaked secrets and credentials within your code
  • Container Security - Docker image and Dockerfile vulnerability scanning

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • socket-basics:read
get/orgs/{org_slug}/settings/socket-basics

Request

  • Base URL
    https://api.socket.dev/v0
  • URL
    https://api.socket.dev/v0/orgs/{org_slug}/settings/socket-basics
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

org_slugstring required

The slug of the organization

Response

Socket Basics settings

consoleTabularEnabledboolean

Enable tabular console output

consoleJsonEnabledboolean

Enable JSON console output

verboseboolean

Enable verbose logging

allLanguagesEnabledboolean

Enable all language SAST scanning

pythonSastEnabledboolean

Run Python SAST scanning

javascriptSastEnabledboolean

Run JavaScript SAST scanning

goSastEnabledboolean

Run Go SAST scanning

golangSastEnabledboolean

Run Golang SAST scanning

javaSastEnabledboolean

Run Java SAST scanning

phpSastEnabledboolean

Run PHP SAST scanning

rubySastEnabledboolean

Run Ruby SAST scanning

csharpSastEnabledboolean

Run C# SAST scanning

dotnetSastEnabledboolean

Run .NET SAST scanning

cSastEnabledboolean

Run C SAST scanning

cppSastEnabledboolean

Run C++ SAST scanning

kotlinSastEnabledboolean

Run Kotlin SAST scanning

scalaSastEnabledboolean

Run Scala SAST scanning

swiftSastEnabledboolean

Run Swift SAST scanning

rustSastEnabledboolean

Run Rust SAST scanning

elixirSastEnabledboolean

Run Elixir SAST scanning

allRulesEnabledboolean

Enable all SAST rules

pythonEnabledRulesstring

Comma-separated list of enabled Python SAST rules

pythonDisabledRulesstring

Comma-separated list of disabled Python SAST rules

javascriptEnabledRulesstring

Comma-separated list of enabled JavaScript SAST rules

javascriptDisabledRulesstring

Comma-separated list of disabled JavaScript SAST rules

goEnabledRulesstring

Comma-separated list of enabled Go SAST rules

goDisabledRulesstring

Comma-separated list of disabled Go SAST rules

javaEnabledRulesstring

Comma-separated list of enabled Java SAST rules

javaDisabledRulesstring

Comma-separated list of disabled Java SAST rules

kotlinEnabledRulesstring

Comma-separated list of enabled Kotlin SAST rules

kotlinDisabledRulesstring

Comma-separated list of disabled Kotlin SAST rules

scalaEnabledRulesstring

Comma-separated list of enabled Scala SAST rules

scalaDisabledRulesstring

Comma-separated list of disabled Scala SAST rules

phpEnabledRulesstring

Comma-separated list of enabled PHP SAST rules

phpDisabledRulesstring

Comma-separated list of disabled PHP SAST rules

rubyEnabledRulesstring

Comma-separated list of enabled Ruby SAST rules

rubyDisabledRulesstring

Comma-separated list of disabled Ruby SAST rules

csharpEnabledRulesstring

Comma-separated list of enabled C# SAST rules

csharpDisabledRulesstring

Comma-separated list of disabled C# SAST rules

dotnetEnabledRulesstring

Comma-separated list of enabled .NET SAST rules

dotnetDisabledRulesstring

Comma-separated list of disabled .NET SAST rules

cEnabledRulesstring

Comma-separated list of enabled C SAST rules

cDisabledRulesstring

Comma-separated list of disabled C SAST rules

cppEnabledRulesstring

Comma-separated list of enabled C++ SAST rules

cppDisabledRulesstring

Comma-separated list of disabled C++ SAST rules

swiftEnabledRulesstring

Comma-separated list of enabled Swift SAST rules

swiftDisabledRulesstring

Comma-separated list of disabled Swift SAST rules

rustEnabledRulesstring

Comma-separated list of enabled Rust SAST rules

rustDisabledRulesstring

Comma-separated list of disabled Rust SAST rules

elixirEnabledRulesstring

Comma-separated list of enabled Elixir SAST rules

elixirDisabledRulesstring

Comma-separated list of disabled Elixir SAST rules

openGrepNotificationMethodstring

Notification method for OpenGrep

socketTier1Enabledboolean

Enable Socket full application reachability analysis

socketAdditionalParamsstring

Additional parameters for Socket SCA

secretScanningEnabledboolean

Enable secret scanning

trufflehogExcludeDirstring

Directories to exclude from Trufflehog scanning

trufflehogShowUnverifiedboolean

Show unverified secrets in Trufflehog results

trufflehogNotificationMethodstring

Notification method for Trufflehog

containerImagesToScanstring

Comma-separated list of container images to scan

dockerfilesstring

Comma-separated list of Dockerfiles to scan

trivyImageEnabledboolean

Enable Trivy image scanning

trivyDockerfileEnabledboolean

Enable Trivy Dockerfile scanning

trivyNotificationMethodstring

Notification method for Trivy

trivyDisabledRulesstring

Comma-separated list of disabled Trivy rules

trivyImageScanningDisabledboolean

Disable Trivy image scanning

slackWebhookUrlstring

Slack webhook URL for notifications

webhookUrlstring

Generic webhook URL for notifications

msSentinelWorkspaceIdstring

Microsoft Sentinel workspace ID

msSentinelKeystring

Microsoft Sentinel key

sumologicEndpointstring

Sumo Logic endpoint URL

jiraUrlstring

Jira server URL

jiraProjectstring

Jira project key

jiraEmailstring

Jira user email

jiraApiTokenstring

Jira API token

githubTokenstring

GitHub API token

githubApiUrlstring

GitHub API URL

msteamsWebhookUrlstring

Microsoft Teams webhook URL

s3Enabledboolean

Enable S3 upload for scan results

s3Bucketstring

S3 bucket name

s3AccessKeystring

S3 access key

s3SecretKeystring

S3 secret key

s3Endpointstring

S3 endpoint URL

s3Regionstring

S3 region

externalCveScanningEnabledboolean

Enable external CVE scanning

socketScanningEnabledboolean

Enable Socket dependency scanning (legacy)

socketScaEnabledboolean

Enable Socket SCA scanning (legacy)

additionalParametersstring

Additional configuration parameters (legacy)

Changes

No recorded changes to this operation across all 2 revisions of this API.