@socketsecurity/sdk 3.2.0 → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types/api.d.ts CHANGED
@@ -7,7 +7,10 @@ export interface paths {
7
7
  '/purl': {
8
8
  /**
9
9
  * Get Packages by PURL
10
- * @description Batch retrieval of package metadata and alerts by PURL strings. Compatible witch CycloneDX reports.
10
+ * @deprecated
11
+ * @description **This endpoint is deprecated.** Deprecated since 2026-01-05.
12
+ *
13
+ * Batch retrieval of package metadata and alerts by PURL strings. Compatible with CycloneDX reports.
11
14
  *
12
15
  * Package URLs (PURLs) are an ecosystem agnostic way to identify packages.
13
16
  * CycloneDX SBOMs use the purl format to identify components.
@@ -135,7 +138,7 @@ export interface paths {
135
138
  *
136
139
  * To get a list of supported filetypes that can be uploaded in a full-scan, see the [Get supported file types](/reference/getsupportedfiles) endpoint.
137
140
  *
138
- * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
141
+ * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 268 MB.
139
142
  *
140
143
  * **Query Parameters:**
141
144
  * - `scan_type` (optional): The type of scan to perform. Defaults to 'socket'. Must be 32 characters or less. Used for categorizing multiple SBOM heads per repository branch.
@@ -233,7 +236,7 @@ export interface paths {
233
236
  *
234
237
  * Each uploaded archive is extracted server-side and any supported manifest files (like package.json, package-lock.json, pnpm-lock.yaml, etc.) are ingested for the scan. If you upload multiple archives in a single request, the manifests from every archive are merged into one full scan. The response includes any files that were ignored.
235
238
  *
236
- * The maximum combined number of files extracted from your upload is 5000 and each extracted file can be no bigger than 67 MB.
239
+ * The maximum combined number of files extracted from your upload is 5000 and each extracted file can be no bigger than 268 MB.
237
240
  *
238
241
  * This endpoint consumes 1 unit of your quota.
239
242
  *
@@ -242,6 +245,68 @@ export interface paths {
242
245
  */
243
246
  post: operations['CreateOrgFullScanArchive']
244
247
  }
248
+ '/orgs/{org_slug}/full-scans/{full_scan_id}/rescan': {
249
+ /**
250
+ * Rescan full scan
251
+ * @description Create a new full scan by rescanning an existing scan. A "shallow" rescan reapplies the latest policies to the previously cached dependency resolution results. A "deep" rescan reruns dependency resolution and applies the latest policies to the results.
252
+ *
253
+ * This endpoint consumes 1 unit of your quota.
254
+ *
255
+ * This endpoint requires the following org token scopes:
256
+ * - full-scans:create
257
+ */
258
+ post: operations['rescanOrgFullScan']
259
+ }
260
+ '/orgs/{org_slug}/full-scans/{full_scan_id}/format/csv': {
261
+ /**
262
+ * Export CSV of alerts for full scan
263
+ * @description Export a CSV file containing all alerts from a full scan.
264
+ *
265
+ * The CSV includes details about each alert and the affected packages.
266
+ * You can optionally filter using the request body "filters" array. Supported filter IDs include:
267
+ * - alert.action (error|warn|monitor|ignore)
268
+ * - alert.type
269
+ * - alert.category
270
+ * - alert.severity (low|medium|middle|high|critical or 0-3)
271
+ * - artifact.type (purl type, e.g. npm, pypi)
272
+ * - dependency.type (direct|transitive)
273
+ * - dependency.scope (dev|normal)
274
+ * - dependency.usage (used|unused)
275
+ * - manifest.file
276
+ *
277
+ * This endpoint consumes 1 unit of your quota.
278
+ *
279
+ * This endpoint requires the following org token scopes:
280
+ * - full-scans:list
281
+ */
282
+ post: operations['getOrgFullScanCsv']
283
+ }
284
+ '/orgs/{org_slug}/full-scans/{full_scan_id}/format/pdf': {
285
+ /**
286
+ * Generate PDF report for full scan
287
+ * @description Generate a PDF report for all alerts in a full scan.
288
+ *
289
+ * This endpoint streams a PDF document containing all alerts found in the full scan,
290
+ * with optional filtering and grouping options.
291
+ *
292
+ * Supported request body filter IDs include:
293
+ * - alert.action (error|warn|monitor|ignore)
294
+ * - alert.type
295
+ * - alert.category
296
+ * - alert.severity (low|medium|middle|high|critical or 0-3)
297
+ * - artifact.type (purl type, e.g. npm, pypi)
298
+ * - dependency.type (direct|transitive)
299
+ * - dependency.scope (dev|normal)
300
+ * - dependency.usage (used|unused)
301
+ * - manifest.file
302
+ *
303
+ * This endpoint consumes 1 unit of your quota.
304
+ *
305
+ * This endpoint requires the following org token scopes:
306
+ * - full-scans:list
307
+ */
308
+ post: operations['getOrgFullScanPdf']
309
+ }
245
310
  '/orgs/{org_slug}/export/cdx/{id}': {
246
311
  /**
247
312
  * Export CycloneDX SBOM (Beta)
@@ -268,6 +333,31 @@ export interface paths {
268
333
  */
269
334
  get: operations['exportCDX']
270
335
  }
336
+ '/orgs/{org_slug}/export/openvex/{id}': {
337
+ /**
338
+ * Export OpenVEX Document (Beta)
339
+ * @description Export vulnerability exploitability data as an OpenVEX v0.2.0 document.
340
+ *
341
+ * OpenVEX (Vulnerability Exploitability eXchange) documents communicate the
342
+ * exploitability status of vulnerabilities in software products. This export
343
+ * includes:
344
+ *
345
+ * - **Patch data**: Vulnerabilities fixed by applied Socket patches are marked as "fixed"
346
+ * - **Reachability analysis**: Code reachability determines if vulnerable code is exploitable:
347
+ * - Unreachable code → "not_affected" with justification
348
+ * - Reachable code → "affected"
349
+ * - Unknown/pending → "under_investigation"
350
+ *
351
+ * Each statement in the document represents a single artifact-vulnerability pair
352
+ * for granular reachability information.
353
+ *
354
+ * This endpoint consumes 1 unit of your quota.
355
+ *
356
+ * This endpoint requires the following org token scopes:
357
+ * - report:read
358
+ */
359
+ get: operations['exportOpenVEX']
360
+ }
271
361
  '/orgs/{org_slug}/export/spdx/{id}': {
272
362
  /**
273
363
  * Export SPDX SBOM (Beta)
@@ -347,7 +437,7 @@ export interface paths {
347
437
  * Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
348
438
  * the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
349
439
  *
350
- * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
440
+ * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 268 MB.
351
441
  *
352
442
  * This endpoint consumes 1 unit of your quota.
353
443
  *
@@ -386,7 +476,7 @@ export interface paths {
386
476
  get: operations['getOrgTriage']
387
477
  /**
388
478
  * Update Org Alert Triage
389
- * @description Update triage actions on organizaton alerts.
479
+ * @description Update triage actions on organization alerts.
390
480
  *
391
481
  * This endpoint consumes 1 unit of your quota.
392
482
  *
@@ -395,6 +485,18 @@ export interface paths {
395
485
  */
396
486
  post: operations['updateOrgAlertTriage']
397
487
  }
488
+ '/orgs/{org_slug}/triage/alerts/{uuid}': {
489
+ /**
490
+ * Delete Org Alert Triage
491
+ * @description Delete a specific triage rule by UUID.
492
+ *
493
+ * This endpoint consumes 1 unit of your quota.
494
+ *
495
+ * This endpoint requires the following org token scopes:
496
+ * - triage:alerts-update
497
+ */
498
+ delete: operations['deleteOrgAlertTriage']
499
+ }
398
500
  '/orgs/{org_slug}/repos': {
399
501
  /**
400
502
  * List repositories
@@ -931,6 +1033,107 @@ export interface paths {
931
1033
  */
932
1034
  get: operations['getOrgThreatFeedItems']
933
1035
  }
1036
+ '/orgs/{org_slug}/purl': {
1037
+ /**
1038
+ * Get Packages by PURL (Org Scoped)
1039
+ * @description Batch retrieval of package metadata and alerts by PURL strings for a specific organization. Compatible with CycloneDX reports.
1040
+ *
1041
+ * Package URLs (PURLs) are an ecosystem agnostic way to identify packages.
1042
+ * CycloneDX SBOMs use the purl format to identify components.
1043
+ * This endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.
1044
+ *
1045
+ * **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
1046
+ *
1047
+ * More information on purl and CycloneDX:
1048
+ *
1049
+ * - [`purl` Spec](https://github.com/package-url/purl-spec)
1050
+ * - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
1051
+ *
1052
+ * This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
1053
+ * Actively running analysis will be returned when available on subsequent runs.
1054
+ *
1055
+ * ## Query Parameters
1056
+ *
1057
+ * This endpoint supports all query parameters from `POST /v0/purl` including: `alerts`, `actions`, `compact`, `fixable`, `licenseattrib`, `licensedetails`, `purlErrors`, `cachedResultsOnly`, and `summary`.
1058
+ *
1059
+ * Additionally, you may provide a `labels` query parameter to apply a repository label's security policies. Pass the label slug as the value (e.g., `?labels=production`). Only one label is currently supported.
1060
+ *
1061
+ * ## Examples:
1062
+ *
1063
+ * ### Looking up an npm package:
1064
+ *
1065
+ * ```json
1066
+ * {
1067
+ * "components": [
1068
+ * {
1069
+ * "purl": "pkg:npm/express@4.19.2"
1070
+ * }
1071
+ * ]
1072
+ * }
1073
+ * ```
1074
+ *
1075
+ * ### Looking up a PyPi package:
1076
+ *
1077
+ * ```json
1078
+ * {
1079
+ * "components": [
1080
+ * {
1081
+ * "purl": "pkg:pypi/django@5.0.6"
1082
+ * }
1083
+ * ]
1084
+ * }
1085
+ * ```
1086
+ *
1087
+ * ### Looking up a Maven package:
1088
+ *
1089
+ * ```json
1090
+ * {
1091
+ * "components": [
1092
+ * {
1093
+ * "purl": "pkg:maven/log4j/log4j@1.2.17"
1094
+ * }
1095
+ * ]
1096
+ * }
1097
+ * ```
1098
+ *
1099
+ * ### Batch lookup
1100
+ *
1101
+ * ```json
1102
+ * {
1103
+ * "components": [
1104
+ * {
1105
+ * "purl": "pkg:npm/express@4.19.2"
1106
+ * },
1107
+ * {
1108
+ * "purl": "pkg:pypi/django@5.0.6"
1109
+ * },
1110
+ * {
1111
+ * "purl": "pkg:maven/log4j/log4j@1.2.17"
1112
+ * }
1113
+ * ]
1114
+ * }
1115
+ * ```
1116
+ *
1117
+ * ### With label and options (query parameters):
1118
+ *
1119
+ * ```
1120
+ * POST /v0/orgs/{org_slug}/purl?labels=production&alerts=true&compact=true
1121
+ * {
1122
+ * "components": [
1123
+ * {
1124
+ * "purl": "pkg:npm/express@4.19.2"
1125
+ * }
1126
+ * ]
1127
+ * }
1128
+ * ```
1129
+ *
1130
+ * This endpoint consumes 100 units of your quota.
1131
+ *
1132
+ * This endpoint requires the following org token scopes:
1133
+ * - packages:list
1134
+ */
1135
+ post: operations['batchPackageFetchByOrg']
1136
+ }
934
1137
  '/orgs/{org_slug}/fixes': {
935
1138
  /**
936
1139
  * Fetch fixes for vulnerabilities in a repository or scan
@@ -938,6 +1141,57 @@ export interface paths {
938
1141
  * Requires either repo_slug or full_scan_id as well as vulnerability_ids to be provided.
939
1142
  * vulnerability_ids can be a comma-separated list of GHSA or CVE IDs, or "*" for all vulnerabilities.
940
1143
  *
1144
+ * ## Response Structure
1145
+ *
1146
+ * The response contains a `fixDetails` object where each key is a vulnerability ID (GHSA or CVE) and the value is a discriminated union based on the `type` field.
1147
+ *
1148
+ * ### Common Fields
1149
+ *
1150
+ * All response variants include:
1151
+ * - `type`: Discriminator field (one of: "fixFound", "partialFixFound", "noFixAvailable", "fixNotApplicable", "errorComputingFix")
1152
+ * - `value`: Object containing the variant-specific data
1153
+ *
1154
+ * The `value` object always contains:
1155
+ * - `ghsa`: string | null - The GHSA ID
1156
+ * - `cve`: string | null - The CVE ID (if available)
1157
+ * - `advisoryDetails`: object | null - Advisory details (only if include_details=true)
1158
+ *
1159
+ * ### Response Variants
1160
+ *
1161
+ * **fixFound**: A complete fix is available for all vulnerable packages
1162
+ * - `value.fixDetails.fixes`: Array of fix objects, each containing:
1163
+ * - `purl`: Package URL to upgrade
1164
+ * - `fixedVersion`: Version to upgrade to
1165
+ * - `manifestFiles`: Array of manifest files containing the package
1166
+ * - `updateType`: "patch" | "minor" | "major" | "unknown"
1167
+ * - `value.fixDetails.responsibleDirectDependencies`: (optional) Map of direct dependencies responsible for the vulnerability
1168
+ *
1169
+ * **partialFixFound**: Fixes available for some but not all vulnerable packages
1170
+ * - Same as fixFound, plus:
1171
+ * - `value.fixDetails.unfixablePurls`: Array of packages that cannot be fixed, each containing:
1172
+ * - `purl`: Package URL
1173
+ * - `manifestFiles`: Array of manifest files
1174
+ *
1175
+ * **noFixAvailable**: No fix exists for this vulnerability (no patched version published)
1176
+ *
1177
+ * **fixNotApplicable**: A fix exists but cannot be applied due to version constraints
1178
+ * - `value.vulnerableArtifacts`: Array of vulnerable packages with their manifest files
1179
+ *
1180
+ * **errorComputingFix**: An error occurred while computing fixes
1181
+ * - `value.message`: Error description
1182
+ *
1183
+ * ### Advisory Details (when include_details=true)
1184
+ *
1185
+ * - `title`: string | null
1186
+ * - `description`: string | null
1187
+ * - `cwes`: string[] - CWE identifiers
1188
+ * - `severity`: "LOW" | "MODERATE" | "HIGH" | "CRITICAL"
1189
+ * - `cvssVector`: string | null
1190
+ * - `publishedAt`: string (ISO date)
1191
+ * - `kev`: boolean - Whether it's a Known Exploited Vulnerability
1192
+ * - `epss`: number | null - Exploit Prediction Scoring System score
1193
+ * - `affectedPurls`: Array of affected packages with version ranges
1194
+ *
941
1195
  * This endpoint consumes 10 units of your quota.
942
1196
  *
943
1197
  * This endpoint requires the following org token scopes:
@@ -1032,6 +1286,18 @@ export interface paths {
1032
1286
  */
1033
1287
  get: operations['alertsList']
1034
1288
  }
1289
+ '/orgs/{org_slug}/alert-full-scan-search': {
1290
+ /**
1291
+ * List full scans associated with alert (Beta)
1292
+ * @description List full scans associated with alert.
1293
+ *
1294
+ * This endpoint consumes 10 units of your quota.
1295
+ *
1296
+ * This endpoint requires the following org token scopes:
1297
+ * - alerts:list
1298
+ */
1299
+ get: operations['alertFullScans']
1300
+ }
1035
1301
  '/license-policy': {
1036
1302
  /**
1037
1303
  * License Policy (Beta)
@@ -1638,7 +1904,7 @@ export interface components {
1638
1904
  _type: 'summary'
1639
1905
  value: components['schemas']['PurlSummarySchema']
1640
1906
  }
1641
- SocketBatchPURLFetch: {
1907
+ SocketOrgBatchPURLFetch: {
1642
1908
  components: Array<components['schemas']['SocketBatchPURLRequest']>
1643
1909
  }
1644
1910
  SocketArtifact: components['schemas']['SocketPURL'] &
@@ -1745,10 +2011,10 @@ export interface components {
1745
2011
  dependsOn?: string[]
1746
2012
  }>
1747
2013
  vulnerabilities?: Array<{
1748
- /** @default */
1749
- ref: string
1750
2014
  /** @default */
1751
2015
  id: string
2016
+ /** @default */
2017
+ ref?: string
1752
2018
  source?: {
1753
2019
  /** @default */
1754
2020
  name?: string
@@ -1815,6 +2081,25 @@ export interface components {
1815
2081
  }
1816
2082
  }>
1817
2083
  }
2084
+ OpenVEXDocumentSchema: {
2085
+ /** @default https://openvex.dev/ns/v0.2.0 */
2086
+ '@context': string
2087
+ /** @default */
2088
+ '@id': string
2089
+ /** @default Socket Security */
2090
+ author: string
2091
+ /** @default */
2092
+ timestamp: string
2093
+ /** @default 1 */
2094
+ version: number
2095
+ statements: Array<components['schemas']['OpenVEXStatementSchema']>
2096
+ /** @default VEX Generator */
2097
+ role?: string
2098
+ /** @default */
2099
+ last_updated?: string
2100
+ /** @default Socket Security VEX Generator */
2101
+ tooling?: string
2102
+ }
1818
2103
  SPDXManifestSchema: {
1819
2104
  /** @default SPDX-2.3 */
1820
2105
  spdxVersion: string
@@ -1917,6 +2202,11 @@ export interface components {
1917
2202
  * @default false
1918
2203
  */
1919
2204
  unsafe: boolean
2205
+ /**
2206
+ * @description Package contains remote URL(s) in the source code
2207
+ * @default false
2208
+ */
2209
+ url: boolean
1920
2210
  }
1921
2211
  Qualifiers: unknown
1922
2212
  SocketScore: {
@@ -2324,13 +2614,11 @@ export interface components {
2324
2614
  alertKeysToReachabilityTypes?: {
2325
2615
  [key: string]: string[]
2326
2616
  }
2327
- /** @description Mapping of alert keys to arrays of reachability summaries. Each summary contains a reachability type and a hash pointing to detailed analysis data (call stacks, file locations, confidence scores). Used for efficient storage and retrieval of comprehensive reachability analysis results without duplicating large analysis payloads. */
2617
+ /** @description Mapping of alert keys to arrays of reachability summaries. Each summary contains a reachability type indicating the result of reachability analysis for the corresponding vulnerability alert. */
2328
2618
  alertKeysToReachabilitySummaries?: {
2329
2619
  [key: string]: Array<{
2330
2620
  /** @default */
2331
2621
  type: string
2332
- /** @default */
2333
- hash: string
2334
2622
  }>
2335
2623
  }
2336
2624
  }
@@ -2429,6 +2717,32 @@ export interface components {
2429
2717
  }>
2430
2718
  components?: Array<components['schemas']['CDXComponentSchema']>
2431
2719
  }
2720
+ OpenVEXStatementSchema: {
2721
+ vulnerability: components['schemas']['OpenVEXVulnerabilitySchema']
2722
+ products: Array<components['schemas']['OpenVEXProductSchema']>
2723
+ /** @default affected */
2724
+ status: string
2725
+ /** @default */
2726
+ '@id'?: string
2727
+ /** @default 0 */
2728
+ version?: number
2729
+ /** @default */
2730
+ timestamp?: string
2731
+ /** @default */
2732
+ last_updated?: string
2733
+ /** @default */
2734
+ supplier?: string
2735
+ /** @default */
2736
+ status_notes?: string
2737
+ /** @default */
2738
+ justification?: string
2739
+ /** @default */
2740
+ impact_statement?: string
2741
+ /** @default */
2742
+ action_statement?: string
2743
+ /** @default */
2744
+ action_statement_timestamp?: string
2745
+ }
2432
2746
  LicenseAllowListElabbed: {
2433
2747
  strings: string[]
2434
2748
  classes: string[]
@@ -3045,6 +3359,19 @@ export interface components {
3045
3359
  usage?: components['schemas']['SocketUsageRef']
3046
3360
  }
3047
3361
  }
3362
+ | {
3363
+ /** @enum {string} */
3364
+ type?: 'tooManyFiles'
3365
+ value?: components['schemas']['SocketIssueBasics'] & {
3366
+ /** @default */
3367
+ description: string
3368
+ props: {
3369
+ /** @default 0 */
3370
+ fileCount: number
3371
+ }
3372
+ usage?: components['schemas']['SocketUsageRef']
3373
+ }
3374
+ }
3048
3375
  | {
3049
3376
  /** @enum {string} */
3050
3377
  type?: 'generic'
@@ -3172,6 +3499,21 @@ export interface components {
3172
3499
  usage?: components['schemas']['SocketUsageRef']
3173
3500
  }
3174
3501
  }
3502
+ | {
3503
+ /** @enum {string} */
3504
+ type?: 'recentlyPublished'
3505
+ value?: components['schemas']['SocketIssueBasics'] & {
3506
+ /** @default */
3507
+ description: string
3508
+ props: {
3509
+ /** @default */
3510
+ publishedAt: string
3511
+ /** @default */
3512
+ checkedAt: string
3513
+ }
3514
+ usage?: components['schemas']['SocketUsageRef']
3515
+ }
3516
+ }
3175
3517
  | {
3176
3518
  /** @enum {string} */
3177
3519
  type?: 'licenseSpdxDisj'
@@ -3889,76 +4231,280 @@ export interface components {
3889
4231
  }
3890
4232
  | {
3891
4233
  /** @enum {string} */
3892
- type?: 'socketUpgradeAvailable'
4234
+ type?: 'skillAutonomyAbuse'
3893
4235
  value?: components['schemas']['SocketIssueBasics'] & {
3894
4236
  /** @default */
3895
4237
  description: string
3896
4238
  props: {
3897
- categories: string[]
3898
- /** @default false */
3899
- deprecated: boolean
3900
- interop: string[]
3901
4239
  /** @default */
3902
- replacementPURL: string
3903
- /** @default */
3904
- version: string
4240
+ notes: string
4241
+ /** @default 0 */
4242
+ confidence: number
4243
+ /** @default 0 */
4244
+ severity: number
3905
4245
  }
3906
4246
  usage?: components['schemas']['SocketUsageRef']
3907
4247
  }
3908
4248
  }
3909
4249
  | {
3910
4250
  /** @enum {string} */
3911
- type?: 'longStrings'
4251
+ type?: 'skillCommandInjection'
3912
4252
  value?: components['schemas']['SocketIssueBasics'] & {
3913
4253
  /** @default */
3914
4254
  description: string
3915
- props: Record<string, never>
4255
+ props: {
4256
+ /** @default */
4257
+ notes: string
4258
+ /** @default 0 */
4259
+ confidence: number
4260
+ /** @default 0 */
4261
+ severity: number
4262
+ }
3916
4263
  usage?: components['schemas']['SocketUsageRef']
3917
4264
  }
3918
4265
  }
3919
4266
  | {
3920
4267
  /** @enum {string} */
3921
- type?: 'highEntropyStrings'
4268
+ type?: 'skillDataExfiltration'
3922
4269
  value?: components['schemas']['SocketIssueBasics'] & {
3923
4270
  /** @default */
3924
4271
  description: string
3925
- props: Record<string, never>
4272
+ props: {
4273
+ /** @default */
4274
+ notes: string
4275
+ /** @default 0 */
4276
+ confidence: number
4277
+ /** @default 0 */
4278
+ severity: number
4279
+ }
3926
4280
  usage?: components['schemas']['SocketUsageRef']
3927
4281
  }
3928
4282
  }
3929
4283
  | {
3930
4284
  /** @enum {string} */
3931
- type?: 'urlStrings'
4285
+ type?: 'skillDiscoveryAbuse'
3932
4286
  value?: components['schemas']['SocketIssueBasics'] & {
3933
4287
  /** @default */
3934
4288
  description: string
3935
4289
  props: {
3936
- urls: string[]
4290
+ /** @default */
4291
+ notes: string
4292
+ /** @default 0 */
4293
+ confidence: number
4294
+ /** @default 0 */
4295
+ severity: number
3937
4296
  }
3938
4297
  usage?: components['schemas']['SocketUsageRef']
3939
4298
  }
3940
4299
  }
3941
4300
  | {
3942
4301
  /** @enum {string} */
3943
- type?: 'usesEval'
4302
+ type?: 'skillHardcodedSecrets'
3944
4303
  value?: components['schemas']['SocketIssueBasics'] & {
3945
4304
  /** @default */
3946
4305
  description: string
3947
4306
  props: {
3948
- /** @default eval */
3949
- evalType: string
4307
+ /** @default */
4308
+ notes: string
4309
+ /** @default 0 */
4310
+ confidence: number
4311
+ /** @default 0 */
4312
+ severity: number
3950
4313
  }
3951
4314
  usage?: components['schemas']['SocketUsageRef']
3952
4315
  }
3953
4316
  }
3954
4317
  | {
3955
4318
  /** @enum {string} */
3956
- type?: 'dynamicRequire'
4319
+ type?: 'skillObfuscation'
3957
4320
  value?: components['schemas']['SocketIssueBasics'] & {
3958
4321
  /** @default */
3959
4322
  description: string
3960
- props: Record<string, never>
3961
- usage?: components['schemas']['SocketUsageRef']
4323
+ props: {
4324
+ /** @default */
4325
+ notes: string
4326
+ /** @default 0 */
4327
+ confidence: number
4328
+ /** @default 0 */
4329
+ severity: number
4330
+ }
4331
+ usage?: components['schemas']['SocketUsageRef']
4332
+ }
4333
+ }
4334
+ | {
4335
+ /** @enum {string} */
4336
+ type?: 'skillPromptInjection'
4337
+ value?: components['schemas']['SocketIssueBasics'] & {
4338
+ /** @default */
4339
+ description: string
4340
+ props: {
4341
+ /** @default */
4342
+ notes: string
4343
+ /** @default 0 */
4344
+ confidence: number
4345
+ /** @default 0 */
4346
+ severity: number
4347
+ }
4348
+ usage?: components['schemas']['SocketUsageRef']
4349
+ }
4350
+ }
4351
+ | {
4352
+ /** @enum {string} */
4353
+ type?: 'skillResourceAbuse'
4354
+ value?: components['schemas']['SocketIssueBasics'] & {
4355
+ /** @default */
4356
+ description: string
4357
+ props: {
4358
+ /** @default */
4359
+ notes: string
4360
+ /** @default 0 */
4361
+ confidence: number
4362
+ /** @default 0 */
4363
+ severity: number
4364
+ }
4365
+ usage?: components['schemas']['SocketUsageRef']
4366
+ }
4367
+ }
4368
+ | {
4369
+ /** @enum {string} */
4370
+ type?: 'skillSupplyChain'
4371
+ value?: components['schemas']['SocketIssueBasics'] & {
4372
+ /** @default */
4373
+ description: string
4374
+ props: {
4375
+ /** @default */
4376
+ notes: string
4377
+ /** @default 0 */
4378
+ confidence: number
4379
+ /** @default 0 */
4380
+ severity: number
4381
+ }
4382
+ usage?: components['schemas']['SocketUsageRef']
4383
+ }
4384
+ }
4385
+ | {
4386
+ /** @enum {string} */
4387
+ type?: 'skillToolAbuse'
4388
+ value?: components['schemas']['SocketIssueBasics'] & {
4389
+ /** @default */
4390
+ description: string
4391
+ props: {
4392
+ /** @default */
4393
+ notes: string
4394
+ /** @default 0 */
4395
+ confidence: number
4396
+ /** @default 0 */
4397
+ severity: number
4398
+ }
4399
+ usage?: components['schemas']['SocketUsageRef']
4400
+ }
4401
+ }
4402
+ | {
4403
+ /** @enum {string} */
4404
+ type?: 'skillToolChaining'
4405
+ value?: components['schemas']['SocketIssueBasics'] & {
4406
+ /** @default */
4407
+ description: string
4408
+ props: {
4409
+ /** @default */
4410
+ notes: string
4411
+ /** @default 0 */
4412
+ confidence: number
4413
+ /** @default 0 */
4414
+ severity: number
4415
+ }
4416
+ usage?: components['schemas']['SocketUsageRef']
4417
+ }
4418
+ }
4419
+ | {
4420
+ /** @enum {string} */
4421
+ type?: 'skillTransitiveTrust'
4422
+ value?: components['schemas']['SocketIssueBasics'] & {
4423
+ /** @default */
4424
+ description: string
4425
+ props: {
4426
+ /** @default */
4427
+ notes: string
4428
+ /** @default 0 */
4429
+ confidence: number
4430
+ /** @default 0 */
4431
+ severity: number
4432
+ }
4433
+ usage?: components['schemas']['SocketUsageRef']
4434
+ }
4435
+ }
4436
+ | {
4437
+ /** @enum {string} */
4438
+ type?: 'socketUpgradeAvailable'
4439
+ value?: components['schemas']['SocketIssueBasics'] & {
4440
+ /** @default */
4441
+ description: string
4442
+ props: {
4443
+ categories: string[]
4444
+ /** @default false */
4445
+ deprecated: boolean
4446
+ interop: string[]
4447
+ /** @default */
4448
+ replacementPURL: string
4449
+ /** @default */
4450
+ version: string
4451
+ }
4452
+ usage?: components['schemas']['SocketUsageRef']
4453
+ }
4454
+ }
4455
+ | {
4456
+ /** @enum {string} */
4457
+ type?: 'longStrings'
4458
+ value?: components['schemas']['SocketIssueBasics'] & {
4459
+ /** @default */
4460
+ description: string
4461
+ props: Record<string, never>
4462
+ usage?: components['schemas']['SocketUsageRef']
4463
+ }
4464
+ }
4465
+ | {
4466
+ /** @enum {string} */
4467
+ type?: 'highEntropyStrings'
4468
+ value?: components['schemas']['SocketIssueBasics'] & {
4469
+ /** @default */
4470
+ description: string
4471
+ props: Record<string, never>
4472
+ usage?: components['schemas']['SocketUsageRef']
4473
+ }
4474
+ }
4475
+ | {
4476
+ /** @enum {string} */
4477
+ type?: 'urlStrings'
4478
+ value?: components['schemas']['SocketIssueBasics'] & {
4479
+ /** @default */
4480
+ description: string
4481
+ props: {
4482
+ urls: string[]
4483
+ }
4484
+ usage?: components['schemas']['SocketUsageRef']
4485
+ }
4486
+ }
4487
+ | {
4488
+ /** @enum {string} */
4489
+ type?: 'usesEval'
4490
+ value?: components['schemas']['SocketIssueBasics'] & {
4491
+ /** @default */
4492
+ description: string
4493
+ props: {
4494
+ /** @default eval */
4495
+ evalType: string
4496
+ }
4497
+ usage?: components['schemas']['SocketUsageRef']
4498
+ }
4499
+ }
4500
+ | {
4501
+ /** @enum {string} */
4502
+ type?: 'dynamicRequire'
4503
+ value?: components['schemas']['SocketIssueBasics'] & {
4504
+ /** @default */
4505
+ description: string
4506
+ props: Record<string, never>
4507
+ usage?: components['schemas']['SocketUsageRef']
3962
4508
  }
3963
4509
  }
3964
4510
  | {
@@ -4383,6 +4929,7 @@ export interface components {
4383
4929
  | 'cocoapods'
4384
4930
  | 'cargo'
4385
4931
  | 'chrome'
4932
+ | 'clawhub'
4386
4933
  | 'composer'
4387
4934
  | 'conan'
4388
4935
  | 'conda'
@@ -4405,6 +4952,7 @@ export interface components {
4405
4952
  | 'pub'
4406
4953
  | 'pypi'
4407
4954
  | 'rpm'
4955
+ | 'socket'
4408
4956
  | 'swid'
4409
4957
  | 'swift'
4410
4958
  | 'vscode'
@@ -4453,6 +5001,22 @@ export interface components {
4453
5001
  /** @description Reachability analysis results for each vulnerability */
4454
5002
  results: Array<components['schemas']['ReachabilityResultItem']>
4455
5003
  }
5004
+ OpenVEXVulnerabilitySchema: {
5005
+ /** @default */
5006
+ name: string
5007
+ /** @default */
5008
+ '@id'?: string
5009
+ /** @default */
5010
+ description?: string
5011
+ aliases?: string[]
5012
+ }
5013
+ OpenVEXProductSchema: {
5014
+ /** @default */
5015
+ '@id': string
5016
+ identifiers?: components['schemas']['OpenVEXIdentifiersSchema']
5017
+ hashes?: components['schemas']['OpenVEXHashesSchema']
5018
+ subcomponents?: Array<components['schemas']['OpenVEXComponentSchema']>
5019
+ }
4456
5020
  SocketIssueBasics: {
4457
5021
  severity: components['schemas']['SocketIssueSeverity']
4458
5022
  category: components['schemas']['SocketCategory']
@@ -4508,6 +5072,46 @@ export interface components {
4508
5072
  */
4509
5073
  subprojectPath?: string
4510
5074
  }
5075
+ OpenVEXIdentifiersSchema: {
5076
+ /** @default */
5077
+ purl?: string
5078
+ /** @default */
5079
+ cpe23?: string
5080
+ /** @default */
5081
+ cpe22?: string
5082
+ }
5083
+ OpenVEXHashesSchema: {
5084
+ /** @default */
5085
+ md5?: string
5086
+ /** @default */
5087
+ sha1?: string
5088
+ /** @default */
5089
+ 'sha-256'?: string
5090
+ /** @default */
5091
+ 'sha-384'?: string
5092
+ /** @default */
5093
+ 'sha-512'?: string
5094
+ /** @default */
5095
+ 'sha3-224'?: string
5096
+ /** @default */
5097
+ 'sha3-256'?: string
5098
+ /** @default */
5099
+ 'sha3-384'?: string
5100
+ /** @default */
5101
+ 'sha3-512'?: string
5102
+ /** @default */
5103
+ 'blake2s-256'?: string
5104
+ /** @default */
5105
+ 'blake2b-256'?: string
5106
+ /** @default */
5107
+ 'blake2b-512'?: string
5108
+ }
5109
+ OpenVEXComponentSchema: {
5110
+ /** @default */
5111
+ '@id'?: string
5112
+ identifiers?: components['schemas']['OpenVEXIdentifiersSchema']
5113
+ hashes?: components['schemas']['OpenVEXHashesSchema']
5114
+ }
4511
5115
  SocketRefList: Array<components['schemas']['SocketRef']>
4512
5116
  SocketRefFile: {
4513
5117
  /** @default */
@@ -4777,6 +5381,19 @@ export interface components {
4777
5381
  }
4778
5382
  }
4779
5383
  }
5384
+ /** @description Resource already exists */
5385
+ SocketConflict: {
5386
+ content: {
5387
+ 'application/json': {
5388
+ error: {
5389
+ /** @default */
5390
+ message: string
5391
+ /** @default null */
5392
+ details: Record<string, unknown> | null
5393
+ }
5394
+ }
5395
+ }
5396
+ }
4780
5397
  /** @description Gone */
4781
5398
  SocketGone: {
4782
5399
  content: {
@@ -4804,7 +5421,10 @@ export type external = Record<string, never>
4804
5421
  export interface operations {
4805
5422
  /**
4806
5423
  * Get Packages by PURL
4807
- * @description Batch retrieval of package metadata and alerts by PURL strings. Compatible witch CycloneDX reports.
5424
+ * @deprecated
5425
+ * @description **This endpoint is deprecated.** Deprecated since 2026-01-05.
5426
+ *
5427
+ * Batch retrieval of package metadata and alerts by PURL strings. Compatible with CycloneDX reports.
4808
5428
  *
4809
5429
  * Package URLs (PURLs) are an ecosystem agnostic way to identify packages.
4810
5430
  * CycloneDX SBOMs use the purl format to identify components.
@@ -4888,7 +5508,7 @@ export interface operations {
4888
5508
  alerts?: boolean
4889
5509
  /** @description Include only alerts with comma separated actions defined by security policy. */
4890
5510
  actions?: Array<'error' | 'monitor' | 'warn' | 'ignore'>
4891
- /** @description Compact metadata. */
5511
+ /** @description Compact metadata. When enabled, excludes metadata fields like author, scores, size, dependencies, and manifest files. Always includes: id, type, name, version, release, namespace, subpath, alerts, and alertPriorities. */
4892
5512
  compact?: boolean
4893
5513
  /** @description Include only fixable alerts. */
4894
5514
  fixable?: boolean
@@ -4906,7 +5526,7 @@ export interface operations {
4906
5526
  }
4907
5527
  requestBody?: {
4908
5528
  content: {
4909
- 'application/json': components['schemas']['SocketBatchPURLFetch']
5529
+ 'application/json': components['schemas']['SocketOrgBatchPURLFetch']
4910
5530
  }
4911
5531
  }
4912
5532
  responses: {
@@ -5074,6 +5694,8 @@ export interface operations {
5074
5694
  pull_request?: string
5075
5695
  /** @description A commit hash to filter full-scans by. */
5076
5696
  commit_hash?: string
5697
+ /** @description A scan type to filter full-scans by (e.g. socket, socket_tier1, socket_basics). */
5698
+ scan_type?: string
5077
5699
  }
5078
5700
  path: {
5079
5701
  /** @description The slug of the organization */
@@ -5129,6 +5751,8 @@ export interface operations {
5129
5751
  integration_commit_url?: string | null
5130
5752
  /** @default */
5131
5753
  integration_pull_request_url?: string | null
5754
+ /** @default */
5755
+ scan_type?: string | null
5132
5756
  /**
5133
5757
  * @description The current processing status of the SBOM
5134
5758
  * @default pending
@@ -5156,7 +5780,7 @@ export interface operations {
5156
5780
  *
5157
5781
  * To get a list of supported filetypes that can be uploaded in a full-scan, see the [Get supported file types](/reference/getsupportedfiles) endpoint.
5158
5782
  *
5159
- * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
5783
+ * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 268 MB.
5160
5784
  *
5161
5785
  * **Query Parameters:**
5162
5786
  * - `scan_type` (optional): The type of scan to perform. Defaults to 'socket'. Must be 32 characters or less. Used for categorizing multiple SBOM heads per repository branch.
@@ -5262,6 +5886,8 @@ export interface operations {
5262
5886
  integration_commit_url?: string | null
5263
5887
  /** @default */
5264
5888
  integration_pull_request_url?: string | null
5889
+ /** @default */
5890
+ scan_type?: string | null
5265
5891
  /**
5266
5892
  * @description The current processing status of the SBOM
5267
5893
  * @default pending
@@ -5300,6 +5926,8 @@ export interface operations {
5300
5926
  | Array<'component' | 'formula'>
5301
5927
  /** @description Include license details in the response. This can increase the response size significantly. */
5302
5928
  include_license_details: boolean
5929
+ /** @description Return cached immutable scan results. When enabled and results are cached, returns the pre-computed scan. When results are not yet cached, returns 202 Accepted and enqueues a background job. */
5930
+ cached?: boolean
5303
5931
  }
5304
5932
  path: {
5305
5933
  /** @description The slug of the organization */
@@ -5315,6 +5943,17 @@ export interface operations {
5315
5943
  'application/x-ndjson': components['schemas']['SocketArtifact']
5316
5944
  }
5317
5945
  }
5946
+ /** @description Scan is being processed. Poll again later to retrieve results. */
5947
+ 202: {
5948
+ content: {
5949
+ 'application/json': {
5950
+ /** @default processing */
5951
+ status: string
5952
+ /** @default */
5953
+ id: string
5954
+ }
5955
+ }
5956
+ }
5318
5957
  400: components['responses']['SocketBadRequest']
5319
5958
  401: components['responses']['SocketUnauthorized']
5320
5959
  403: components['responses']['SocketForbidden']
@@ -5423,6 +6062,8 @@ export interface operations {
5423
6062
  integration_commit_url?: string | null
5424
6063
  /** @default */
5425
6064
  integration_pull_request_url?: string | null
6065
+ /** @default */
6066
+ scan_type?: string | null
5426
6067
  /**
5427
6068
  * @description The current processing status of the SBOM
5428
6069
  * @default pending
@@ -5702,7 +6343,7 @@ export interface operations {
5702
6343
  *
5703
6344
  * Each uploaded archive is extracted server-side and any supported manifest files (like package.json, package-lock.json, pnpm-lock.yaml, etc.) are ingested for the scan. If you upload multiple archives in a single request, the manifests from every archive are merged into one full scan. The response includes any files that were ignored.
5704
6345
  *
5705
- * The maximum combined number of files extracted from your upload is 5000 and each extracted file can be no bigger than 67 MB.
6346
+ * The maximum combined number of files extracted from your upload is 5000 and each extracted file can be no bigger than 268 MB.
5706
6347
  *
5707
6348
  * This endpoint consumes 1 unit of your quota.
5708
6349
  *
@@ -5805,6 +6446,8 @@ export interface operations {
5805
6446
  integration_commit_url?: string | null
5806
6447
  /** @default */
5807
6448
  integration_pull_request_url?: string | null
6449
+ /** @default */
6450
+ scan_type?: string | null
5808
6451
  /**
5809
6452
  * @description The current processing status of the SBOM
5810
6453
  * @default pending
@@ -5823,34 +6466,207 @@ export interface operations {
5823
6466
  }
5824
6467
  }
5825
6468
  /**
5826
- * Export CycloneDX SBOM (Beta)
5827
- * @description Export a Socket SBOM as a CycloneDX SBOM
5828
- *
5829
- * Supported ecosystems:
5830
- *
5831
- * - crates
5832
- * - go
5833
- * - maven
5834
- * - npm
5835
- * - nuget
5836
- * - pypi
5837
- * - rubygems
5838
- * - spdx
5839
- * - cdx
5840
- *
5841
- * Unsupported ecosystems are filtered from the export.
6469
+ * Rescan full scan
6470
+ * @description Create a new full scan by rescanning an existing scan. A "shallow" rescan reapplies the latest policies to the previously cached dependency resolution results. A "deep" rescan reruns dependency resolution and applies the latest policies to the results.
5842
6471
  *
5843
6472
  * This endpoint consumes 1 unit of your quota.
5844
6473
  *
5845
6474
  * This endpoint requires the following org token scopes:
5846
- * - report:read
6475
+ * - full-scans:create
5847
6476
  */
5848
- exportCDX: {
6477
+ rescanOrgFullScan: {
5849
6478
  parameters: {
5850
6479
  query?: {
5851
- /**
5852
- * @description The person(s) who created the BOM.
5853
- * Set this value if you're intending the modify the BOM and claim authorship.
6480
+ /** @description The rescan mode: "shallow" (default) re-applies policies to cached data, "deep" re-fetches the SBOM stream. */
6481
+ mode?: 'shallow' | 'deep'
6482
+ }
6483
+ path: {
6484
+ /** @description The slug of the organization */
6485
+ org_slug: string
6486
+ /** @description The ID of the full scan to rescan */
6487
+ full_scan_id: string
6488
+ }
6489
+ }
6490
+ responses: {
6491
+ /** @description Rescan initiated successfully */
6492
+ 201: {
6493
+ content: {
6494
+ 'application/json': {
6495
+ /** @default The ID of the newly created full scan */
6496
+ id: string
6497
+ /** @default The status of the new scan */
6498
+ status: string
6499
+ }
6500
+ }
6501
+ }
6502
+ 400: components['responses']['SocketBadRequest']
6503
+ 401: components['responses']['SocketUnauthorized']
6504
+ 403: components['responses']['SocketForbidden']
6505
+ 404: components['responses']['SocketNotFoundResponse']
6506
+ 429: components['responses']['SocketTooManyRequestsResponse']
6507
+ }
6508
+ }
6509
+ /**
6510
+ * Export CSV of alerts for full scan
6511
+ * @description Export a CSV file containing all alerts from a full scan.
6512
+ *
6513
+ * The CSV includes details about each alert and the affected packages.
6514
+ * You can optionally filter using the request body "filters" array. Supported filter IDs include:
6515
+ * - alert.action (error|warn|monitor|ignore)
6516
+ * - alert.type
6517
+ * - alert.category
6518
+ * - alert.severity (low|medium|middle|high|critical or 0-3)
6519
+ * - artifact.type (purl type, e.g. npm, pypi)
6520
+ * - dependency.type (direct|transitive)
6521
+ * - dependency.scope (dev|normal)
6522
+ * - dependency.usage (used|unused)
6523
+ * - manifest.file
6524
+ *
6525
+ * This endpoint consumes 1 unit of your quota.
6526
+ *
6527
+ * This endpoint requires the following org token scopes:
6528
+ * - full-scans:list
6529
+ */
6530
+ getOrgFullScanCsv: {
6531
+ parameters: {
6532
+ query: {
6533
+ /** @description Control which alert priority fields to include in the response. Set to "true" to include all fields, "false" to exclude all fields, or specify individual fields like "components,formula" to include only those fields. */
6534
+ include_alert_priority_details?:
6535
+ | boolean
6536
+ | Array<'component' | 'formula'>
6537
+ /** @description Include license details in the response. */
6538
+ include_license_details: boolean
6539
+ }
6540
+ path: {
6541
+ /** @description The slug of the organization */
6542
+ org_slug: string
6543
+ /** @description The ID of the full scan */
6544
+ full_scan_id: string
6545
+ }
6546
+ }
6547
+ requestBody?: {
6548
+ content: {
6549
+ 'application/json': {
6550
+ filters?: Array<{
6551
+ /** @default */
6552
+ id: string
6553
+ value: string[]
6554
+ }>
6555
+ }
6556
+ }
6557
+ }
6558
+ responses: {
6559
+ /** @description CSV export of alerts */
6560
+ 200: {
6561
+ content: {
6562
+ 'text/csv': unknown
6563
+ }
6564
+ }
6565
+ 400: components['responses']['SocketBadRequest']
6566
+ 401: components['responses']['SocketUnauthorized']
6567
+ 403: components['responses']['SocketForbidden']
6568
+ 404: components['responses']['SocketNotFoundResponse']
6569
+ 429: components['responses']['SocketTooManyRequestsResponse']
6570
+ }
6571
+ }
6572
+ /**
6573
+ * Generate PDF report for full scan
6574
+ * @description Generate a PDF report for all alerts in a full scan.
6575
+ *
6576
+ * This endpoint streams a PDF document containing all alerts found in the full scan,
6577
+ * with optional filtering and grouping options.
6578
+ *
6579
+ * Supported request body filter IDs include:
6580
+ * - alert.action (error|warn|monitor|ignore)
6581
+ * - alert.type
6582
+ * - alert.category
6583
+ * - alert.severity (low|medium|middle|high|critical or 0-3)
6584
+ * - artifact.type (purl type, e.g. npm, pypi)
6585
+ * - dependency.type (direct|transitive)
6586
+ * - dependency.scope (dev|normal)
6587
+ * - dependency.usage (used|unused)
6588
+ * - manifest.file
6589
+ *
6590
+ * This endpoint consumes 1 unit of your quota.
6591
+ *
6592
+ * This endpoint requires the following org token scopes:
6593
+ * - full-scans:list
6594
+ */
6595
+ getOrgFullScanPdf: {
6596
+ parameters: {
6597
+ query: {
6598
+ /** @description Control which alert priority fields to include in the response. Set to "true" to include all fields, "false" to exclude all fields, or specify individual fields like "components,formula" to include only those fields. */
6599
+ include_alert_priority_details?:
6600
+ | boolean
6601
+ | Array<'component' | 'formula'>
6602
+ /** @description Include license details in the response. */
6603
+ include_license_details: boolean
6604
+ }
6605
+ path: {
6606
+ /** @description The slug of the organization */
6607
+ org_slug: string
6608
+ /** @description The ID of the full scan */
6609
+ full_scan_id: string
6610
+ }
6611
+ }
6612
+ requestBody?: {
6613
+ content: {
6614
+ 'application/json': {
6615
+ filters?: Array<{
6616
+ /** @default */
6617
+ id: string
6618
+ value: string[]
6619
+ }>
6620
+ /** @default */
6621
+ groupBy?: string
6622
+ /** @default */
6623
+ additionalInformation?: string
6624
+ }
6625
+ }
6626
+ }
6627
+ responses: {
6628
+ /** @description PDF report of alerts */
6629
+ 200: {
6630
+ content: {
6631
+ 'application/pdf': unknown
6632
+ }
6633
+ }
6634
+ 400: components['responses']['SocketBadRequest']
6635
+ 401: components['responses']['SocketUnauthorized']
6636
+ 403: components['responses']['SocketForbidden']
6637
+ 404: components['responses']['SocketNotFoundResponse']
6638
+ 429: components['responses']['SocketTooManyRequestsResponse']
6639
+ }
6640
+ }
6641
+ /**
6642
+ * Export CycloneDX SBOM (Beta)
6643
+ * @description Export a Socket SBOM as a CycloneDX SBOM
6644
+ *
6645
+ * Supported ecosystems:
6646
+ *
6647
+ * - crates
6648
+ * - go
6649
+ * - maven
6650
+ * - npm
6651
+ * - nuget
6652
+ * - pypi
6653
+ * - rubygems
6654
+ * - spdx
6655
+ * - cdx
6656
+ *
6657
+ * Unsupported ecosystems are filtered from the export.
6658
+ *
6659
+ * This endpoint consumes 1 unit of your quota.
6660
+ *
6661
+ * This endpoint requires the following org token scopes:
6662
+ * - report:read
6663
+ */
6664
+ exportCDX: {
6665
+ parameters: {
6666
+ query?: {
6667
+ /**
6668
+ * @description The person(s) who created the BOM.
6669
+ * Set this value if you're intending the modify the BOM and claim authorship.
5854
6670
  */
5855
6671
  author?: string
5856
6672
  /** @description Dependency track project group */
@@ -5884,6 +6700,58 @@ export interface operations {
5884
6700
  429: components['responses']['SocketTooManyRequestsResponse']
5885
6701
  }
5886
6702
  }
6703
+ /**
6704
+ * Export OpenVEX Document (Beta)
6705
+ * @description Export vulnerability exploitability data as an OpenVEX v0.2.0 document.
6706
+ *
6707
+ * OpenVEX (Vulnerability Exploitability eXchange) documents communicate the
6708
+ * exploitability status of vulnerabilities in software products. This export
6709
+ * includes:
6710
+ *
6711
+ * - **Patch data**: Vulnerabilities fixed by applied Socket patches are marked as "fixed"
6712
+ * - **Reachability analysis**: Code reachability determines if vulnerable code is exploitable:
6713
+ * - Unreachable code → "not_affected" with justification
6714
+ * - Reachable code → "affected"
6715
+ * - Unknown/pending → "under_investigation"
6716
+ *
6717
+ * Each statement in the document represents a single artifact-vulnerability pair
6718
+ * for granular reachability information.
6719
+ *
6720
+ * This endpoint consumes 1 unit of your quota.
6721
+ *
6722
+ * This endpoint requires the following org token scopes:
6723
+ * - report:read
6724
+ */
6725
+ exportOpenVEX: {
6726
+ parameters: {
6727
+ query?: {
6728
+ /** @description The author of the VEX document. Should be an individual or organization. */
6729
+ author?: string
6730
+ /** @description The role of the document author (e.g., "VEX Generator", "Security Team"). */
6731
+ role?: string
6732
+ /** @description Custom IRI for the VEX document. If not provided, a default IRI will be generated. */
6733
+ document_id?: string
6734
+ }
6735
+ path: {
6736
+ /** @description The slug of the organization */
6737
+ org_slug: string
6738
+ /** @description The full scan OR sbom report ID */
6739
+ id: string
6740
+ }
6741
+ }
6742
+ responses: {
6743
+ /** @description OpenVEX v0.2.0 document */
6744
+ 200: {
6745
+ content: {
6746
+ 'application/json': components['schemas']['OpenVEXDocumentSchema']
6747
+ }
6748
+ }
6749
+ 400: components['responses']['SocketBadRequest']
6750
+ 401: components['responses']['SocketUnauthorized']
6751
+ 403: components['responses']['SocketForbidden']
6752
+ 429: components['responses']['SocketTooManyRequestsResponse']
6753
+ }
6754
+ }
5887
6755
  /**
5888
6756
  * Export SPDX SBOM (Beta)
5889
6757
  * @description Export a Socket SBOM as a SPDX SBOM
@@ -6039,6 +6907,8 @@ export interface operations {
6039
6907
  omit_license_details?: boolean
6040
6908
  /** @description Omit unchanged artifacts from the response. When set to true, the unchanged field will be set to null. */
6041
6909
  omit_unchanged?: boolean
6910
+ /** @description Return cached immutable scan results. When enabled and results are cached, returns the pre-computed scan. When results are not yet cached, returns 202 Accepted and enqueues a background job. Note: When cached=true, the omit_license_details parameter is ignored as cached results always includes license details. */
6911
+ cached?: boolean
6042
6912
  }
6043
6913
  path: {
6044
6914
  /** @description The slug of the organization */
@@ -6144,6 +7014,17 @@ export interface operations {
6144
7014
  }
6145
7015
  }
6146
7016
  }
7017
+ /** @description Scan is being processed. Poll again later to retrieve results. */
7018
+ 202: {
7019
+ content: {
7020
+ 'application/json': {
7021
+ /** @default processing */
7022
+ status: string
7023
+ /** @default */
7024
+ id: string
7025
+ }
7026
+ }
7027
+ }
6147
7028
  400: components['responses']['SocketBadRequest']
6148
7029
  401: components['responses']['SocketUnauthorized']
6149
7030
  403: components['responses']['SocketForbidden']
@@ -6315,7 +7196,7 @@ export interface operations {
6315
7196
  * Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
6316
7197
  * the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
6317
7198
  *
6318
- * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
7199
+ * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 268 MB.
6319
7200
  *
6320
7201
  * This endpoint consumes 1 unit of your quota.
6321
7202
  *
@@ -6463,6 +7344,7 @@ export interface operations {
6463
7344
  401: components['responses']['SocketUnauthorized']
6464
7345
  403: components['responses']['SocketForbidden']
6465
7346
  404: components['responses']['SocketNotFoundResponse']
7347
+ 409: components['responses']['SocketConflict']
6466
7348
  429: components['responses']['SocketTooManyRequestsResponse']
6467
7349
  }
6468
7350
  }
@@ -6589,6 +7471,7 @@ export interface operations {
6589
7471
  401: components['responses']['SocketUnauthorized']
6590
7472
  403: components['responses']['SocketForbidden']
6591
7473
  404: components['responses']['SocketNotFoundResponse']
7474
+ 409: components['responses']['SocketConflict']
6592
7475
  429: components['responses']['SocketTooManyRequestsResponse']
6593
7476
  }
6594
7477
  }
@@ -6620,11 +7503,58 @@ export interface operations {
6620
7503
  content: {
6621
7504
  'application/json': {
6622
7505
  results: Array<{
7506
+ /**
7507
+ * @description The uuid of the triage action
7508
+ * @default
7509
+ */
7510
+ uuid?: string | null
7511
+ /**
7512
+ * @description The package type associated with the triage state
7513
+ * @default
7514
+ */
7515
+ package_type?: string | null
7516
+ /**
7517
+ * @description The package namespace associated with the triage state
7518
+ * @default
7519
+ */
7520
+ package_namespace?: string | null
7521
+ /**
7522
+ * @description The package name associated with the triage state
7523
+ * @default
7524
+ */
7525
+ package_name?: string | null
7526
+ /**
7527
+ * @description The package version associated with the triage state, it can contain a * suffix for wildcard matching
7528
+ * @default
7529
+ */
7530
+ package_version?: string | null
6623
7531
  /**
6624
7532
  * @description The alert_key associated with the triage state
6625
7533
  * @default
6626
7534
  */
6627
- alert_key?: string
7535
+ alert_key?: string | null
7536
+ /**
7537
+ * @description The alert type (e.g., criticalCVE, highCVE) associated with the triage state
7538
+ * @default
7539
+ */
7540
+ alert_type?: string | null
7541
+ /**
7542
+ * @description Whether a fix must be available, unavailable, or * for any
7543
+ * @default *
7544
+ * @enum {string|null}
7545
+ */
7546
+ fix_available?: 'available' | 'unavailable' | '*' | null
7547
+ /**
7548
+ * @description Whether a patch must be available, unavailable, or * for any
7549
+ * @default *
7550
+ * @enum {string|null}
7551
+ */
7552
+ patch_available?: 'available' | 'unavailable' | '*' | null
7553
+ /**
7554
+ * @description CVSS score comparison (e.g., >=7.5, >5.0, ==8.0)
7555
+ * @default
7556
+ */
7557
+ cvss_score_cmp?: string | null
6628
7558
  /**
6629
7559
  * @description The creation date of the triage action
6630
7560
  * @default
@@ -6651,6 +7581,23 @@ export interface operations {
6651
7581
  * @enum {string}
6652
7582
  */
6653
7583
  state?: 'block' | 'ignore' | 'inherit' | 'monitor' | 'warn'
7584
+ /**
7585
+ * @description CVE or GHSA ID associated with the triage state
7586
+ * @default
7587
+ */
7588
+ cve_or_ghsa_id?: string | null
7589
+ /**
7590
+ * @description The reachability of the alert, can be reachable, unreachable, other, or * for any
7591
+ * @default *
7592
+ * @enum {string|null}
7593
+ */
7594
+ reachability?: 'reachable' | 'unreachable' | 'other' | '*' | null
7595
+ /**
7596
+ * @description Whether the alert has a CISA KEV (Known Exploited Vulnerability), can be exist, none, or * for any
7597
+ * @default *
7598
+ * @enum {string|null}
7599
+ */
7600
+ kevs?: 'exist' | 'none' | '*' | null
6654
7601
  }>
6655
7602
  /** @default 0 */
6656
7603
  nextPage: number | null
@@ -6666,7 +7613,7 @@ export interface operations {
6666
7613
  }
6667
7614
  /**
6668
7615
  * Update Org Alert Triage
6669
- * @description Update triage actions on organizaton alerts.
7616
+ * @description Update triage actions on organization alerts.
6670
7617
  *
6671
7618
  * This endpoint consumes 1 unit of your quota.
6672
7619
  *
@@ -6675,6 +7622,10 @@ export interface operations {
6675
7622
  */
6676
7623
  updateOrgAlertTriage: {
6677
7624
  parameters: {
7625
+ query?: {
7626
+ /** @description Set to true to force broad triage updates, these are triages lacking a specific alertKey or granular artifact information which may have limited introspection to see what they apply to. */
7627
+ force?: string
7628
+ }
6678
7629
  path: {
6679
7630
  /** @description The slug of the organization */
6680
7631
  org_slug: string
@@ -6685,7 +7636,43 @@ export interface operations {
6685
7636
  'application/json': {
6686
7637
  alertTriage: Array<{
6687
7638
  /** @default */
6688
- alertKey?: string
7639
+ uuid?: string | null
7640
+ /** @default */
7641
+ packageType?: string | null
7642
+ /** @default */
7643
+ packageNamespace?: string | null
7644
+ /** @default */
7645
+ packageName?: string | null
7646
+ /** @default */
7647
+ packageVersion?: string | null
7648
+ /** @default */
7649
+ alertKey?: string | null
7650
+ /** @default */
7651
+ alertType?: string | null
7652
+ /**
7653
+ * @description Whether a fix is available, unavailable, or * for any
7654
+ * @enum {string}
7655
+ */
7656
+ fixAvailable?: 'available' | 'unavailable' | '*'
7657
+ /**
7658
+ * @description Whether a patch is available, unavailable, or * for any
7659
+ * @enum {string}
7660
+ */
7661
+ patchAvailable?: 'available' | 'unavailable' | '*'
7662
+ /**
7663
+ * @description Whether the alert has a CISA KEV, can be exist, none, or * for any
7664
+ * @enum {string}
7665
+ */
7666
+ kevs?: 'exist' | 'none' | '*'
7667
+ /** @default */
7668
+ cveOrGhsaId?: string | null
7669
+ /**
7670
+ * @description The reachability of the alert, can be reachable, unreachable, other, or * for any
7671
+ * @enum {string}
7672
+ */
7673
+ reachability?: 'reachable' | 'unreachable' | 'other' | '*'
7674
+ /** @default */
7675
+ cvssScoreCmp?: string | null
6689
7676
  /** @default */
6690
7677
  note?: string
6691
7678
  /**
@@ -6699,7 +7686,7 @@ export interface operations {
6699
7686
  }
6700
7687
  responses: {
6701
7688
  /** @description Updated Alert Triage */
6702
- 202: {
7689
+ 200: {
6703
7690
  content: {
6704
7691
  'application/json': {
6705
7692
  /** @default */
@@ -6715,35 +7702,70 @@ export interface operations {
6715
7702
  }
6716
7703
  }
6717
7704
  /**
6718
- * List repositories
6719
- * @description Lists repositories for the specified organization.
7705
+ * Delete Org Alert Triage
7706
+ * @description Delete a specific triage rule by UUID.
6720
7707
  *
6721
7708
  * This endpoint consumes 1 unit of your quota.
6722
7709
  *
6723
7710
  * This endpoint requires the following org token scopes:
6724
- * - repo:list
7711
+ * - triage:alerts-update
6725
7712
  */
6726
- getOrgRepoList: {
7713
+ deleteOrgAlertTriage: {
6727
7714
  parameters: {
6728
- query?: {
6729
- sort?: string
6730
- direction?: string
6731
- per_page?: number
6732
- page?: number
6733
- /** @description Include archived repositories in the results */
6734
- include_archived?: boolean
6735
- }
6736
7715
  path: {
6737
7716
  /** @description The slug of the organization */
6738
7717
  org_slug: string
7718
+ /** @description The UUID of the alert triage entry to delete */
7719
+ uuid: string
6739
7720
  }
6740
7721
  }
6741
7722
  responses: {
6742
- /** @description Lists repositories for the specified organization. The authenticated user must be a member of the organization. */
7723
+ /** @description Deleted Alert Triage */
6743
7724
  200: {
6744
7725
  content: {
6745
7726
  'application/json': {
6746
- results: Array<{
7727
+ /** @default */
7728
+ result: string
7729
+ }
7730
+ }
7731
+ }
7732
+ 400: components['responses']['SocketBadRequest']
7733
+ 401: components['responses']['SocketUnauthorized']
7734
+ 403: components['responses']['SocketForbidden']
7735
+ 404: components['responses']['SocketNotFoundResponse']
7736
+ 429: components['responses']['SocketTooManyRequestsResponse']
7737
+ }
7738
+ }
7739
+ /**
7740
+ * List repositories
7741
+ * @description Lists repositories for the specified organization.
7742
+ *
7743
+ * This endpoint consumes 1 unit of your quota.
7744
+ *
7745
+ * This endpoint requires the following org token scopes:
7746
+ * - repo:list
7747
+ */
7748
+ getOrgRepoList: {
7749
+ parameters: {
7750
+ query?: {
7751
+ sort?: string
7752
+ direction?: string
7753
+ per_page?: number
7754
+ page?: number
7755
+ /** @description Include archived repositories in the results */
7756
+ include_archived?: boolean
7757
+ }
7758
+ path: {
7759
+ /** @description The slug of the organization */
7760
+ org_slug: string
7761
+ }
7762
+ }
7763
+ responses: {
7764
+ /** @description Lists repositories for the specified organization. The authenticated user must be a member of the organization. */
7765
+ 200: {
7766
+ content: {
7767
+ 'application/json': {
7768
+ results: Array<{
6747
7769
  /**
6748
7770
  * @description The ID of the repository
6749
7771
  * @default
@@ -7870,6 +8892,13 @@ export interface operations {
7870
8892
  */
7871
8893
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
7872
8894
  }
8895
+ tooManyFiles?: {
8896
+ /**
8897
+ * @description The action to take for tooManyFiles issues.
8898
+ * @enum {string}
8899
+ */
8900
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
8901
+ }
7873
8902
  generic?: {
7874
8903
  /**
7875
8904
  * @description The action to take for generic issues.
@@ -7926,6 +8955,13 @@ export interface operations {
7926
8955
  */
7927
8956
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
7928
8957
  }
8958
+ recentlyPublished?: {
8959
+ /**
8960
+ * @description The action to take for recentlyPublished issues.
8961
+ * @enum {string}
8962
+ */
8963
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
8964
+ }
7929
8965
  licenseSpdxDisj?: {
7930
8966
  /**
7931
8967
  * @description The action to take for licenseSpdxDisj issues.
@@ -8297,6 +9333,90 @@ export interface operations {
8297
9333
  */
8298
9334
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
8299
9335
  }
9336
+ skillAutonomyAbuse?: {
9337
+ /**
9338
+ * @description The action to take for skillAutonomyAbuse issues.
9339
+ * @enum {string}
9340
+ */
9341
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9342
+ }
9343
+ skillCommandInjection?: {
9344
+ /**
9345
+ * @description The action to take for skillCommandInjection issues.
9346
+ * @enum {string}
9347
+ */
9348
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9349
+ }
9350
+ skillDataExfiltration?: {
9351
+ /**
9352
+ * @description The action to take for skillDataExfiltration issues.
9353
+ * @enum {string}
9354
+ */
9355
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9356
+ }
9357
+ skillDiscoveryAbuse?: {
9358
+ /**
9359
+ * @description The action to take for skillDiscoveryAbuse issues.
9360
+ * @enum {string}
9361
+ */
9362
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9363
+ }
9364
+ skillHardcodedSecrets?: {
9365
+ /**
9366
+ * @description The action to take for skillHardcodedSecrets issues.
9367
+ * @enum {string}
9368
+ */
9369
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9370
+ }
9371
+ skillObfuscation?: {
9372
+ /**
9373
+ * @description The action to take for skillObfuscation issues.
9374
+ * @enum {string}
9375
+ */
9376
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9377
+ }
9378
+ skillPromptInjection?: {
9379
+ /**
9380
+ * @description The action to take for skillPromptInjection issues.
9381
+ * @enum {string}
9382
+ */
9383
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9384
+ }
9385
+ skillResourceAbuse?: {
9386
+ /**
9387
+ * @description The action to take for skillResourceAbuse issues.
9388
+ * @enum {string}
9389
+ */
9390
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9391
+ }
9392
+ skillSupplyChain?: {
9393
+ /**
9394
+ * @description The action to take for skillSupplyChain issues.
9395
+ * @enum {string}
9396
+ */
9397
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9398
+ }
9399
+ skillToolAbuse?: {
9400
+ /**
9401
+ * @description The action to take for skillToolAbuse issues.
9402
+ * @enum {string}
9403
+ */
9404
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9405
+ }
9406
+ skillToolChaining?: {
9407
+ /**
9408
+ * @description The action to take for skillToolChaining issues.
9409
+ * @enum {string}
9410
+ */
9411
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9412
+ }
9413
+ skillTransitiveTrust?: {
9414
+ /**
9415
+ * @description The action to take for skillTransitiveTrust issues.
9416
+ * @enum {string}
9417
+ */
9418
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9419
+ }
8300
9420
  socketUpgradeAvailable?: {
8301
9421
  /**
8302
9422
  * @description The action to take for socketUpgradeAvailable issues.
@@ -8749,6 +9869,13 @@ export interface operations {
8749
9869
  */
8750
9870
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
8751
9871
  }
9872
+ tooManyFiles?: {
9873
+ /**
9874
+ * @description The action to take for tooManyFiles issues.
9875
+ * @enum {string}
9876
+ */
9877
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9878
+ }
8752
9879
  generic?: {
8753
9880
  /**
8754
9881
  * @description The action to take for generic issues.
@@ -8805,6 +9932,13 @@ export interface operations {
8805
9932
  */
8806
9933
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
8807
9934
  }
9935
+ recentlyPublished?: {
9936
+ /**
9937
+ * @description The action to take for recentlyPublished issues.
9938
+ * @enum {string}
9939
+ */
9940
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9941
+ }
8808
9942
  licenseSpdxDisj?: {
8809
9943
  /**
8810
9944
  * @description The action to take for licenseSpdxDisj issues.
@@ -9176,6 +10310,90 @@ export interface operations {
9176
10310
  */
9177
10311
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9178
10312
  }
10313
+ skillAutonomyAbuse?: {
10314
+ /**
10315
+ * @description The action to take for skillAutonomyAbuse issues.
10316
+ * @enum {string}
10317
+ */
10318
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10319
+ }
10320
+ skillCommandInjection?: {
10321
+ /**
10322
+ * @description The action to take for skillCommandInjection issues.
10323
+ * @enum {string}
10324
+ */
10325
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10326
+ }
10327
+ skillDataExfiltration?: {
10328
+ /**
10329
+ * @description The action to take for skillDataExfiltration issues.
10330
+ * @enum {string}
10331
+ */
10332
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10333
+ }
10334
+ skillDiscoveryAbuse?: {
10335
+ /**
10336
+ * @description The action to take for skillDiscoveryAbuse issues.
10337
+ * @enum {string}
10338
+ */
10339
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10340
+ }
10341
+ skillHardcodedSecrets?: {
10342
+ /**
10343
+ * @description The action to take for skillHardcodedSecrets issues.
10344
+ * @enum {string}
10345
+ */
10346
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10347
+ }
10348
+ skillObfuscation?: {
10349
+ /**
10350
+ * @description The action to take for skillObfuscation issues.
10351
+ * @enum {string}
10352
+ */
10353
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10354
+ }
10355
+ skillPromptInjection?: {
10356
+ /**
10357
+ * @description The action to take for skillPromptInjection issues.
10358
+ * @enum {string}
10359
+ */
10360
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10361
+ }
10362
+ skillResourceAbuse?: {
10363
+ /**
10364
+ * @description The action to take for skillResourceAbuse issues.
10365
+ * @enum {string}
10366
+ */
10367
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10368
+ }
10369
+ skillSupplyChain?: {
10370
+ /**
10371
+ * @description The action to take for skillSupplyChain issues.
10372
+ * @enum {string}
10373
+ */
10374
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10375
+ }
10376
+ skillToolAbuse?: {
10377
+ /**
10378
+ * @description The action to take for skillToolAbuse issues.
10379
+ * @enum {string}
10380
+ */
10381
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10382
+ }
10383
+ skillToolChaining?: {
10384
+ /**
10385
+ * @description The action to take for skillToolChaining issues.
10386
+ * @enum {string}
10387
+ */
10388
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10389
+ }
10390
+ skillTransitiveTrust?: {
10391
+ /**
10392
+ * @description The action to take for skillTransitiveTrust issues.
10393
+ * @enum {string}
10394
+ */
10395
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10396
+ }
9179
10397
  socketUpgradeAvailable?: {
9180
10398
  /**
9181
10399
  * @description The action to take for socketUpgradeAvailable issues.
@@ -9782,6 +11000,13 @@ export interface operations {
9782
11000
  */
9783
11001
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9784
11002
  }
11003
+ tooManyFiles?: {
11004
+ /**
11005
+ * @description The action to take for tooManyFiles issues.
11006
+ * @enum {string}
11007
+ */
11008
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11009
+ }
9785
11010
  generic?: {
9786
11011
  /**
9787
11012
  * @description The action to take for generic issues.
@@ -9838,6 +11063,13 @@ export interface operations {
9838
11063
  */
9839
11064
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
9840
11065
  }
11066
+ recentlyPublished?: {
11067
+ /**
11068
+ * @description The action to take for recentlyPublished issues.
11069
+ * @enum {string}
11070
+ */
11071
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11072
+ }
9841
11073
  licenseSpdxDisj?: {
9842
11074
  /**
9843
11075
  * @description The action to take for licenseSpdxDisj issues.
@@ -10209,6 +11441,90 @@ export interface operations {
10209
11441
  */
10210
11442
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10211
11443
  }
11444
+ skillAutonomyAbuse?: {
11445
+ /**
11446
+ * @description The action to take for skillAutonomyAbuse issues.
11447
+ * @enum {string}
11448
+ */
11449
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11450
+ }
11451
+ skillCommandInjection?: {
11452
+ /**
11453
+ * @description The action to take for skillCommandInjection issues.
11454
+ * @enum {string}
11455
+ */
11456
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11457
+ }
11458
+ skillDataExfiltration?: {
11459
+ /**
11460
+ * @description The action to take for skillDataExfiltration issues.
11461
+ * @enum {string}
11462
+ */
11463
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11464
+ }
11465
+ skillDiscoveryAbuse?: {
11466
+ /**
11467
+ * @description The action to take for skillDiscoveryAbuse issues.
11468
+ * @enum {string}
11469
+ */
11470
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11471
+ }
11472
+ skillHardcodedSecrets?: {
11473
+ /**
11474
+ * @description The action to take for skillHardcodedSecrets issues.
11475
+ * @enum {string}
11476
+ */
11477
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11478
+ }
11479
+ skillObfuscation?: {
11480
+ /**
11481
+ * @description The action to take for skillObfuscation issues.
11482
+ * @enum {string}
11483
+ */
11484
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11485
+ }
11486
+ skillPromptInjection?: {
11487
+ /**
11488
+ * @description The action to take for skillPromptInjection issues.
11489
+ * @enum {string}
11490
+ */
11491
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11492
+ }
11493
+ skillResourceAbuse?: {
11494
+ /**
11495
+ * @description The action to take for skillResourceAbuse issues.
11496
+ * @enum {string}
11497
+ */
11498
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11499
+ }
11500
+ skillSupplyChain?: {
11501
+ /**
11502
+ * @description The action to take for skillSupplyChain issues.
11503
+ * @enum {string}
11504
+ */
11505
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11506
+ }
11507
+ skillToolAbuse?: {
11508
+ /**
11509
+ * @description The action to take for skillToolAbuse issues.
11510
+ * @enum {string}
11511
+ */
11512
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11513
+ }
11514
+ skillToolChaining?: {
11515
+ /**
11516
+ * @description The action to take for skillToolChaining issues.
11517
+ * @enum {string}
11518
+ */
11519
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11520
+ }
11521
+ skillTransitiveTrust?: {
11522
+ /**
11523
+ * @description The action to take for skillTransitiveTrust issues.
11524
+ * @enum {string}
11525
+ */
11526
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11527
+ }
10212
11528
  socketUpgradeAvailable?: {
10213
11529
  /**
10214
11530
  * @description The action to take for socketUpgradeAvailable issues.
@@ -10654,14 +11970,21 @@ export interface operations {
10654
11970
  */
10655
11971
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10656
11972
  }
10657
- generic?: {
11973
+ tooManyFiles?: {
10658
11974
  /**
10659
- * @description The action to take for generic issues.
11975
+ * @description The action to take for tooManyFiles issues.
10660
11976
  * @enum {string}
10661
11977
  */
10662
11978
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10663
11979
  }
10664
- ghaArgToSink?: {
11980
+ generic?: {
11981
+ /**
11982
+ * @description The action to take for generic issues.
11983
+ * @enum {string}
11984
+ */
11985
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11986
+ }
11987
+ ghaArgToSink?: {
10665
11988
  /**
10666
11989
  * @description The action to take for ghaArgToSink issues.
10667
11990
  * @enum {string}
@@ -10710,6 +12033,13 @@ export interface operations {
10710
12033
  */
10711
12034
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
10712
12035
  }
12036
+ recentlyPublished?: {
12037
+ /**
12038
+ * @description The action to take for recentlyPublished issues.
12039
+ * @enum {string}
12040
+ */
12041
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12042
+ }
10713
12043
  licenseSpdxDisj?: {
10714
12044
  /**
10715
12045
  * @description The action to take for licenseSpdxDisj issues.
@@ -11081,6 +12411,90 @@ export interface operations {
11081
12411
  */
11082
12412
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11083
12413
  }
12414
+ skillAutonomyAbuse?: {
12415
+ /**
12416
+ * @description The action to take for skillAutonomyAbuse issues.
12417
+ * @enum {string}
12418
+ */
12419
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12420
+ }
12421
+ skillCommandInjection?: {
12422
+ /**
12423
+ * @description The action to take for skillCommandInjection issues.
12424
+ * @enum {string}
12425
+ */
12426
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12427
+ }
12428
+ skillDataExfiltration?: {
12429
+ /**
12430
+ * @description The action to take for skillDataExfiltration issues.
12431
+ * @enum {string}
12432
+ */
12433
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12434
+ }
12435
+ skillDiscoveryAbuse?: {
12436
+ /**
12437
+ * @description The action to take for skillDiscoveryAbuse issues.
12438
+ * @enum {string}
12439
+ */
12440
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12441
+ }
12442
+ skillHardcodedSecrets?: {
12443
+ /**
12444
+ * @description The action to take for skillHardcodedSecrets issues.
12445
+ * @enum {string}
12446
+ */
12447
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12448
+ }
12449
+ skillObfuscation?: {
12450
+ /**
12451
+ * @description The action to take for skillObfuscation issues.
12452
+ * @enum {string}
12453
+ */
12454
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12455
+ }
12456
+ skillPromptInjection?: {
12457
+ /**
12458
+ * @description The action to take for skillPromptInjection issues.
12459
+ * @enum {string}
12460
+ */
12461
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12462
+ }
12463
+ skillResourceAbuse?: {
12464
+ /**
12465
+ * @description The action to take for skillResourceAbuse issues.
12466
+ * @enum {string}
12467
+ */
12468
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12469
+ }
12470
+ skillSupplyChain?: {
12471
+ /**
12472
+ * @description The action to take for skillSupplyChain issues.
12473
+ * @enum {string}
12474
+ */
12475
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12476
+ }
12477
+ skillToolAbuse?: {
12478
+ /**
12479
+ * @description The action to take for skillToolAbuse issues.
12480
+ * @enum {string}
12481
+ */
12482
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12483
+ }
12484
+ skillToolChaining?: {
12485
+ /**
12486
+ * @description The action to take for skillToolChaining issues.
12487
+ * @enum {string}
12488
+ */
12489
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12490
+ }
12491
+ skillTransitiveTrust?: {
12492
+ /**
12493
+ * @description The action to take for skillTransitiveTrust issues.
12494
+ * @enum {string}
12495
+ */
12496
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12497
+ }
11084
12498
  socketUpgradeAvailable?: {
11085
12499
  /**
11086
12500
  * @description The action to take for socketUpgradeAvailable issues.
@@ -11495,6 +12909,13 @@ export interface operations {
11495
12909
  */
11496
12910
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11497
12911
  }
12912
+ tooManyFiles?: {
12913
+ /**
12914
+ * @description The action to take for tooManyFiles issues.
12915
+ * @enum {string}
12916
+ */
12917
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12918
+ }
11498
12919
  generic?: {
11499
12920
  /**
11500
12921
  * @description The action to take for generic issues.
@@ -11551,6 +12972,13 @@ export interface operations {
11551
12972
  */
11552
12973
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11553
12974
  }
12975
+ recentlyPublished?: {
12976
+ /**
12977
+ * @description The action to take for recentlyPublished issues.
12978
+ * @enum {string}
12979
+ */
12980
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
12981
+ }
11554
12982
  licenseSpdxDisj?: {
11555
12983
  /**
11556
12984
  * @description The action to take for licenseSpdxDisj issues.
@@ -11922,6 +13350,90 @@ export interface operations {
11922
13350
  */
11923
13351
  action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
11924
13352
  }
13353
+ skillAutonomyAbuse?: {
13354
+ /**
13355
+ * @description The action to take for skillAutonomyAbuse issues.
13356
+ * @enum {string}
13357
+ */
13358
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13359
+ }
13360
+ skillCommandInjection?: {
13361
+ /**
13362
+ * @description The action to take for skillCommandInjection issues.
13363
+ * @enum {string}
13364
+ */
13365
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13366
+ }
13367
+ skillDataExfiltration?: {
13368
+ /**
13369
+ * @description The action to take for skillDataExfiltration issues.
13370
+ * @enum {string}
13371
+ */
13372
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13373
+ }
13374
+ skillDiscoveryAbuse?: {
13375
+ /**
13376
+ * @description The action to take for skillDiscoveryAbuse issues.
13377
+ * @enum {string}
13378
+ */
13379
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13380
+ }
13381
+ skillHardcodedSecrets?: {
13382
+ /**
13383
+ * @description The action to take for skillHardcodedSecrets issues.
13384
+ * @enum {string}
13385
+ */
13386
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13387
+ }
13388
+ skillObfuscation?: {
13389
+ /**
13390
+ * @description The action to take for skillObfuscation issues.
13391
+ * @enum {string}
13392
+ */
13393
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13394
+ }
13395
+ skillPromptInjection?: {
13396
+ /**
13397
+ * @description The action to take for skillPromptInjection issues.
13398
+ * @enum {string}
13399
+ */
13400
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13401
+ }
13402
+ skillResourceAbuse?: {
13403
+ /**
13404
+ * @description The action to take for skillResourceAbuse issues.
13405
+ * @enum {string}
13406
+ */
13407
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13408
+ }
13409
+ skillSupplyChain?: {
13410
+ /**
13411
+ * @description The action to take for skillSupplyChain issues.
13412
+ * @enum {string}
13413
+ */
13414
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13415
+ }
13416
+ skillToolAbuse?: {
13417
+ /**
13418
+ * @description The action to take for skillToolAbuse issues.
13419
+ * @enum {string}
13420
+ */
13421
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13422
+ }
13423
+ skillToolChaining?: {
13424
+ /**
13425
+ * @description The action to take for skillToolChaining issues.
13426
+ * @enum {string}
13427
+ */
13428
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13429
+ }
13430
+ skillTransitiveTrust?: {
13431
+ /**
13432
+ * @description The action to take for skillTransitiveTrust issues.
13433
+ * @enum {string}
13434
+ */
13435
+ action: 'defer' | 'error' | 'warn' | 'monitor' | 'ignore'
13436
+ }
11925
13437
  socketUpgradeAvailable?: {
11926
13438
  /**
11927
13439
  * @description The action to take for socketUpgradeAvailable issues.
@@ -12919,6 +14431,14 @@ export interface operations {
12919
14431
  'filters.artifactType'?: string
12920
14432
  /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
12921
14433
  'filters.artifactType.notIn'?: string
14434
+ /** @description Comma-separated list of branch names that should be included */
14435
+ 'filters.branch'?: string
14436
+ /** @description Comma-separated list of branch names that should be excluded */
14437
+ 'filters.branch.notIn'?: string
14438
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included */
14439
+ 'filters.cvePatchStatus'?: string
14440
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded */
14441
+ 'filters.cvePatchStatus.notIn'?: string
12922
14442
  /** @description Dead/reachable dependency filter flag */
12923
14443
  'filters.dependencyDead'?: boolean
12924
14444
  /** @description Dead/reachable dependency filter flag */
@@ -13118,6 +14638,14 @@ export interface operations {
13118
14638
  artifactType?: string[]
13119
14639
  /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
13120
14640
  'artifactType.notIn'?: string[]
14641
+ /** @description Comma-separated list of branch names that should be included */
14642
+ branch?: string[]
14643
+ /** @description Comma-separated list of branch names that should be excluded */
14644
+ 'branch.notIn'?: string[]
14645
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included */
14646
+ cvePatchStatus?: string[]
14647
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded */
14648
+ 'cvePatchStatus.notIn'?: string[]
13121
14649
  /** @description Dead/reachable dependency filter flag */
13122
14650
  dependencyDead?: boolean[]
13123
14651
  /** @description Development/production dependency filter flag */
@@ -13163,7 +14691,7 @@ export interface operations {
13163
14691
  date?: string
13164
14692
  /** @description The number of days of data to fetch as an offset from input date */
13165
14693
  range?: string
13166
- /** @description Comma-separated list of fields that should be used for count aggregation (allowed: alertSeverity,repoSlug,repoFullName,repoLabels,alertType,artifactType,alertAction,alertActionSourceType,alertFixType,alertCategory,alertCveId,alertCveTitle,alertCweId,alertCweName,alertReachabilityType,alertReachabilityAnalysisType,alertPriority,alertKEV,alertEPSS,dependencyDirect,dependencyDev,dependencyDead) */
14694
+ /** @description Comma-separated list of fields that should be used for count aggregation (allowed: alertSeverity,repoSlug,repoFullName,branch,repoLabels,alertType,artifactType,alertAction,alertActionSourceType,alertFixType,alertCategory,alertCveId,alertCveTitle,alertCweId,alertCweName,alertReachabilityType,cvePatchStatus,alertReachabilityAnalysisType,alertPriority,alertKEV,alertEPSS,dependencyDirect,dependencyDev,dependencyDead) */
13167
14695
  'aggregation.fields'?: string
13168
14696
  /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
13169
14697
  'filters.alertAction'?: string
@@ -13233,6 +14761,14 @@ export interface operations {
13233
14761
  'filters.artifactType'?: string
13234
14762
  /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
13235
14763
  'filters.artifactType.notIn'?: string
14764
+ /** @description Comma-separated list of branch names that should be included */
14765
+ 'filters.branch'?: string
14766
+ /** @description Comma-separated list of branch names that should be excluded */
14767
+ 'filters.branch.notIn'?: string
14768
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included */
14769
+ 'filters.cvePatchStatus'?: string
14770
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded */
14771
+ 'filters.cvePatchStatus.notIn'?: string
13236
14772
  /** @description Dead/reachable dependency filter flag */
13237
14773
  'filters.dependencyDead'?: boolean
13238
14774
  /** @description Dead/reachable dependency filter flag */
@@ -13348,6 +14884,14 @@ export interface operations {
13348
14884
  artifactType?: string[]
13349
14885
  /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
13350
14886
  'artifactType.notIn'?: string[]
14887
+ /** @description Comma-separated list of branch names that should be included */
14888
+ branch?: string[]
14889
+ /** @description Comma-separated list of branch names that should be excluded */
14890
+ 'branch.notIn'?: string[]
14891
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included */
14892
+ cvePatchStatus?: string[]
14893
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded */
14894
+ 'cvePatchStatus.notIn'?: string[]
13351
14895
  /** @description Dead/reachable dependency filter flag */
13352
14896
  dependencyDead?: boolean[]
13353
14897
  /** @description Development/production dependency filter flag */
@@ -13728,8 +15272,11 @@ export interface operations {
13728
15272
  | 'ChangeMemberRole'
13729
15273
  | 'ChangePlanSubscriptionSeats'
13730
15274
  | 'CreateApiToken'
15275
+ | 'CreateArtifact'
13731
15276
  | 'CreateLabel'
13732
15277
  | 'CreateWebhook'
15278
+ | 'DeleteAlertTriage'
15279
+ | 'DeleteApiToken'
13733
15280
  | 'DeleteFullScan'
13734
15281
  | 'DeleteLabel'
13735
15282
  | 'DeleteLabelSetting'
@@ -13844,6 +15391,8 @@ export interface operations {
13844
15391
  per_page?: number
13845
15392
  /** @description The token specifying which page to return. */
13846
15393
  page?: number
15394
+ /** @description Whether to include token values in response. Use "omit" to exclude tokens entirely. */
15395
+ token_values?: 'include' | 'omit'
13847
15396
  }
13848
15397
  path: {
13849
15398
  /** @description The slug of the organization */
@@ -13892,6 +15441,17 @@ export interface operations {
13892
15441
  * @default
13893
15442
  */
13894
15443
  created_at: string
15444
+ /**
15445
+ * Format: uuid
15446
+ * @description The stable group UUID that remains constant across token rotations
15447
+ * @default
15448
+ */
15449
+ group_uuid: string
15450
+ /**
15451
+ * @description SRI-format hash of the token (e.g., sha512-base64hash). Null for tokens created before hash column was added.
15452
+ * @default
15453
+ */
15454
+ hash: string | null
13895
15455
  /**
13896
15456
  * @description The ID of the API Token
13897
15457
  * @default
@@ -13979,22 +15539,28 @@ export interface operations {
13979
15539
  | 'socket-basics:read'
13980
15540
  | 'telemetry-policy'
13981
15541
  | 'telemetry-policy:update'
15542
+ | 'telemetry-events'
15543
+ | 'telemetry-events:list'
13982
15544
  | 'threat-feed'
13983
15545
  | 'threat-feed:list'
13984
15546
  | 'triage'
13985
15547
  | 'triage:alerts-list'
13986
15548
  | 'triage:alerts-update'
15549
+ | 'uploaded-artifacts'
15550
+ | 'uploaded-artifacts:create'
15551
+ | 'uploaded-artifacts:list'
13987
15552
  | 'webhooks'
13988
15553
  | 'webhooks:create'
13989
15554
  | 'webhooks:list'
13990
15555
  | 'webhooks:update'
13991
15556
  | 'webhooks:delete'
15557
+ | '*'
13992
15558
  )[]
13993
15559
  /**
13994
- * @description The obfuscated token of the API Token
15560
+ * @description The token of the API Token (redacted or omitted)
13995
15561
  * @default
13996
15562
  */
13997
- token: string
15563
+ token: string | null
13998
15564
  /**
13999
15565
  * @description The visibility of the API Token. Warning: this field is deprecated and will be removed in the future.
14000
15566
  * @default organization
@@ -14103,16 +15669,22 @@ export interface operations {
14103
15669
  | 'socket-basics:read'
14104
15670
  | 'telemetry-policy'
14105
15671
  | 'telemetry-policy:update'
15672
+ | 'telemetry-events'
15673
+ | 'telemetry-events:list'
14106
15674
  | 'threat-feed'
14107
15675
  | 'threat-feed:list'
14108
15676
  | 'triage'
14109
15677
  | 'triage:alerts-list'
14110
15678
  | 'triage:alerts-update'
15679
+ | 'uploaded-artifacts'
15680
+ | 'uploaded-artifacts:create'
15681
+ | 'uploaded-artifacts:list'
14111
15682
  | 'webhooks'
14112
15683
  | 'webhooks:create'
14113
15684
  | 'webhooks:list'
14114
15685
  | 'webhooks:update'
14115
15686
  | 'webhooks:delete'
15687
+ | '*'
14116
15688
  >
14117
15689
  /**
14118
15690
  * @description The visibility of the API Token. Warning: this field is deprecated and will be removed in the future.
@@ -14171,18 +15743,26 @@ export interface operations {
14171
15743
  }
14172
15744
  }
14173
15745
  responses: {
14174
- /** @description The newly created api token. */
15746
+ /** @description The newly created api token with its stable UUID and hash. */
14175
15747
  200: {
14176
15748
  content: {
14177
15749
  'application/json': {
14178
15750
  /**
14179
15751
  * Format: uuid
14180
- * @description ID of the Socket user who created the API Token, if available
15752
+ * @description ID of the Socket user who created the API Token
14181
15753
  * @default
14182
15754
  */
14183
15755
  created_by: string | null
15756
+ /**
15757
+ * Format: uuid
15758
+ * @description The stable group UUID that remains constant across token rotations
15759
+ * @default
15760
+ */
15761
+ group_uuid: string
14184
15762
  /** @default */
14185
15763
  token: string
15764
+ /** @default */
15765
+ hash: string
14186
15766
  }
14187
15767
  }
14188
15768
  }
@@ -14282,22 +15862,23 @@ export interface operations {
14282
15862
  | 'socket-basics:read'
14283
15863
  | 'telemetry-policy'
14284
15864
  | 'telemetry-policy:update'
15865
+ | 'telemetry-events'
15866
+ | 'telemetry-events:list'
14285
15867
  | 'threat-feed'
14286
15868
  | 'threat-feed:list'
14287
15869
  | 'triage'
14288
15870
  | 'triage:alerts-list'
14289
15871
  | 'triage:alerts-update'
15872
+ | 'uploaded-artifacts'
15873
+ | 'uploaded-artifacts:create'
15874
+ | 'uploaded-artifacts:list'
14290
15875
  | 'webhooks'
14291
15876
  | 'webhooks:create'
14292
15877
  | 'webhooks:list'
14293
15878
  | 'webhooks:update'
14294
15879
  | 'webhooks:delete'
15880
+ | '*'
14295
15881
  >
14296
- /**
14297
- * @description The API token to update
14298
- * @default
14299
- */
14300
- token: string
14301
15882
  /**
14302
15883
  * @description The visibility of the API Token. Warning: this field is deprecated and will be removed in the future.
14303
15884
  * @default organization
@@ -14333,6 +15914,27 @@ export interface operations {
14333
15914
  * @default api token
14334
15915
  */
14335
15916
  name?: string
15917
+ /**
15918
+ * Format: uuid
15919
+ * @description The stable group UUID to update (provide uuid, id, token, or hash. May provide uuid+hash together for validation)
15920
+ * @default
15921
+ */
15922
+ uuid?: string
15923
+ /**
15924
+ * @description The API token ID to update (provide uuid, id, token, or hash)
15925
+ * @default
15926
+ */
15927
+ id?: string
15928
+ /**
15929
+ * @description The API token to update (provide uuid, id, token, or hash)
15930
+ * @default
15931
+ */
15932
+ token?: string
15933
+ /**
15934
+ * @description The API token hash to update (provide uuid, id, token, or hash)
15935
+ * @default
15936
+ */
15937
+ hash?: string
14336
15938
  }
14337
15939
  }
14338
15940
  }
@@ -14341,8 +15943,11 @@ export interface operations {
14341
15943
  200: {
14342
15944
  content: {
14343
15945
  'application/json': {
14344
- /** @default */
14345
- token: string
15946
+ /**
15947
+ * @description SRI-format hash of the API token (e.g., sha512-base64hash)
15948
+ * @default
15949
+ */
15950
+ hash: string
14346
15951
  }
14347
15952
  }
14348
15953
  }
@@ -14367,28 +15972,49 @@ export interface operations {
14367
15972
  org_slug: string
14368
15973
  }
14369
15974
  }
14370
- /** @description The API Token to rotate */
15975
+ /** @description The API Token identifier to rotate. Provide uuid (recommended), token, or hash. May provide uuid+hash together for validation. */
14371
15976
  requestBody?: {
14372
15977
  content: {
14373
15978
  'application/json': {
15979
+ /**
15980
+ * Format: uuid
15981
+ * @description The stable group UUID of the API token to rotate
15982
+ * @default
15983
+ */
15984
+ uuid?: string
15985
+ /** @default */
15986
+ token?: string
14374
15987
  /** @default */
14375
- token: string
15988
+ hash?: string
14376
15989
  }
14377
15990
  }
14378
15991
  }
14379
15992
  responses: {
14380
- /** @description The replacement API Token */
15993
+ /** @description The replacement API Token with its stable UUID, new token value, and hash */
14381
15994
  200: {
14382
15995
  content: {
14383
15996
  'application/json': {
15997
+ /**
15998
+ * @description The database ID of the new API token
15999
+ * @default
16000
+ */
16001
+ id: string
16002
+ /**
16003
+ * Format: uuid
16004
+ * @description The stable group UUID (unchanged after rotation)
16005
+ * @default
16006
+ */
16007
+ group_uuid: string
14384
16008
  /**
14385
16009
  * Format: uuid
14386
- * @description ID of the Socket user who initiated the rotation, if available
16010
+ * @description ID of the Socket user who created the API Token
14387
16011
  * @default
14388
16012
  */
14389
16013
  created_by: string | null
14390
16014
  /** @default */
14391
16015
  token: string
16016
+ /** @default */
16017
+ hash: string
14392
16018
  }
14393
16019
  }
14394
16020
  }
@@ -14413,12 +16039,20 @@ export interface operations {
14413
16039
  org_slug: string
14414
16040
  }
14415
16041
  }
14416
- /** @description The token to revoke. */
16042
+ /** @description The API token identifier to revoke. Provide uuid (recommended), token, or hash. May provide uuid+hash together for validation. */
14417
16043
  requestBody?: {
14418
16044
  content: {
14419
16045
  'application/json': {
16046
+ /**
16047
+ * Format: uuid
16048
+ * @description The stable group UUID of the API token to revoke
16049
+ * @default
16050
+ */
16051
+ uuid?: string
14420
16052
  /** @default */
14421
- token: string
16053
+ token?: string
16054
+ /** @default */
16055
+ hash?: string
14422
16056
  }
14423
16057
  }
14424
16058
  }
@@ -14505,7 +16139,7 @@ export interface operations {
14505
16139
  discovery_period?: '1h' | '6h' | '1d' | '7d' | '30d' | '90d' | '365d'
14506
16140
  /** @description Ordering direction of the sort attribute */
14507
16141
  direction?: 'desc' | 'asc'
14508
- /** @description Filter what type of threats to return */
16142
+ /** @description Filter by threat classification. Supported values: `mal` (malware, including possible malware), `vuln` (vulnerability), `typo` (typosquat, including possible typosquat), `anom` (anomaly), `spy` (telemetry), `obf` (obfuscated code), `dual` (dual-use tool), `joke` (protestware or joke package), `tp` (all confirmed true positives), `fp` (false positive), `u` (unreviewed), `c` (classified, i.e. anything except unreviewed). */
14509
16143
  filter?:
14510
16144
  | 'u'
14511
16145
  | 'c'
@@ -14517,7 +16151,6 @@ export interface operations {
14517
16151
  | 'joke'
14518
16152
  | 'spy'
14519
16153
  | 'typo'
14520
- | 'secret'
14521
16154
  | 'obf'
14522
16155
  | 'dual'
14523
16156
  /** @description Filter threats by package name */
@@ -14526,10 +16159,11 @@ export interface operations {
14526
16159
  version?: string
14527
16160
  /** @description Only return threats which have been human-reviewed */
14528
16161
  is_human_reviewed?: boolean
14529
- /** @description Filter threats by package ecosystem type */
16162
+ /** @description Filter threats by package ecosystem. */
14530
16163
  ecosystem?:
14531
16164
  | 'github'
14532
16165
  | 'cargo'
16166
+ | 'clawhub'
14533
16167
  | 'composer'
14534
16168
  | 'chrome'
14535
16169
  | 'golang'
@@ -14540,6 +16174,7 @@ export interface operations {
14540
16174
  | 'vscode'
14541
16175
  | 'pypi'
14542
16176
  | 'gem'
16177
+ | 'swift'
14543
16178
  }
14544
16179
  }
14545
16180
  responses: {
@@ -14548,23 +16183,61 @@ export interface operations {
14548
16183
  content: {
14549
16184
  'application/json': {
14550
16185
  results: Array<{
14551
- /** @default */
16186
+ /**
16187
+ * Format: date-time
16188
+ * @description ISO 8601 timestamp of when the threat in the package artifact was first discovered
16189
+ * @default
16190
+ */
14552
16191
  createdAt?: string
14553
- /** @default */
16192
+ /**
16193
+ * Format: date-time
16194
+ * @description ISO 8601 timestamp of when the threat record for the package artifact was last updated (e.g., classification changed, package removed from registry, etc.)
16195
+ * @default
16196
+ */
14554
16197
  updatedAt?: string
14555
- /** @default */
16198
+ /**
16199
+ * Format: date-time
16200
+ * @description ISO 8601 timestamp of when the package artifact was published to the respective registry
16201
+ * @default
16202
+ */
16203
+ publishedAt?: string | null
16204
+ /**
16205
+ * @description Detailed description of the underlying threat
16206
+ * @default
16207
+ */
14556
16208
  description?: string
14557
- /** @default 0 */
16209
+ /**
16210
+ * @description Unique identifier of the threat feed entry
16211
+ * @default 0
16212
+ */
14558
16213
  id?: number
14559
- /** @default */
16214
+ /**
16215
+ * Format: uri
16216
+ * @description URL to the threat details page on Socket
16217
+ * @default
16218
+ */
14560
16219
  locationHtmlUrl?: string
14561
- /** @default */
16220
+ /**
16221
+ * Format: uri
16222
+ * @description URL to the affected package page on Socket
16223
+ * @default
16224
+ */
14562
16225
  packageHtmlUrl?: string
14563
- /** @default */
16226
+ /**
16227
+ * @description Package URL (PURL) of the affected package artifact
16228
+ * @default
16229
+ */
14564
16230
  purl?: string
14565
- /** @default */
16231
+ /**
16232
+ * Format: date-time
16233
+ * @description ISO 8601 timestamp of when the package artifact was removed from the respective registry, or null if the package is still available on the registry
16234
+ * @default
16235
+ */
14566
16236
  removedAt?: string | null
14567
- /** @default */
16237
+ /**
16238
+ * @description Threat classification. Possible values: `malware` (known malware), `possible_malware` (AI-detected potential malware), `vulnerability` (potential vulnerability), `typosquat` (human-reviewed typosquat), `possible_typosquat` (AI-detected potential typosquat), `anomaly` (anomalous behavior), `telemetry` (telemetry), `obfuscated` (obfuscated code), `dual_use` (dual-use tool), `troll` (protestware or joke package), `unreviewed` (not yet reviewed), `false_positive` (confirmed false positive).
16239
+ * @default
16240
+ */
14568
16241
  threatType?: string
14569
16242
  /**
14570
16243
  * @description Whether the threat still is in need of human review by the threat research team
@@ -14595,105 +16268,290 @@ export interface operations {
14595
16268
  *
14596
16269
  * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
14597
16270
  *
14598
- * This endpoint consumes 1 unit of your quota.
16271
+ * This endpoint consumes 1 unit of your quota.
16272
+ *
16273
+ * This endpoint requires the following org token scopes:
16274
+ * - threat-feed:list
16275
+ */
16276
+ getOrgThreatFeedItems: {
16277
+ parameters: {
16278
+ query?: {
16279
+ /** @description Number of threats per page */
16280
+ per_page?: number
16281
+ /** @description Page cursor token. Pass the returned nextPageCursor to this query string to fetch the next page of the threat feed. */
16282
+ page_cursor?: string
16283
+ /** @description Set the sort order for the threat feed items. Default is descending order by updated_at, which includes all new and updated threat feed items. */
16284
+ sort?: 'id' | 'created_at' | 'updated_at'
16285
+ /** @description A Unix timestamp in seconds that filters results to items only updated after the timestamp. */
16286
+ updated_after?: string
16287
+ /** @description A Unix timestamp in seconds that filters results to items only created after the date. */
16288
+ created_after?: string
16289
+ /** @description Order direction of the provided sort field. */
16290
+ direction?: 'desc' | 'asc'
16291
+ /** @description Filter by threat classification. Supported values: `mal` (malware, including possible malware), `vuln` (vulnerability), `typo` (typosquat, including possible typosquat), `anom` (anomaly), `spy` (telemetry), `obf` (obfuscated code), `dual` (dual-use tool), `joke` (protestware or joke package), `tp` (all confirmed true positives), `fp` (false positive), `u` (unreviewed), `c` (classified, i.e. anything except unreviewed). */
16292
+ filter?:
16293
+ | 'u'
16294
+ | 'c'
16295
+ | 'fp'
16296
+ | 'tp'
16297
+ | 'mal'
16298
+ | 'vuln'
16299
+ | 'anom'
16300
+ | 'joke'
16301
+ | 'spy'
16302
+ | 'typo'
16303
+ | 'obf'
16304
+ | 'dual'
16305
+ /** @description Filter threats by package name */
16306
+ name?: string
16307
+ /** @description Filter threats by package version. */
16308
+ version?: string
16309
+ /** @description Only return threats which have been human-reviewed */
16310
+ is_human_reviewed?: boolean
16311
+ /** @description Filter threats by package ecosystem. */
16312
+ ecosystem?:
16313
+ | 'github'
16314
+ | 'cargo'
16315
+ | 'clawhub'
16316
+ | 'composer'
16317
+ | 'chrome'
16318
+ | 'golang'
16319
+ | 'huggingface'
16320
+ | 'maven'
16321
+ | 'npm'
16322
+ | 'nuget'
16323
+ | 'vscode'
16324
+ | 'pypi'
16325
+ | 'gem'
16326
+ | 'swift'
16327
+ }
16328
+ path: {
16329
+ /** @description The slug of the organization */
16330
+ org_slug: string
16331
+ }
16332
+ }
16333
+ responses: {
16334
+ /** @description The paginated list of items in the threat feed and the next page cursor. */
16335
+ 200: {
16336
+ content: {
16337
+ 'application/json': {
16338
+ results: Array<{
16339
+ /**
16340
+ * Format: date-time
16341
+ * @description ISO 8601 timestamp of when the threat in the package artifact was first discovered
16342
+ * @default
16343
+ */
16344
+ createdAt?: string
16345
+ /**
16346
+ * Format: date-time
16347
+ * @description ISO 8601 timestamp of when the threat record for the package artifact was last updated (e.g., classification changed, package removed from registry, etc.)
16348
+ * @default
16349
+ */
16350
+ updatedAt?: string
16351
+ /**
16352
+ * Format: date-time
16353
+ * @description ISO 8601 timestamp of when the package artifact was published to the respective registry
16354
+ * @default
16355
+ */
16356
+ publishedAt?: string | null
16357
+ /**
16358
+ * @description Detailed description of the underlying threat
16359
+ * @default
16360
+ */
16361
+ description?: string
16362
+ /**
16363
+ * @description Unique identifier of the threat feed entry
16364
+ * @default 0
16365
+ */
16366
+ id?: number
16367
+ /**
16368
+ * Format: uri
16369
+ * @description URL to the threat details page on Socket
16370
+ * @default
16371
+ */
16372
+ locationHtmlUrl?: string
16373
+ /**
16374
+ * Format: uri
16375
+ * @description URL to the affected package page on Socket
16376
+ * @default
16377
+ */
16378
+ packageHtmlUrl?: string
16379
+ /**
16380
+ * @description Package URL (PURL) of the affected package artifact
16381
+ * @default
16382
+ */
16383
+ purl?: string
16384
+ /**
16385
+ * Format: date-time
16386
+ * @description ISO 8601 timestamp of when the package artifact was removed from the respective registry, or null if the package is still available on the registry
16387
+ * @default
16388
+ */
16389
+ removedAt?: string | null
16390
+ /**
16391
+ * @description Threat classification. Possible values: `malware` (known malware), `possible_malware` (AI-detected potential malware), `vulnerability` (potential vulnerability), `typosquat` (human-reviewed typosquat), `possible_typosquat` (AI-detected potential typosquat), `anomaly` (anomalous behavior), `telemetry` (telemetry), `obfuscated` (obfuscated code), `dual_use` (dual-use tool), `troll` (protestware or joke package), `unreviewed` (not yet reviewed), `false_positive` (confirmed false positive).
16392
+ * @default
16393
+ */
16394
+ threatType?: string
16395
+ /**
16396
+ * @description Whether the threat still is in need of human review by the threat research team
16397
+ * @default false
16398
+ */
16399
+ needsHumanReview?: boolean
16400
+ /**
16401
+ * @description Unique threat instance identifier across artifacts
16402
+ * @default 0
16403
+ */
16404
+ threatInstanceId?: number
16405
+ }>
16406
+ /** @default */
16407
+ nextPageCursor: string | null
16408
+ }
16409
+ }
16410
+ }
16411
+ 400: components['responses']['SocketBadRequest']
16412
+ 401: components['responses']['SocketUnauthorized']
16413
+ 403: components['responses']['SocketForbidden']
16414
+ 404: components['responses']['SocketNotFoundResponse']
16415
+ 429: components['responses']['SocketTooManyRequestsResponse']
16416
+ }
16417
+ }
16418
+ /**
16419
+ * Get Packages by PURL (Org Scoped)
16420
+ * @description Batch retrieval of package metadata and alerts by PURL strings for a specific organization. Compatible with CycloneDX reports.
16421
+ *
16422
+ * Package URLs (PURLs) are an ecosystem agnostic way to identify packages.
16423
+ * CycloneDX SBOMs use the purl format to identify components.
16424
+ * This endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.
16425
+ *
16426
+ * **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
16427
+ *
16428
+ * More information on purl and CycloneDX:
16429
+ *
16430
+ * - [`purl` Spec](https://github.com/package-url/purl-spec)
16431
+ * - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
16432
+ *
16433
+ * This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
16434
+ * Actively running analysis will be returned when available on subsequent runs.
16435
+ *
16436
+ * ## Query Parameters
16437
+ *
16438
+ * This endpoint supports all query parameters from `POST /v0/purl` including: `alerts`, `actions`, `compact`, `fixable`, `licenseattrib`, `licensedetails`, `purlErrors`, `cachedResultsOnly`, and `summary`.
16439
+ *
16440
+ * Additionally, you may provide a `labels` query parameter to apply a repository label's security policies. Pass the label slug as the value (e.g., `?labels=production`). Only one label is currently supported.
16441
+ *
16442
+ * ## Examples:
16443
+ *
16444
+ * ### Looking up an npm package:
16445
+ *
16446
+ * ```json
16447
+ * {
16448
+ * "components": [
16449
+ * {
16450
+ * "purl": "pkg:npm/express@4.19.2"
16451
+ * }
16452
+ * ]
16453
+ * }
16454
+ * ```
16455
+ *
16456
+ * ### Looking up a PyPi package:
16457
+ *
16458
+ * ```json
16459
+ * {
16460
+ * "components": [
16461
+ * {
16462
+ * "purl": "pkg:pypi/django@5.0.6"
16463
+ * }
16464
+ * ]
16465
+ * }
16466
+ * ```
16467
+ *
16468
+ * ### Looking up a Maven package:
16469
+ *
16470
+ * ```json
16471
+ * {
16472
+ * "components": [
16473
+ * {
16474
+ * "purl": "pkg:maven/log4j/log4j@1.2.17"
16475
+ * }
16476
+ * ]
16477
+ * }
16478
+ * ```
16479
+ *
16480
+ * ### Batch lookup
16481
+ *
16482
+ * ```json
16483
+ * {
16484
+ * "components": [
16485
+ * {
16486
+ * "purl": "pkg:npm/express@4.19.2"
16487
+ * },
16488
+ * {
16489
+ * "purl": "pkg:pypi/django@5.0.6"
16490
+ * },
16491
+ * {
16492
+ * "purl": "pkg:maven/log4j/log4j@1.2.17"
16493
+ * }
16494
+ * ]
16495
+ * }
16496
+ * ```
16497
+ *
16498
+ * ### With label and options (query parameters):
16499
+ *
16500
+ * ```
16501
+ * POST /v0/orgs/{org_slug}/purl?labels=production&alerts=true&compact=true
16502
+ * {
16503
+ * "components": [
16504
+ * {
16505
+ * "purl": "pkg:npm/express@4.19.2"
16506
+ * }
16507
+ * ]
16508
+ * }
16509
+ * ```
16510
+ *
16511
+ * This endpoint consumes 100 units of your quota.
14599
16512
  *
14600
16513
  * This endpoint requires the following org token scopes:
14601
- * - threat-feed:list
16514
+ * - packages:list
14602
16515
  */
14603
- getOrgThreatFeedItems: {
16516
+ batchPackageFetchByOrg: {
14604
16517
  parameters: {
14605
16518
  query?: {
14606
- /** @description Number of threats per page */
14607
- per_page?: number
14608
- /** @description Page cursor token. Pass the returned nextPageCursor to this query string to fetch the next page of the threat feed. */
14609
- page_cursor?: string
14610
- /** @description Set the sort order for the threat feed items. Default is descending order by updated_at, which includes all new and updated threat feed items. */
14611
- sort?: 'id' | 'created_at' | 'updated_at'
14612
- /** @description A Unix timestamp in seconds that filters results to items only updated after the timestamp. */
14613
- updated_after?: string
14614
- /** @description A Unix timestamp in seconds that filters results to items only created after the date. */
14615
- created_after?: string
14616
- /** @description Order direction of the provided sort field. */
14617
- direction?: 'desc' | 'asc'
14618
- /** @description Filter what type of threats to return */
14619
- filter?:
14620
- | 'u'
14621
- | 'c'
14622
- | 'fp'
14623
- | 'tp'
14624
- | 'mal'
14625
- | 'vuln'
14626
- | 'anom'
14627
- | 'joke'
14628
- | 'spy'
14629
- | 'typo'
14630
- | 'secret'
14631
- | 'obf'
14632
- | 'dual'
14633
- /** @description Filter threats by package name */
14634
- name?: string
14635
- /** @description Filter threats by package version. */
14636
- version?: string
14637
- /** @description Only return threats which have been human-reviewed */
14638
- is_human_reviewed?: boolean
14639
- /** @description Filter threats by package ecosystem type */
14640
- ecosystem?:
14641
- | 'github'
14642
- | 'cargo'
14643
- | 'composer'
14644
- | 'chrome'
14645
- | 'golang'
14646
- | 'huggingface'
14647
- | 'maven'
14648
- | 'npm'
14649
- | 'nuget'
14650
- | 'vscode'
14651
- | 'pypi'
14652
- | 'gem'
16519
+ /** @description Repository label slugs to apply policies. Only one label is supported currently; the parameter is an array to allow future support for multiple labels. */
16520
+ labels?: string[]
16521
+ /** @description Include alert metadata. */
16522
+ alerts?: boolean
16523
+ /** @description Include only alerts with comma separated actions defined by security policy. */
16524
+ actions?: Array<'error' | 'monitor' | 'warn' | 'ignore'>
16525
+ /** @description Compact metadata. When enabled, excludes metadata fields like author, scores, size, dependencies, and manifest files. Always includes: id, type, name, version, release, namespace, subpath, alerts, and alertPriorities. */
16526
+ compact?: boolean
16527
+ /** @description Include only fixable alerts. */
16528
+ fixable?: boolean
16529
+ /** @description Include license attribution data, including license text and author information. Maps attribution/license text to a list of data objects to which that attribution info applies. */
16530
+ licenseattrib?: boolean
16531
+ /** @description Include detailed license information, including location and match strength, for each license datum. */
16532
+ licensedetails?: boolean
16533
+ /** @description Return errors found with handling PURLs as error objects in the stream. */
16534
+ purlErrors?: boolean
16535
+ /** @description Return only cached results, do not attempt to scan new artifacts or rescan stale results. */
16536
+ cachedResultsOnly?: boolean
16537
+ /** @description Include a summary object at the end of the stream with counts of malformed, resolved, and not found PURLs. */
16538
+ summary?: boolean
14653
16539
  }
14654
16540
  path: {
14655
16541
  /** @description The slug of the organization */
14656
16542
  org_slug: string
14657
16543
  }
14658
16544
  }
16545
+ requestBody?: {
16546
+ content: {
16547
+ 'application/json': components['schemas']['SocketOrgBatchPURLFetch']
16548
+ }
16549
+ }
14659
16550
  responses: {
14660
- /** @description The paginated list of items in the threat feed and the next page cursor. */
16551
+ /** @description Socket issue lists and scores for all packages, and optional metadata objects */
14661
16552
  200: {
14662
16553
  content: {
14663
- 'application/json': {
14664
- results: Array<{
14665
- /** @default */
14666
- createdAt?: string
14667
- /** @default */
14668
- updatedAt?: string
14669
- /** @default */
14670
- description?: string
14671
- /** @default 0 */
14672
- id?: number
14673
- /** @default */
14674
- locationHtmlUrl?: string
14675
- /** @default */
14676
- packageHtmlUrl?: string
14677
- /** @default */
14678
- purl?: string
14679
- /** @default */
14680
- removedAt?: string | null
14681
- /** @default */
14682
- threatType?: string
14683
- /**
14684
- * @description Whether the threat still is in need of human review by the threat research team
14685
- * @default false
14686
- */
14687
- needsHumanReview?: boolean
14688
- /**
14689
- * @description Unique threat instance identifier across artifacts
14690
- * @default 0
14691
- */
14692
- threatInstanceId?: number
14693
- }>
14694
- /** @default */
14695
- nextPageCursor: string | null
14696
- }
16554
+ 'application/x-ndjson': components['schemas']['BatchPurlStreamSchema']
14697
16555
  }
14698
16556
  }
14699
16557
  400: components['responses']['SocketBadRequest']
@@ -14709,6 +16567,57 @@ export interface operations {
14709
16567
  * Requires either repo_slug or full_scan_id as well as vulnerability_ids to be provided.
14710
16568
  * vulnerability_ids can be a comma-separated list of GHSA or CVE IDs, or "*" for all vulnerabilities.
14711
16569
  *
16570
+ * ## Response Structure
16571
+ *
16572
+ * The response contains a `fixDetails` object where each key is a vulnerability ID (GHSA or CVE) and the value is a discriminated union based on the `type` field.
16573
+ *
16574
+ * ### Common Fields
16575
+ *
16576
+ * All response variants include:
16577
+ * - `type`: Discriminator field (one of: "fixFound", "partialFixFound", "noFixAvailable", "fixNotApplicable", "errorComputingFix")
16578
+ * - `value`: Object containing the variant-specific data
16579
+ *
16580
+ * The `value` object always contains:
16581
+ * - `ghsa`: string | null - The GHSA ID
16582
+ * - `cve`: string | null - The CVE ID (if available)
16583
+ * - `advisoryDetails`: object | null - Advisory details (only if include_details=true)
16584
+ *
16585
+ * ### Response Variants
16586
+ *
16587
+ * **fixFound**: A complete fix is available for all vulnerable packages
16588
+ * - `value.fixDetails.fixes`: Array of fix objects, each containing:
16589
+ * - `purl`: Package URL to upgrade
16590
+ * - `fixedVersion`: Version to upgrade to
16591
+ * - `manifestFiles`: Array of manifest files containing the package
16592
+ * - `updateType`: "patch" | "minor" | "major" | "unknown"
16593
+ * - `value.fixDetails.responsibleDirectDependencies`: (optional) Map of direct dependencies responsible for the vulnerability
16594
+ *
16595
+ * **partialFixFound**: Fixes available for some but not all vulnerable packages
16596
+ * - Same as fixFound, plus:
16597
+ * - `value.fixDetails.unfixablePurls`: Array of packages that cannot be fixed, each containing:
16598
+ * - `purl`: Package URL
16599
+ * - `manifestFiles`: Array of manifest files
16600
+ *
16601
+ * **noFixAvailable**: No fix exists for this vulnerability (no patched version published)
16602
+ *
16603
+ * **fixNotApplicable**: A fix exists but cannot be applied due to version constraints
16604
+ * - `value.vulnerableArtifacts`: Array of vulnerable packages with their manifest files
16605
+ *
16606
+ * **errorComputingFix**: An error occurred while computing fixes
16607
+ * - `value.message`: Error description
16608
+ *
16609
+ * ### Advisory Details (when include_details=true)
16610
+ *
16611
+ * - `title`: string | null
16612
+ * - `description`: string | null
16613
+ * - `cwes`: string[] - CWE identifiers
16614
+ * - `severity`: "LOW" | "MODERATE" | "HIGH" | "CRITICAL"
16615
+ * - `cvssVector`: string | null
16616
+ * - `publishedAt`: string (ISO date)
16617
+ * - `kev`: boolean - Whether it's a Known Exploited Vulnerability
16618
+ * - `epss`: number | null - Exploit Prediction Scoring System score
16619
+ * - `affectedPurls`: Array of affected packages with version ranges
16620
+ *
14712
16621
  * This endpoint consumes 10 units of your quota.
14713
16622
  *
14714
16623
  * This endpoint requires the following org token scopes:
@@ -14742,385 +16651,8 @@ export interface operations {
14742
16651
  200: {
14743
16652
  content: {
14744
16653
  'application/json': {
14745
- /** @description Map of vulnerability IDs (GHSA or CVE) to their fix details. Each entry contains information about available fixes, partial fixes, or reasons why fixes are not available. */
14746
16654
  fixDetails: {
14747
- [key: string]:
14748
- | {
14749
- /** @enum {string} */
14750
- type: 'fixFound'
14751
- value: {
14752
- /**
14753
- * @default fixFound
14754
- * @enum {string}
14755
- */
14756
- type: 'fixFound'
14757
- /** @default */
14758
- ghsa: string
14759
- /** @default */
14760
- cve: string | null
14761
- fixDetails: {
14762
- fixes: Array<{
14763
- /** @default The PURL (unique package identifier) of the package to upgrade */
14764
- purl: string
14765
- /** @default The version of the package to upgrade to */
14766
- fixedVersion: string
14767
- manifestFiles: string[]
14768
- /**
14769
- * @description The type of version update (patch, minor, major, or unknown if it cannot be determined)
14770
- * @default unknown
14771
- * @enum {string}
14772
- */
14773
- updateType: 'patch' | 'minor' | 'major' | 'unknown'
14774
- }>
14775
- /** @description The keys are the PURL (unique package identifier) of the direct dependency(ies) responsible for introducing the vulnerability. */
14776
- responsibleDirectDependencies?: {
14777
- [key: string]: {
14778
- /**
14779
- * Format: The current version of the package
14780
- * @default
14781
- */
14782
- currentVersion: string
14783
- nextAvailableVersion?: {
14784
- /**
14785
- * Format: The next available version of the package
14786
- * @default
14787
- */
14788
- version: string
14789
- /**
14790
- * @description The type of version update (patch, minor, major, or unknown if it cannot be determined)
14791
- * @default unknown
14792
- * @enum {string}
14793
- */
14794
- updateType:
14795
- | 'patch'
14796
- | 'minor'
14797
- | 'major'
14798
- | 'unknown'
14799
- } | null
14800
- /** @description The version and update type of the package that is necessary to fix the vulnerability. If the value is null, it means the package does not have to be upgraded to fix the vulnerability */
14801
- fixByUpgradingTo?: {
14802
- /** @default */
14803
- version: string
14804
- /**
14805
- * @description The type of version update (patch, minor, major, or unknown if it cannot be determined)
14806
- * @default unknown
14807
- * @enum {string}
14808
- */
14809
- updateType:
14810
- | 'patch'
14811
- | 'minor'
14812
- | 'major'
14813
- | 'unknown'
14814
- } | null
14815
- }
14816
- } | null
14817
- }
14818
- advisoryDetails: {
14819
- /** @default */
14820
- title?: string | null
14821
- /** @default */
14822
- description?: string | null
14823
- cwes?: string[]
14824
- /**
14825
- * @description Severity level of the vulnerability
14826
- * @default LOW
14827
- * @enum {string}
14828
- */
14829
- severity?: 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL'
14830
- /** @default */
14831
- cvssVector?: string | null
14832
- /** @default */
14833
- publishedAt?: string
14834
- /**
14835
- * @description Whether the vulnerability is a Known Exploited Vulnerability
14836
- * @default false
14837
- */
14838
- kev?: boolean
14839
- /**
14840
- * @description Exploit Prediction Scoring System score
14841
- * @default 0
14842
- */
14843
- epss?: number | null
14844
- affectedPurls?: Array<{
14845
- /**
14846
- * Format: The PURL (unique package identifier) of the affected package
14847
- * @default
14848
- */
14849
- purl: string
14850
- /** @default The range of vulnerable versions */
14851
- affectedRange: string
14852
- }>
14853
- } | null
14854
- }
14855
- }
14856
- | {
14857
- /** @enum {string} */
14858
- type: 'partialFixFound'
14859
- value: {
14860
- /**
14861
- * @default partialFixFound
14862
- * @enum {string}
14863
- */
14864
- type: 'partialFixFound'
14865
- /** @default */
14866
- ghsa: string
14867
- /** @default */
14868
- cve: string | null
14869
- fixDetails: {
14870
- fixes: Array<{
14871
- /** @default The PURL (unique package identifier) of the package to upgrade */
14872
- purl: string
14873
- /** @default The version of the package to upgrade to */
14874
- fixedVersion: string
14875
- manifestFiles: string[]
14876
- /**
14877
- * @description The type of version update (patch, minor, major, or unknown if it cannot be determined)
14878
- * @default unknown
14879
- * @enum {string}
14880
- */
14881
- updateType: 'patch' | 'minor' | 'major' | 'unknown'
14882
- }>
14883
- unfixablePurls: Array<{
14884
- /** @default The PURL (unique package identifier) of the package that cannot be upgraded */
14885
- purl: string
14886
- manifestFiles: string[]
14887
- }>
14888
- /** @description The keys are the PURL (unique package identifier) of the direct dependency(ies) responsible for introducing the vulnerability. */
14889
- responsibleDirectDependencies?: {
14890
- [key: string]: {
14891
- /**
14892
- * Format: The current version of the package
14893
- * @default
14894
- */
14895
- currentVersion: string
14896
- nextAvailableVersion?: {
14897
- /**
14898
- * Format: The next available version of the package
14899
- * @default
14900
- */
14901
- version: string
14902
- /**
14903
- * @description The type of version update (patch, minor, major, or unknown if it cannot be determined)
14904
- * @default unknown
14905
- * @enum {string}
14906
- */
14907
- updateType:
14908
- | 'patch'
14909
- | 'minor'
14910
- | 'major'
14911
- | 'unknown'
14912
- } | null
14913
- /** @description The version and update type of the package that is necessary to fix the vulnerability. If the value is null, it means the package does not have to be upgraded to fix the vulnerability */
14914
- fixByUpgradingTo?: {
14915
- /** @default */
14916
- version: string
14917
- /**
14918
- * @description The type of version update (patch, minor, major, or unknown if it cannot be determined)
14919
- * @default unknown
14920
- * @enum {string}
14921
- */
14922
- updateType:
14923
- | 'patch'
14924
- | 'minor'
14925
- | 'major'
14926
- | 'unknown'
14927
- } | null
14928
- }
14929
- } | null
14930
- }
14931
- advisoryDetails: {
14932
- /** @default */
14933
- title?: string | null
14934
- /** @default */
14935
- description?: string | null
14936
- cwes?: string[]
14937
- /**
14938
- * @description Severity level of the vulnerability
14939
- * @default LOW
14940
- * @enum {string}
14941
- */
14942
- severity?: 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL'
14943
- /** @default */
14944
- cvssVector?: string | null
14945
- /** @default */
14946
- publishedAt?: string
14947
- /**
14948
- * @description Whether the vulnerability is a Known Exploited Vulnerability
14949
- * @default false
14950
- */
14951
- kev?: boolean
14952
- /**
14953
- * @description Exploit Prediction Scoring System score
14954
- * @default 0
14955
- */
14956
- epss?: number | null
14957
- affectedPurls?: Array<{
14958
- /**
14959
- * Format: The PURL (unique package identifier) of the affected package
14960
- * @default
14961
- */
14962
- purl: string
14963
- /** @default The range of vulnerable versions */
14964
- affectedRange: string
14965
- }>
14966
- } | null
14967
- }
14968
- }
14969
- | {
14970
- /** @enum {string} */
14971
- type: 'errorComputingFix'
14972
- value: {
14973
- /**
14974
- * @default errorComputingFix
14975
- * @enum {string}
14976
- */
14977
- type: 'errorComputingFix'
14978
- /** @default */
14979
- ghsa: string | null
14980
- /** @default */
14981
- cve: string | null
14982
- /** @default */
14983
- message: string
14984
- advisoryDetails: {
14985
- /** @default */
14986
- title?: string | null
14987
- /** @default */
14988
- description?: string | null
14989
- cwes?: string[]
14990
- /**
14991
- * @description Severity level of the vulnerability
14992
- * @default LOW
14993
- * @enum {string}
14994
- */
14995
- severity?: 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL'
14996
- /** @default */
14997
- cvssVector?: string | null
14998
- /** @default */
14999
- publishedAt?: string
15000
- /**
15001
- * @description Whether the vulnerability is a Known Exploited Vulnerability
15002
- * @default false
15003
- */
15004
- kev?: boolean
15005
- /**
15006
- * @description Exploit Prediction Scoring System score
15007
- * @default 0
15008
- */
15009
- epss?: number | null
15010
- affectedPurls?: Array<{
15011
- /**
15012
- * Format: The PURL (unique package identifier) of the affected package
15013
- * @default
15014
- */
15015
- purl: string
15016
- /** @default The range of vulnerable versions */
15017
- affectedRange: string
15018
- }>
15019
- } | null
15020
- }
15021
- }
15022
- | {
15023
- /** @enum {string} */
15024
- type: 'noFixAvailable'
15025
- value: {
15026
- /**
15027
- * @default noFixAvailable
15028
- * @enum {string}
15029
- */
15030
- type: 'noFixAvailable'
15031
- /** @default */
15032
- ghsa: string
15033
- /** @default */
15034
- cve: string | null
15035
- advisoryDetails: {
15036
- /** @default */
15037
- title?: string | null
15038
- /** @default */
15039
- description?: string | null
15040
- cwes?: string[]
15041
- /**
15042
- * @description Severity level of the vulnerability
15043
- * @default LOW
15044
- * @enum {string}
15045
- */
15046
- severity?: 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL'
15047
- /** @default */
15048
- cvssVector?: string | null
15049
- /** @default */
15050
- publishedAt?: string
15051
- /**
15052
- * @description Whether the vulnerability is a Known Exploited Vulnerability
15053
- * @default false
15054
- */
15055
- kev?: boolean
15056
- /**
15057
- * @description Exploit Prediction Scoring System score
15058
- * @default 0
15059
- */
15060
- epss?: number | null
15061
- affectedPurls?: Array<{
15062
- /**
15063
- * Format: The PURL (unique package identifier) of the affected package
15064
- * @default
15065
- */
15066
- purl: string
15067
- /** @default The range of vulnerable versions */
15068
- affectedRange: string
15069
- }>
15070
- } | null
15071
- }
15072
- }
15073
- | {
15074
- /** @enum {string} */
15075
- type: 'fixNotApplicable'
15076
- value: {
15077
- /**
15078
- * @default fixNotApplicable
15079
- * @enum {string}
15080
- */
15081
- type: 'fixNotApplicable'
15082
- /** @default */
15083
- ghsa: string
15084
- /** @default */
15085
- cve: string | null
15086
- advisoryDetails: {
15087
- /** @default */
15088
- title?: string | null
15089
- /** @default */
15090
- description?: string | null
15091
- cwes?: string[]
15092
- /**
15093
- * @description Severity level of the vulnerability
15094
- * @default LOW
15095
- * @enum {string}
15096
- */
15097
- severity?: 'LOW' | 'MODERATE' | 'HIGH' | 'CRITICAL'
15098
- /** @default */
15099
- cvssVector?: string | null
15100
- /** @default */
15101
- publishedAt?: string
15102
- /**
15103
- * @description Whether the vulnerability is a Known Exploited Vulnerability
15104
- * @default false
15105
- */
15106
- kev?: boolean
15107
- /**
15108
- * @description Exploit Prediction Scoring System score
15109
- * @default 0
15110
- */
15111
- epss?: number | null
15112
- affectedPurls?: Array<{
15113
- /**
15114
- * Format: The PURL (unique package identifier) of the affected package
15115
- * @default
15116
- */
15117
- purl: string
15118
- /** @default The range of vulnerable versions */
15119
- affectedRange: string
15120
- }>
15121
- } | null
15122
- }
15123
- }
16655
+ [key: string]: Record<string, never>
15124
16656
  }
15125
16657
  }
15126
16658
  }
@@ -15671,10 +17203,34 @@ export interface operations {
15671
17203
  'filters.alertAction'?: string
15672
17204
  /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
15673
17205
  'filters.alertAction.notIn'?: string
17206
+ /** @description Comma-separated list of alert action source types ("fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
17207
+ 'filters.alertActionSourceType'?: string
17208
+ /** @description Comma-separated list of alert action source types ("fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
17209
+ 'filters.alertActionSourceType.notIn'?: string
15674
17210
  /** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
15675
17211
  'filters.alertCategory'?: string
15676
17212
  /** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
15677
17213
  'filters.alertCategory.notIn'?: string
17214
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17215
+ 'filters.alertClearedAt.eq'?: string
17216
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17217
+ 'filters.alertClearedAt.lt'?: string
17218
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17219
+ 'filters.alertClearedAt.lte'?: string
17220
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17221
+ 'filters.alertClearedAt.gt'?: string
17222
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17223
+ 'filters.alertClearedAt.gte'?: string
17224
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17225
+ 'filters.alertCreatedAt.eq'?: string
17226
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17227
+ 'filters.alertCreatedAt.lt'?: string
17228
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17229
+ 'filters.alertCreatedAt.lte'?: string
17230
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17231
+ 'filters.alertCreatedAt.gt'?: string
17232
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17233
+ 'filters.alertCreatedAt.gte'?: string
15678
17234
  /** @description CVE ID */
15679
17235
  'filters.alertCveId'?: string
15680
17236
  /** @description CVE ID */
@@ -15707,6 +17263,10 @@ export interface operations {
15707
17263
  'filters.alertPriority'?: string
15708
17264
  /** @description Alert priority ("low", "medium", "high", or "critical") */
15709
17265
  'filters.alertPriority.notIn'?: string
17266
+ /** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
17267
+ 'filters.alertReachabilityAnalysisType'?: string
17268
+ /** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
17269
+ 'filters.alertReachabilityAnalysisType.notIn'?: string
15710
17270
  /** @description Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be included */
15711
17271
  'filters.alertReachabilityType'?: string
15712
17272
  /** @description Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be excluded */
@@ -15733,6 +17293,34 @@ export interface operations {
15733
17293
  'filters.alertUpdatedAt.gt'?: string
15734
17294
  /** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
15735
17295
  'filters.alertUpdatedAt.gte'?: string
17296
+ /** @description Name of artifact */
17297
+ 'filters.artifactName'?: string
17298
+ /** @description Name of artifact */
17299
+ 'filters.artifactName.notIn'?: string
17300
+ /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
17301
+ 'filters.artifactType'?: string
17302
+ /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
17303
+ 'filters.artifactType.notIn'?: string
17304
+ /** @description Comma-separated list of branch names that should be included */
17305
+ 'filters.branch'?: string
17306
+ /** @description Comma-separated list of branch names that should be excluded */
17307
+ 'filters.branch.notIn'?: string
17308
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included */
17309
+ 'filters.cvePatchStatus'?: string
17310
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded */
17311
+ 'filters.cvePatchStatus.notIn'?: string
17312
+ /** @description Dead/reachable dependency filter flag */
17313
+ 'filters.dependencyDead'?: boolean
17314
+ /** @description Dead/reachable dependency filter flag */
17315
+ 'filters.dependencyDead.notIn'?: boolean
17316
+ /** @description Development/production dependency filter flag */
17317
+ 'filters.dependencyDev'?: boolean
17318
+ /** @description Development/production dependency filter flag */
17319
+ 'filters.dependencyDev.notIn'?: boolean
17320
+ /** @description Direct/transitive dependency filter flag */
17321
+ 'filters.dependencyDirect'?: boolean
17322
+ /** @description Direct/transitive dependency filter flag */
17323
+ 'filters.dependencyDirect.notIn'?: boolean
15736
17324
  /** @description Comma-separated list of repo full names that should be included */
15737
17325
  'filters.repoFullName'?: string
15738
17326
  /** @description Comma-separated list of repo full names that should be excluded */
@@ -15752,7 +17340,7 @@ export interface operations {
15752
17340
  }
15753
17341
  }
15754
17342
  responses: {
15755
- /** @description The paginated array of API tokens for the organization, and related metadata. */
17343
+ /** @description The paginated array of alert items for the organization and related metadata. */
15756
17344
  200: {
15757
17345
  content: {
15758
17346
  'application/json': {
@@ -15765,6 +17353,8 @@ export interface operations {
15765
17353
  type: string
15766
17354
  /** @default */
15767
17355
  category: string
17356
+ /** @default */
17357
+ description: string | null
15768
17358
  fix: {
15769
17359
  /** @default */
15770
17360
  type: string
@@ -15780,6 +17370,8 @@ export interface operations {
15780
17370
  cveDescription: string | null
15781
17371
  /** @default 0 */
15782
17372
  cvssScore: number
17373
+ /** @default */
17374
+ cvssVectorString: string | null
15783
17375
  cweIds: string[] | null
15784
17376
  cweNames: string[] | null
15785
17377
  ghsaIds: string[] | null
@@ -15789,6 +17381,10 @@ export interface operations {
15789
17381
  epssPercentile: number
15790
17382
  /** @default false */
15791
17383
  isKev: boolean
17384
+ /** @default */
17385
+ firstPatchedVersionIdentifier: string | null
17386
+ /** @default */
17387
+ url: string | null
15792
17388
  } | null
15793
17389
  /** @default */
15794
17390
  id: string
@@ -15807,6 +17403,8 @@ export interface operations {
15807
17403
  clearedAt: string | null
15808
17404
  /** @default */
15809
17405
  dashboardUrl: string
17406
+ /** @default */
17407
+ title: string
15810
17408
  /**
15811
17409
  * @default low
15812
17410
  * @enum {string}
@@ -15900,6 +17498,43 @@ export interface operations {
15900
17498
  scores: components['schemas']['SocketScore']
15901
17499
  /** @default */
15902
17500
  artifactId: string | null
17501
+ capabilities: {
17502
+ /**
17503
+ * @description Package can read or modify environment variables
17504
+ * @default false
17505
+ */
17506
+ env: boolean
17507
+ /**
17508
+ * @description Package uses dynamic code evaluation (eval, Function constructor, etc.)
17509
+ * @default false
17510
+ */
17511
+ eval: boolean
17512
+ /**
17513
+ * @description Package can read or write to the file system
17514
+ * @default false
17515
+ */
17516
+ fs: boolean
17517
+ /**
17518
+ * @description Package can make network requests or create servers
17519
+ * @default false
17520
+ */
17521
+ net: boolean
17522
+ /**
17523
+ * @description Package can execute shell commands or spawn processes
17524
+ * @default false
17525
+ */
17526
+ shell: boolean
17527
+ /**
17528
+ * @description Package uses unsafe or dangerous operations that could compromise security
17529
+ * @default false
17530
+ */
17531
+ unsafe: boolean
17532
+ /**
17533
+ * @description Package contains remote URL(s) in the source code
17534
+ * @default false
17535
+ */
17536
+ url: boolean
17537
+ } | null
15903
17538
  }
15904
17539
  }[]
15905
17540
  }>
@@ -15913,10 +17548,34 @@ export interface operations {
15913
17548
  alertAction?: string[]
15914
17549
  /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
15915
17550
  'alertAction.notIn'?: string[]
17551
+ /** @description Comma-separated list of alert action source types ("fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
17552
+ alertActionSourceType?: string[]
17553
+ /** @description Comma-separated list of alert action source types ("fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
17554
+ 'alertActionSourceType.notIn'?: string[]
15916
17555
  /** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
15917
17556
  alertCategory?: string[]
15918
17557
  /** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
15919
17558
  'alertCategory.notIn'?: string[]
17559
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17560
+ 'alertClearedAt.eq'?: string[]
17561
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17562
+ 'alertClearedAt.lt'?: string[]
17563
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17564
+ 'alertClearedAt.lte'?: string[]
17565
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17566
+ 'alertClearedAt.gt'?: string[]
17567
+ /** @description Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17568
+ 'alertClearedAt.gte'?: string[]
17569
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17570
+ 'alertCreatedAt.eq'?: string[]
17571
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17572
+ 'alertCreatedAt.lt'?: string[]
17573
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17574
+ 'alertCreatedAt.lte'?: string[]
17575
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17576
+ 'alertCreatedAt.gt'?: string[]
17577
+ /** @description Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
17578
+ 'alertCreatedAt.gte'?: string[]
15920
17579
  /** @description CVE ID */
15921
17580
  alertCveId?: string[]
15922
17581
  /** @description CVE ID */
@@ -15947,6 +17606,10 @@ export interface operations {
15947
17606
  alertPriority?: string[]
15948
17607
  /** @description Alert priority ("low", "medium", "high", or "critical") */
15949
17608
  'alertPriority.notIn'?: string[]
17609
+ /** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
17610
+ alertReachabilityAnalysisType?: string[]
17611
+ /** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
17612
+ 'alertReachabilityAnalysisType.notIn'?: string[]
15950
17613
  /** @description Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be included */
15951
17614
  alertReachabilityType?: string[]
15952
17615
  /** @description Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be excluded */
@@ -15973,6 +17636,28 @@ export interface operations {
15973
17636
  'alertUpdatedAt.gt'?: string[]
15974
17637
  /** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
15975
17638
  'alertUpdatedAt.gte'?: string[]
17639
+ /** @description Name of artifact */
17640
+ artifactName?: string[]
17641
+ /** @description Name of artifact */
17642
+ 'artifactName.notIn'?: string[]
17643
+ /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
17644
+ artifactType?: string[]
17645
+ /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
17646
+ 'artifactType.notIn'?: string[]
17647
+ /** @description Comma-separated list of branch names that should be included */
17648
+ branch?: string[]
17649
+ /** @description Comma-separated list of branch names that should be excluded */
17650
+ 'branch.notIn'?: string[]
17651
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included */
17652
+ cvePatchStatus?: string[]
17653
+ /** @description Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded */
17654
+ 'cvePatchStatus.notIn'?: string[]
17655
+ /** @description Dead/reachable dependency filter flag */
17656
+ dependencyDead?: boolean[]
17657
+ /** @description Development/production dependency filter flag */
17658
+ dependencyDev?: boolean[]
17659
+ /** @description Direct/transitive dependency filter flag */
17660
+ dependencyDirect?: boolean[]
15976
17661
  /** @description Comma-separated list of repo full names that should be included */
15977
17662
  repoFullName?: string[]
15978
17663
  /** @description Comma-separated list of repo full names that should be excluded */
@@ -15996,6 +17681,95 @@ export interface operations {
15996
17681
  429: components['responses']['SocketTooManyRequestsResponse']
15997
17682
  }
15998
17683
  }
17684
+ /**
17685
+ * List full scans associated with alert (Beta)
17686
+ * @description List full scans associated with alert.
17687
+ *
17688
+ * This endpoint consumes 10 units of your quota.
17689
+ *
17690
+ * This endpoint requires the following org token scopes:
17691
+ * - alerts:list
17692
+ */
17693
+ alertFullScans: {
17694
+ parameters: {
17695
+ query: {
17696
+ /** @description Specify the maximum number of items to return per page (intermediate pages may have fewer than this limit and callers should always check "endCursor" in response body to know if there are more pages) */
17697
+ per_page?: number
17698
+ /** @description The pagination cursor that was returned as the "endCursor" property in previous request */
17699
+ startAfterCursor?: string
17700
+ /** @description One or more alert keys for which to find associated full scans */
17701
+ alertKey: string
17702
+ /** @description The number of days of data to fetch as an offset from current date (e.g. "-7d" for past 7 days) */
17703
+ range?: string
17704
+ }
17705
+ path: {
17706
+ /** @description The slug of the organization */
17707
+ org_slug: string
17708
+ }
17709
+ }
17710
+ responses: {
17711
+ /** @description The paginated array of full scans associated with alert for the organization and related metadata. */
17712
+ 200: {
17713
+ content: {
17714
+ 'application/json': {
17715
+ /** @default */
17716
+ endCursor: string | null
17717
+ items: Array<{
17718
+ /**
17719
+ * @description ID of full scan
17720
+ * @default
17721
+ */
17722
+ fullScanId: string
17723
+ /** @default */
17724
+ branchName: string | null
17725
+ /**
17726
+ * @description Type of branch that was scanned
17727
+ * @default
17728
+ * @enum {string}
17729
+ */
17730
+ branchType:
17731
+ | 'default'
17732
+ | 'non-default'
17733
+ | 'tracked'
17734
+ | 'untracked'
17735
+ | ''
17736
+ /**
17737
+ * @description Full name of repo which contains repo workspace and repo slug
17738
+ * @default
17739
+ */
17740
+ repoFullName: string | null
17741
+ /**
17742
+ * @description ISO date when SBOM was created
17743
+ * @default
17744
+ */
17745
+ sbomCreatedAt: string
17746
+ /**
17747
+ * @description ISO date when SBOM was scanned
17748
+ * @default
17749
+ */
17750
+ scannedAt: string
17751
+ alertKeys: string[]
17752
+ }>
17753
+ meta: {
17754
+ /** @default */
17755
+ organizationId: string
17756
+ alertKeys: string[]
17757
+ /** @default 0 */
17758
+ queryStartTimestamp: number
17759
+ /** @default */
17760
+ startDateInclusive: string
17761
+ /** @default */
17762
+ endDateInclusive: string
17763
+ }
17764
+ }
17765
+ }
17766
+ }
17767
+ 400: components['responses']['SocketBadRequest']
17768
+ 401: components['responses']['SocketUnauthorized']
17769
+ 403: components['responses']['SocketForbidden']
17770
+ 429: components['responses']['SocketTooManyRequestsResponse']
17771
+ }
17772
+ }
15999
17773
  /**
16000
17774
  * License Policy (Beta)
16001
17775
  * @description Compare the license data found for a list of packages (given as PURL strings) with the contents of a configurable license policy,
@@ -16484,12 +18258,16 @@ export interface operations {
16484
18258
  */
16485
18259
  getQuota: {
16486
18260
  responses: {
16487
- /** @description Quota amount */
18261
+ /** @description Quota information */
16488
18262
  200: {
16489
18263
  content: {
16490
18264
  'application/json': {
16491
18265
  /** @default 0 */
16492
18266
  quota: number
18267
+ /** @default 0 */
18268
+ maxQuota: number
18269
+ /** @default */
18270
+ nextWindowRefresh: string | null
16493
18271
  }
16494
18272
  }
16495
18273
  }