For AI agents: visit https://docs.socket.dev/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Documentation API Reference

Documentation

Jump to Content

Documentation API Reference

Getting started
FAQ

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

Organization Alerts
Dependency Search
Repositories
Scans
Cool-down policy (recently published packages)
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
Jira Integration
Linear Integration

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

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 Dashboard
Security Policy (Default Enabled Alerts)

Customizable Security Policies