Jump to Content

Documentation API Reference

Documentation

Jump to Content

Documentation API Reference

All

Pages

Start typing to search…

Getting started
FAQ

Reachability Analysis
Ecosystem Support
Alert Types
Alert Actions
Alert Purpose Definitions
Alert Actions and Triage Functionality
Package Scores
Manifest File Detection

Organization Alerts
Dependency Search
Repositories
Scans
Security Policy (Default Enabled Alerts)
- Customizable Security Policies
License Policy
Threat Feed
Package Search
Users
Settings
- API Tokens
- Audit Log
Integrations

SCIM
SSO (Single Sign-On)
Slack alerts
Vanta integration
Webhooks

Guide to Socket for GitHub
Install the App
Ignoring pull request alerts
socket.yml
What to do when you receive an alert
GitHub App Permissions
Enable branch protection
Understanding "Act on Your Behalf" Permission

Socket for GitHub Actions
Socket for Gitlab Pipeline
Socket for Bitbucket Pipeline
Socket for Jenkins Jobs
Socket for Azure DevOps
Create Socket API Key for CI/CD

Guide to Socket CLI
- v1 Migration guide
Socket CLI Commands
Socket CLI FAQ
safe-npm FAQ
Supported Node.js Versions
socket.json

Guide to Socket MCP
Remote Socket MCP
Local Socket MCP
Socket MCP for Claude Desktop

Socket Firewall Overview
Socket Firewall Free
Socket Firewall Enterprise
Enterprise Wrapper Mode
Enterprise Proxy Service Setup
Generating Keys for Proxy Service
Enterprise Proxy Client Setup
Enterprise Configuration
Socket Firewall: Registry Mode

Guide to Socket for VS Code

Socket REST API
Socket JavaScript SDK
Socket Python SDK

Guide to Socket Chrome Extension
Extension Permissions
Deploying via Google Workspace

Join the community
Contact support

Sample Test Packages
Known issues
Incremental Rollout
Tool Configuration Files

Socket for GitHub

Enable branch protection

How to enable branch protection to make Socket a required GitHub check.

Updated 6 months ago

GitHub App Permissions

Understanding "Act on Your Behalf" Permission