How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Socket full-scans API

The full-scans API from Socket — 13 operation(s) for full-scans.

Socket full-scans API is one of 19 APIs that Socket publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include full-scans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 15 operations across 13 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 0.

Requests are made against a single base URL, https://api.socket.dev/v0.

15 operations 13 paths 31 schemas 1 DELETE8 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0
Server
https://api.socket.dev/v0
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Socket full-scans API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth).

  • bearerAuth — Organization Tokens can be passed as a Bearer token
  • basicAuth — Organization Tokens can be passed as the user field in basic auth

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 8 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

full-scans 15
GET
/orgs/{org_slug}/supported-files
Get supported file types
getSupportedFiles 1 param → 200400404429
POST
/alert-types
Alert Types Metadata
alertTypes 1 param body → 200400
GET
/orgs/{org_slug}/full-scans
List full scans
getOrgFullScanList 14 params → 200400401403404429
POST
/orgs/{org_slug}/full-scans
Create full scan
CreateOrgFullScan 14 params body → 201400401403404429
GET
/orgs/{org_slug}/full-scans/{full_scan_id}
Stream full scan
getOrgFullScan 7 params → 200202400401403404429
DELETE
/orgs/{org_slug}/full-scans/{full_scan_id}
Delete full scan
deleteOrgFullScan 2 params → 200400401403404429
GET
/orgs/{org_slug}/full-scans/{full_scan_id}/metadata
Get full scan metadata
getOrgFullScanMetadata 2 params → 200400401403404429
GET
/orgs/{org_slug}/full-scans/{full_scan_id}/files/tar
Download full scan files as tarball
downloadOrgFullScanFilesAsTar 2 params → 200400401403404429
POST
/orgs/{org_slug}/full-scans/archive
Create full scan from archive
CreateOrgFullScanArchive 14 params body → 201400401403404429
POST
/orgs/{org_slug}/full-scans/{full_scan_id}/rescan
Rescan full scan
rescanOrgFullScan 3 params → 201400401403404429
POST
/orgs/{org_slug}/full-scans/{full_scan_id}/format/csv
Export CSV of alerts for full scan
getOrgFullScanCsv 4 params body → 200400401403404429
POST
/orgs/{org_slug}/full-scans/{full_scan_id}/format/pdf
Generate PDF report for full scan
getOrgFullScanPdf 4 params body → 200400401403404429
GET
/orgs/{org_slug}/export/cdx/{id}
Export CycloneDX SBOM (Beta)
exportCDX 8 params → 200400401403404429
GET
/orgs/{org_slug}/export/openvex/{id}
Export OpenVEX Document (Beta)
exportOpenVEX 5 params → 200400401403404429
GET
/orgs/{org_slug}/export/spdx/{id}
Export SPDX SBOM (Beta)
exportSPDX 8 params → 200400401403404429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are CDXComponentSchema (18 properties), SocketAlert (15 properties), OpenVEXStatementSchema (13 properties), OpenVEXHashesSchema (12 properties). Each schema is shown below with its type and property counts.

OpenVEXProductSchema
object
4 properties 1 required
LicenseDetails
array
ReachabilityResult
object
2 properties 2 required
OpenVEXVulnerabilitySchema
object
4 properties 1 required
SocketScore
object
6 properties 6 required
SourceLocation
object
4 properties 4 required
SocketIssueSeverity
string
CDXManifestSchema
object
8 properties 7 required
OpenVEXStatementSchema
object
13 properties 3 required
SocketArtifactPatch
object
2 properties
OpenVEXComponentSchema
object
3 properties
SAttrib1_N
array
OpenVEXHashesSchema
object
12 properties
CDXComponentSchema
object
18 properties 6 required
CallStackItem
object
3 properties
ReachabilityResultItem
object
6 properties 1 required
SocketPURL_Type
string
Package ecosystem type identifier based on the PURL specification
ReachabilityType
string
Status of reachability analysis for vulnerable code paths
SocketId
string
SocketCategory
string
SocketPURL
object
6 properties 1 required
SocketSBOMScore
object
Mapping of supply chain risk alert types to their computed score contributions and formulas used for calculation. This allows for detailed breakdowns of how ea…
SocketArtifact
OpenVEXIdentifiersSchema
object
3 properties
SocketManifestReference
object
3 properties 1 required
SocketAlert
object
15 properties 2 required
SocketArtifactLink
object
10 properties
OpenVEXDocumentSchema
object
9 properties 6 required
SPDXManifestSchema
object
9 properties 9 required
SocketPatch
object
3 properties 2 required
ClassStackItem
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socket-dev-full-scans-api-openapi.yml Raw ↑

Other APIs Socket publishes across the network.

Socket alerts API
Socket api-tokens API
Socket audit-log API
Socket dependencies API
Socket diff-scans API
Socket fixes API
Socket license-policy API
Socket metadata API
Socket org-settings API
Socket org-snapshots API
Socket packages API
Socket repo-labels API
Where this information came from

This is an independent, third-party profile of Socket full-scans API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.