@socketsecurity/sdk 3.1.2 → 3.2.0
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/CHANGELOG.md +39 -3
- package/README.md +5 -129
- package/dist/constants.d.ts +3 -0
- package/dist/file-upload.d.ts +7 -8
- package/dist/http-client.d.ts +12 -8
- package/dist/index.d.ts +3 -3
- package/dist/index.js +901 -21025
- package/dist/socket-sdk-class.d.ts +237 -1
- package/dist/testing.js +0 -1
- package/dist/types.d.ts +61 -2
- package/dist/utils.d.ts +61 -0
- package/package.json +12 -7
- package/types/api.d.ts +2089 -267
package/types/api.d.ts
CHANGED
|
@@ -13,6 +13,8 @@ export interface paths {
|
|
|
13
13
|
* CycloneDX SBOMs use the purl format to identify components.
|
|
14
14
|
* 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.
|
|
15
15
|
*
|
|
16
|
+
* **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
|
|
17
|
+
*
|
|
16
18
|
* More information on purl and CycloneDX:
|
|
17
19
|
*
|
|
18
20
|
* - [`purl` Spec](https://github.com/package-url/purl-spec)
|
|
@@ -212,6 +214,34 @@ export interface paths {
|
|
|
212
214
|
*/
|
|
213
215
|
get: operations['GetOrgFullScanDiffGfm']
|
|
214
216
|
}
|
|
217
|
+
'/orgs/{org_slug}/full-scans/{full_scan_id}/files/tar': {
|
|
218
|
+
/**
|
|
219
|
+
* Download full scan files as tarball
|
|
220
|
+
* @description Download all files associated with a full scan in tar format.
|
|
221
|
+
*
|
|
222
|
+
* This endpoint consumes 1 unit of your quota.
|
|
223
|
+
*
|
|
224
|
+
* This endpoint requires the following org token scopes:
|
|
225
|
+
* - full-scans:list
|
|
226
|
+
*/
|
|
227
|
+
get: operations['downloadOrgFullScanFilesAsTar']
|
|
228
|
+
}
|
|
229
|
+
'/orgs/{org_slug}/full-scans/archive': {
|
|
230
|
+
/**
|
|
231
|
+
* Create full scan from archive
|
|
232
|
+
* @description Create a full scan by uploading one or more archives. Supported archive formats include **.tar**, **.tar.gz/.tgz**, and **.zip**.
|
|
233
|
+
*
|
|
234
|
+
* 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
|
+
*
|
|
236
|
+
* The maximum combined number of files extracted from your upload is 5000 and each extracted file can be no bigger than 67 MB.
|
|
237
|
+
*
|
|
238
|
+
* This endpoint consumes 1 unit of your quota.
|
|
239
|
+
*
|
|
240
|
+
* This endpoint requires the following org token scopes:
|
|
241
|
+
* - full-scans:create
|
|
242
|
+
*/
|
|
243
|
+
post: operations['CreateOrgFullScanArchive']
|
|
244
|
+
}
|
|
215
245
|
'/orgs/{org_slug}/export/cdx/{id}': {
|
|
216
246
|
/**
|
|
217
247
|
* Export CycloneDX SBOM (Beta)
|
|
@@ -901,6 +931,107 @@ export interface paths {
|
|
|
901
931
|
*/
|
|
902
932
|
get: operations['getOrgThreatFeedItems']
|
|
903
933
|
}
|
|
934
|
+
'/orgs/{org_slug}/fixes': {
|
|
935
|
+
/**
|
|
936
|
+
* Fetch fixes for vulnerabilities in a repository or scan
|
|
937
|
+
* @description Fetches available fixes for vulnerabilities in a repository or scan.
|
|
938
|
+
* Requires either repo_slug or full_scan_id as well as vulnerability_ids to be provided.
|
|
939
|
+
* vulnerability_ids can be a comma-separated list of GHSA or CVE IDs, or "*" for all vulnerabilities.
|
|
940
|
+
*
|
|
941
|
+
* This endpoint consumes 10 units of your quota.
|
|
942
|
+
*
|
|
943
|
+
* This endpoint requires the following org token scopes:
|
|
944
|
+
* - fixes:list
|
|
945
|
+
*/
|
|
946
|
+
get: operations['fetch-fixes']
|
|
947
|
+
}
|
|
948
|
+
'/orgs/{org_slug}/telemetry/config': {
|
|
949
|
+
/**
|
|
950
|
+
* Get Organization Telemetry Config
|
|
951
|
+
* @description Retrieve the telemetry config of an organization.
|
|
952
|
+
*
|
|
953
|
+
* This endpoint consumes 1 unit of your quota.
|
|
954
|
+
*
|
|
955
|
+
* This endpoint requires the following org token scopes:
|
|
956
|
+
*/
|
|
957
|
+
get: operations['getOrgTelemetryConfig']
|
|
958
|
+
/**
|
|
959
|
+
* Update Telemetry Config
|
|
960
|
+
* @description Update the telemetry config of an organization.
|
|
961
|
+
*
|
|
962
|
+
* This endpoint consumes 1 unit of your quota.
|
|
963
|
+
*
|
|
964
|
+
* This endpoint requires the following org token scopes:
|
|
965
|
+
* - telemetry-policy:update
|
|
966
|
+
*/
|
|
967
|
+
put: operations['updateOrgTelemetryConfig']
|
|
968
|
+
}
|
|
969
|
+
'/orgs/{org_slug}/webhooks': {
|
|
970
|
+
/**
|
|
971
|
+
* List all webhooks
|
|
972
|
+
* @description List all webhooks in the specified organization.
|
|
973
|
+
*
|
|
974
|
+
* This endpoint consumes 1 unit of your quota.
|
|
975
|
+
*
|
|
976
|
+
* This endpoint requires the following org token scopes:
|
|
977
|
+
* - webhooks:list
|
|
978
|
+
*/
|
|
979
|
+
get: operations['getOrgWebhooksList']
|
|
980
|
+
/**
|
|
981
|
+
* Create a webhook
|
|
982
|
+
* @description Create a new webhook. Returns the created webhook details.
|
|
983
|
+
*
|
|
984
|
+
* This endpoint consumes 1 unit of your quota.
|
|
985
|
+
*
|
|
986
|
+
* This endpoint requires the following org token scopes:
|
|
987
|
+
* - webhooks:create
|
|
988
|
+
*/
|
|
989
|
+
post: operations['createOrgWebhook']
|
|
990
|
+
}
|
|
991
|
+
'/orgs/{org_slug}/webhooks/{webhook_id}': {
|
|
992
|
+
/**
|
|
993
|
+
* Get webhook
|
|
994
|
+
* @description Get a webhook for the specified organization.
|
|
995
|
+
*
|
|
996
|
+
* This endpoint consumes 1 unit of your quota.
|
|
997
|
+
*
|
|
998
|
+
* This endpoint requires the following org token scopes:
|
|
999
|
+
* - webhooks:list
|
|
1000
|
+
*/
|
|
1001
|
+
get: operations['getOrgWebhook']
|
|
1002
|
+
/**
|
|
1003
|
+
* Update webhook
|
|
1004
|
+
* @description Update details of an existing webhook.
|
|
1005
|
+
*
|
|
1006
|
+
* This endpoint consumes 1 unit of your quota.
|
|
1007
|
+
*
|
|
1008
|
+
* This endpoint requires the following org token scopes:
|
|
1009
|
+
* - webhooks:update
|
|
1010
|
+
*/
|
|
1011
|
+
put: operations['updateOrgWebhook']
|
|
1012
|
+
/**
|
|
1013
|
+
* Delete webhook
|
|
1014
|
+
* @description Delete a webhook. This will stop all future webhook deliveries to the webhook URL.
|
|
1015
|
+
*
|
|
1016
|
+
* This endpoint consumes 1 unit of your quota.
|
|
1017
|
+
*
|
|
1018
|
+
* This endpoint requires the following org token scopes:
|
|
1019
|
+
* - webhooks:delete
|
|
1020
|
+
*/
|
|
1021
|
+
delete: operations['deleteOrgWebhook']
|
|
1022
|
+
}
|
|
1023
|
+
'/orgs/{org_slug}/alerts': {
|
|
1024
|
+
/**
|
|
1025
|
+
* List latest alerts (Beta)
|
|
1026
|
+
* @description List latest alerts.
|
|
1027
|
+
*
|
|
1028
|
+
* This endpoint consumes 10 units of your quota.
|
|
1029
|
+
*
|
|
1030
|
+
* This endpoint requires the following org token scopes:
|
|
1031
|
+
* - alerts:list
|
|
1032
|
+
*/
|
|
1033
|
+
get: operations['alertsList']
|
|
1034
|
+
}
|
|
904
1035
|
'/license-policy': {
|
|
905
1036
|
/**
|
|
906
1037
|
* License Policy (Beta)
|
|
@@ -1502,6 +1633,11 @@ export interface components {
|
|
|
1502
1633
|
_type: 'purlError'
|
|
1503
1634
|
value: components['schemas']['PurlErrorSchema']
|
|
1504
1635
|
}
|
|
1636
|
+
| {
|
|
1637
|
+
/** @enum {string} */
|
|
1638
|
+
_type: 'summary'
|
|
1639
|
+
value: components['schemas']['PurlSummarySchema']
|
|
1640
|
+
}
|
|
1505
1641
|
SocketBatchPURLFetch: {
|
|
1506
1642
|
components: Array<components['schemas']['SocketBatchPURLRequest']>
|
|
1507
1643
|
}
|
|
@@ -1884,6 +2020,18 @@ export interface components {
|
|
|
1884
2020
|
/** @default */
|
|
1885
2021
|
inputPurl: string
|
|
1886
2022
|
}
|
|
2023
|
+
PurlSummarySchema: {
|
|
2024
|
+
/** @default 0 */
|
|
2025
|
+
purl_input: number
|
|
2026
|
+
/** @default 0 */
|
|
2027
|
+
resolved: number
|
|
2028
|
+
errors: {
|
|
2029
|
+
/** @default 0 */
|
|
2030
|
+
purl_malformed: number
|
|
2031
|
+
/** @default 0 */
|
|
2032
|
+
package_not_found: number
|
|
2033
|
+
}
|
|
2034
|
+
}
|
|
1887
2035
|
SocketBatchPURLRequest: {
|
|
1888
2036
|
/** @default */
|
|
1889
2037
|
purl: string
|
|
@@ -4229,6 +4377,7 @@ export interface components {
|
|
|
4229
4377
|
* @enum {string}
|
|
4230
4378
|
*/
|
|
4231
4379
|
SocketPURL_Type:
|
|
4380
|
+
| 'alpm'
|
|
4232
4381
|
| 'apk'
|
|
4233
4382
|
| 'bitbucket'
|
|
4234
4383
|
| 'cocoapods'
|
|
@@ -4258,6 +4407,7 @@ export interface components {
|
|
|
4258
4407
|
| 'rpm'
|
|
4259
4408
|
| 'swid'
|
|
4260
4409
|
| 'swift'
|
|
4410
|
+
| 'vscode'
|
|
4261
4411
|
| 'unknown'
|
|
4262
4412
|
/**
|
|
4263
4413
|
* @default low
|
|
@@ -4660,6 +4810,8 @@ export interface operations {
|
|
|
4660
4810
|
* CycloneDX SBOMs use the purl format to identify components.
|
|
4661
4811
|
* 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.
|
|
4662
4812
|
*
|
|
4813
|
+
* **Note:** This endpoint has a batch size limit (default: 1024 PURLs per request). Requests exceeding this limit will return a 400 Bad Request error.
|
|
4814
|
+
*
|
|
4663
4815
|
* More information on purl and CycloneDX:
|
|
4664
4816
|
*
|
|
4665
4817
|
* - [`purl` Spec](https://github.com/package-url/purl-spec)
|
|
@@ -4746,6 +4898,10 @@ export interface operations {
|
|
|
4746
4898
|
licensedetails?: boolean
|
|
4747
4899
|
/** @description Return errors found with handling PURLs as error objects in the stream. */
|
|
4748
4900
|
purlErrors?: boolean
|
|
4901
|
+
/** @description Return only cached results, do not attempt to scan new artifacts or rescan stale results. */
|
|
4902
|
+
cachedResultsOnly?: boolean
|
|
4903
|
+
/** @description Include a summary object at the end of the stream with counts of malformed, resolved, and not found PURLs. */
|
|
4904
|
+
summary?: boolean
|
|
4749
4905
|
}
|
|
4750
4906
|
}
|
|
4751
4907
|
requestBody?: {
|
|
@@ -5025,10 +5181,16 @@ export interface operations {
|
|
|
5025
5181
|
commit_hash?: string
|
|
5026
5182
|
/** @description The pull request number to associate the full-scan with. */
|
|
5027
5183
|
pull_request?: number
|
|
5028
|
-
/** @description The committers to associate the full-scan
|
|
5184
|
+
/** @description The committers to associate with the full-scan. Set query more than once to set multiple. */
|
|
5029
5185
|
committers?: string
|
|
5030
5186
|
/** @description The integration type to associate the full-scan with. Defaults to "Api" if omitted. */
|
|
5031
|
-
integration_type?:
|
|
5187
|
+
integration_type?:
|
|
5188
|
+
| 'api'
|
|
5189
|
+
| 'github'
|
|
5190
|
+
| 'gitlab'
|
|
5191
|
+
| 'bitbucket'
|
|
5192
|
+
| 'azure'
|
|
5193
|
+
| 'web'
|
|
5032
5194
|
/** @description The integration org slug to associate the full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges. */
|
|
5033
5195
|
integration_org_slug?: string
|
|
5034
5196
|
/** @description Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option. */
|
|
@@ -5502,6 +5664,164 @@ export interface operations {
|
|
|
5502
5664
|
429: components['responses']['SocketTooManyRequestsResponse']
|
|
5503
5665
|
}
|
|
5504
5666
|
}
|
|
5667
|
+
/**
|
|
5668
|
+
* Download full scan files as tarball
|
|
5669
|
+
* @description Download all files associated with a full scan in tar format.
|
|
5670
|
+
*
|
|
5671
|
+
* This endpoint consumes 1 unit of your quota.
|
|
5672
|
+
*
|
|
5673
|
+
* This endpoint requires the following org token scopes:
|
|
5674
|
+
* - full-scans:list
|
|
5675
|
+
*/
|
|
5676
|
+
downloadOrgFullScanFilesAsTar: {
|
|
5677
|
+
parameters: {
|
|
5678
|
+
path: {
|
|
5679
|
+
/** @description The slug of the organization */
|
|
5680
|
+
org_slug: string
|
|
5681
|
+
/** @description The ID of the full scan */
|
|
5682
|
+
full_scan_id: string
|
|
5683
|
+
}
|
|
5684
|
+
}
|
|
5685
|
+
responses: {
|
|
5686
|
+
/** @description Tar archive of full scan files */
|
|
5687
|
+
200: {
|
|
5688
|
+
content: {
|
|
5689
|
+
'application/x-tar': unknown
|
|
5690
|
+
}
|
|
5691
|
+
}
|
|
5692
|
+
400: components['responses']['SocketBadRequest']
|
|
5693
|
+
401: components['responses']['SocketUnauthorized']
|
|
5694
|
+
403: components['responses']['SocketForbidden']
|
|
5695
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
5696
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
5697
|
+
}
|
|
5698
|
+
}
|
|
5699
|
+
/**
|
|
5700
|
+
* Create full scan from archive
|
|
5701
|
+
* @description Create a full scan by uploading one or more archives. Supported archive formats include **.tar**, **.tar.gz/.tgz**, and **.zip**.
|
|
5702
|
+
*
|
|
5703
|
+
* 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
|
+
*
|
|
5705
|
+
* The maximum combined number of files extracted from your upload is 5000 and each extracted file can be no bigger than 67 MB.
|
|
5706
|
+
*
|
|
5707
|
+
* This endpoint consumes 1 unit of your quota.
|
|
5708
|
+
*
|
|
5709
|
+
* This endpoint requires the following org token scopes:
|
|
5710
|
+
* - full-scans:create
|
|
5711
|
+
*/
|
|
5712
|
+
CreateOrgFullScanArchive: {
|
|
5713
|
+
parameters: {
|
|
5714
|
+
query: {
|
|
5715
|
+
/** @description The slug of the repository to associate the full-scan with. */
|
|
5716
|
+
repo: string
|
|
5717
|
+
/** @description The workspace of the repository to associate the full-scan with. */
|
|
5718
|
+
workspace?: string
|
|
5719
|
+
/** @description The branch name to associate the full-scan with. Branch names must follow Git branch name rules: be 1–255 characters long; cannot be exactly @; cannot begin or end with /, ., or .lock; cannot contain "//", "..", or "@{"; and cannot include control characters, spaces, or any of ~^:?*[. */
|
|
5720
|
+
branch?: string
|
|
5721
|
+
/** @description The commit message to associate the full-scan with. */
|
|
5722
|
+
commit_message?: string
|
|
5723
|
+
/** @description The commit hash to associate the full-scan with. */
|
|
5724
|
+
commit_hash?: string
|
|
5725
|
+
/** @description The pull request number to associate the full-scan with. */
|
|
5726
|
+
pull_request?: number
|
|
5727
|
+
/** @description The committers to associate with the full-scan. Set query more than once to set multiple. */
|
|
5728
|
+
committers?: string
|
|
5729
|
+
/** @description The integration type to associate the full-scan with. Defaults to "Api" if omitted. */
|
|
5730
|
+
integration_type?:
|
|
5731
|
+
| 'api'
|
|
5732
|
+
| 'github'
|
|
5733
|
+
| 'gitlab'
|
|
5734
|
+
| 'bitbucket'
|
|
5735
|
+
| 'azure'
|
|
5736
|
+
| 'web'
|
|
5737
|
+
/** @description The integration org slug to associate the full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges. */
|
|
5738
|
+
integration_org_slug?: string
|
|
5739
|
+
/** @description Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option. */
|
|
5740
|
+
make_default_branch?: boolean
|
|
5741
|
+
/** @description Designate this full-scan as the latest scan of a given branch. Default branch head scans are included in org alerts. This is only supported on the default branch. A branch name is required with this option. */
|
|
5742
|
+
set_as_pending_head?: boolean
|
|
5743
|
+
/** @description Create a temporary full-scan that is not listed in the reports dashboard. Cannot be used when set_as_pending_head=true. */
|
|
5744
|
+
tmp?: boolean
|
|
5745
|
+
/** @description The type of scan to perform. Defaults to 'socket'. Must be 32 characters or less. Used for categorizing multiple SBOM heads per repository branch. */
|
|
5746
|
+
scan_type?: string
|
|
5747
|
+
}
|
|
5748
|
+
path: {
|
|
5749
|
+
/** @description The slug of the organization */
|
|
5750
|
+
org_slug: string
|
|
5751
|
+
}
|
|
5752
|
+
}
|
|
5753
|
+
requestBody?: {
|
|
5754
|
+
content: {
|
|
5755
|
+
'multipart/form-data': {
|
|
5756
|
+
[key: string]: never
|
|
5757
|
+
}
|
|
5758
|
+
}
|
|
5759
|
+
}
|
|
5760
|
+
responses: {
|
|
5761
|
+
/** @description The details of the created full scan. */
|
|
5762
|
+
201: {
|
|
5763
|
+
content: {
|
|
5764
|
+
'application/json': {
|
|
5765
|
+
/** @default */
|
|
5766
|
+
id?: string
|
|
5767
|
+
/** @default */
|
|
5768
|
+
created_at?: string
|
|
5769
|
+
/** @default */
|
|
5770
|
+
updated_at?: string
|
|
5771
|
+
/** @default */
|
|
5772
|
+
organization_id?: string
|
|
5773
|
+
/** @default */
|
|
5774
|
+
organization_slug?: string
|
|
5775
|
+
/** @default */
|
|
5776
|
+
repository_id?: string
|
|
5777
|
+
/** @default */
|
|
5778
|
+
repository_slug?: string
|
|
5779
|
+
/** @default */
|
|
5780
|
+
branch?: string | null
|
|
5781
|
+
/** @default */
|
|
5782
|
+
commit_message?: string | null
|
|
5783
|
+
/** @default */
|
|
5784
|
+
commit_hash?: string | null
|
|
5785
|
+
/** @default 0 */
|
|
5786
|
+
pull_request?: number | null
|
|
5787
|
+
committers?: string[]
|
|
5788
|
+
/** @default */
|
|
5789
|
+
html_url?: string | null
|
|
5790
|
+
/** @default */
|
|
5791
|
+
api_url?: string | null
|
|
5792
|
+
/** @default */
|
|
5793
|
+
workspace?: string
|
|
5794
|
+
/** @default */
|
|
5795
|
+
repo?: string
|
|
5796
|
+
/** @default */
|
|
5797
|
+
html_report_url?: string
|
|
5798
|
+
/** @default */
|
|
5799
|
+
integration_type?: string | null
|
|
5800
|
+
/** @default */
|
|
5801
|
+
integration_repo_url?: string
|
|
5802
|
+
/** @default */
|
|
5803
|
+
integration_branch_url?: string | null
|
|
5804
|
+
/** @default */
|
|
5805
|
+
integration_commit_url?: string | null
|
|
5806
|
+
/** @default */
|
|
5807
|
+
integration_pull_request_url?: string | null
|
|
5808
|
+
/**
|
|
5809
|
+
* @description The current processing status of the SBOM
|
|
5810
|
+
* @default pending
|
|
5811
|
+
* @enum {string|null}
|
|
5812
|
+
*/
|
|
5813
|
+
scan_state?: 'pending' | 'precrawl' | 'resolve' | 'scan' | null
|
|
5814
|
+
unmatchedFiles?: string[]
|
|
5815
|
+
}
|
|
5816
|
+
}
|
|
5817
|
+
}
|
|
5818
|
+
400: components['responses']['SocketBadRequest']
|
|
5819
|
+
401: components['responses']['SocketUnauthorized']
|
|
5820
|
+
403: components['responses']['SocketForbidden']
|
|
5821
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
5822
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
5823
|
+
}
|
|
5824
|
+
}
|
|
5505
5825
|
/**
|
|
5506
5826
|
* Export CycloneDX SBOM (Beta)
|
|
5507
5827
|
* @description Export a Socket SBOM as a CycloneDX SBOM
|
|
@@ -6022,7 +6342,13 @@ export interface operations {
|
|
|
6022
6342
|
/** @description The committers to associate the new full-scan with. Set query more than once to set multiple committers. */
|
|
6023
6343
|
committers?: string
|
|
6024
6344
|
/** @description The integration type to associate the new full-scan with. Defaults to "api" if omitted. */
|
|
6025
|
-
integration_type?:
|
|
6345
|
+
integration_type?:
|
|
6346
|
+
| 'api'
|
|
6347
|
+
| 'github'
|
|
6348
|
+
| 'gitlab'
|
|
6349
|
+
| 'bitbucket'
|
|
6350
|
+
| 'azure'
|
|
6351
|
+
| 'web'
|
|
6026
6352
|
/** @description The integration org slug to associate the new full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges. */
|
|
6027
6353
|
integration_org_slug?: string
|
|
6028
6354
|
/** @description Set to true when running a diff between a merged commit and its parent commit in the same branch. Set to false when running diffs in an open PR between unmerged commits. */
|
|
@@ -12525,34 +12851,6 @@ export interface operations {
|
|
|
12525
12851
|
per_page?: number
|
|
12526
12852
|
/** @description The pagination cursor that was returned as the "endCursor" property in previous request */
|
|
12527
12853
|
startAfterCursor?: string
|
|
12528
|
-
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
12529
|
-
'filters.alertSeverity'?: string
|
|
12530
|
-
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
12531
|
-
'filters.alertSeverity.notIn'?: string
|
|
12532
|
-
/** @description Comma-separated list of repo slugs that should be included */
|
|
12533
|
-
'filters.repoSlug'?: string
|
|
12534
|
-
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
12535
|
-
'filters.repoSlug.notIn'?: string
|
|
12536
|
-
/** @description Comma-separated list of repo full names that should be included */
|
|
12537
|
-
'filters.repoFullName'?: string
|
|
12538
|
-
/** @description Comma-separated list of repo full names that should be excluded */
|
|
12539
|
-
'filters.repoFullName.notIn'?: string
|
|
12540
|
-
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
12541
|
-
'filters.repoLabels'?: string
|
|
12542
|
-
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
12543
|
-
'filters.repoLabels.notIn'?: string
|
|
12544
|
-
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
12545
|
-
'filters.alertType'?: string
|
|
12546
|
-
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
12547
|
-
'filters.alertType.notIn'?: string
|
|
12548
|
-
/** @description Name of artifact */
|
|
12549
|
-
'filters.artifactName'?: string
|
|
12550
|
-
/** @description Name of artifact */
|
|
12551
|
-
'filters.artifactName.notIn'?: string
|
|
12552
|
-
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
|
|
12553
|
-
'filters.artifactType'?: string
|
|
12554
|
-
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
12555
|
-
'filters.artifactType.notIn'?: string
|
|
12556
12854
|
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
12557
12855
|
'filters.alertAction'?: string
|
|
12558
12856
|
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
@@ -12561,10 +12859,6 @@ export interface operations {
|
|
|
12561
12859
|
'filters.alertActionSourceType'?: string
|
|
12562
12860
|
/** @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 */
|
|
12563
12861
|
'filters.alertActionSourceType.notIn'?: string
|
|
12564
|
-
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
12565
|
-
'filters.alertFixType'?: string
|
|
12566
|
-
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
12567
|
-
'filters.alertFixType.notIn'?: string
|
|
12568
12862
|
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
|
|
12569
12863
|
'filters.alertCategory'?: string
|
|
12570
12864
|
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
|
|
@@ -12585,38 +12879,70 @@ export interface operations {
|
|
|
12585
12879
|
'filters.alertCweName'?: string
|
|
12586
12880
|
/** @description CWE name */
|
|
12587
12881
|
'filters.alertCweName.notIn'?: string
|
|
12588
|
-
/** @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 */
|
|
12589
|
-
'filters.alertReachabilityType'?: string
|
|
12590
|
-
/** @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 */
|
|
12591
|
-
'filters.alertReachabilityType.notIn'?: string
|
|
12592
|
-
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
|
|
12593
|
-
'filters.alertReachabilityAnalysisType'?: string
|
|
12594
|
-
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
12595
|
-
'filters.alertReachabilityAnalysisType.notIn'?: string
|
|
12596
|
-
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12597
|
-
'filters.alertPriority'?: string
|
|
12598
|
-
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12599
|
-
'filters.alertPriority.notIn'?: string
|
|
12600
|
-
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12601
|
-
'filters.alertKEV'?: boolean
|
|
12602
|
-
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12603
|
-
'filters.alertKEV.notIn'?: boolean
|
|
12604
12882
|
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
12605
12883
|
'filters.alertEPSS'?: string
|
|
12606
12884
|
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
12607
12885
|
'filters.alertEPSS.notIn'?: string
|
|
12608
|
-
/** @description
|
|
12609
|
-
'filters.
|
|
12610
|
-
/** @description
|
|
12611
|
-
'filters.
|
|
12612
|
-
/** @description
|
|
12613
|
-
'filters.
|
|
12614
|
-
/** @description
|
|
12615
|
-
'filters.
|
|
12886
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
12887
|
+
'filters.alertFixType'?: string
|
|
12888
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
12889
|
+
'filters.alertFixType.notIn'?: string
|
|
12890
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12891
|
+
'filters.alertKEV'?: boolean
|
|
12892
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12893
|
+
'filters.alertKEV.notIn'?: boolean
|
|
12894
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12895
|
+
'filters.alertPriority'?: string
|
|
12896
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12897
|
+
'filters.alertPriority.notIn'?: string
|
|
12898
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
|
|
12899
|
+
'filters.alertReachabilityAnalysisType'?: string
|
|
12900
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
12901
|
+
'filters.alertReachabilityAnalysisType.notIn'?: string
|
|
12902
|
+
/** @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 */
|
|
12903
|
+
'filters.alertReachabilityType'?: string
|
|
12904
|
+
/** @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 */
|
|
12905
|
+
'filters.alertReachabilityType.notIn'?: string
|
|
12906
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
12907
|
+
'filters.alertSeverity'?: string
|
|
12908
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
12909
|
+
'filters.alertSeverity.notIn'?: string
|
|
12910
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
12911
|
+
'filters.alertType'?: string
|
|
12912
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
12913
|
+
'filters.alertType.notIn'?: string
|
|
12914
|
+
/** @description Name of artifact */
|
|
12915
|
+
'filters.artifactName'?: string
|
|
12916
|
+
/** @description Name of artifact */
|
|
12917
|
+
'filters.artifactName.notIn'?: string
|
|
12918
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
|
|
12919
|
+
'filters.artifactType'?: string
|
|
12920
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
12921
|
+
'filters.artifactType.notIn'?: string
|
|
12616
12922
|
/** @description Dead/reachable dependency filter flag */
|
|
12617
12923
|
'filters.dependencyDead'?: boolean
|
|
12618
12924
|
/** @description Dead/reachable dependency filter flag */
|
|
12619
12925
|
'filters.dependencyDead.notIn'?: boolean
|
|
12926
|
+
/** @description Development/production dependency filter flag */
|
|
12927
|
+
'filters.dependencyDev'?: boolean
|
|
12928
|
+
/** @description Development/production dependency filter flag */
|
|
12929
|
+
'filters.dependencyDev.notIn'?: boolean
|
|
12930
|
+
/** @description Direct/transitive dependency filter flag */
|
|
12931
|
+
'filters.dependencyDirect'?: boolean
|
|
12932
|
+
/** @description Direct/transitive dependency filter flag */
|
|
12933
|
+
'filters.dependencyDirect.notIn'?: boolean
|
|
12934
|
+
/** @description Comma-separated list of repo full names that should be included */
|
|
12935
|
+
'filters.repoFullName'?: string
|
|
12936
|
+
/** @description Comma-separated list of repo full names that should be excluded */
|
|
12937
|
+
'filters.repoFullName.notIn'?: string
|
|
12938
|
+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
12939
|
+
'filters.repoLabels'?: string
|
|
12940
|
+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
12941
|
+
'filters.repoLabels.notIn'?: string
|
|
12942
|
+
/** @description Comma-separated list of repo slugs that should be included */
|
|
12943
|
+
'filters.repoSlug'?: string
|
|
12944
|
+
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
12945
|
+
'filters.repoSlug.notIn'?: string
|
|
12620
12946
|
}
|
|
12621
12947
|
path: {
|
|
12622
12948
|
/** @description The slug of the organization */
|
|
@@ -12726,52 +13052,90 @@ export interface operations {
|
|
|
12726
13052
|
/** @default false */
|
|
12727
13053
|
includeLatestAlertsOnly: boolean
|
|
12728
13054
|
filters: {
|
|
12729
|
-
/** @description Comma-separated list of alert
|
|
12730
|
-
alertSeverity?: string[]
|
|
12731
|
-
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
12732
|
-
repoSlug?: string[]
|
|
12733
|
-
/** @description Comma-separated list of repo full names that should be excluded */
|
|
12734
|
-
repoFullName?: string[]
|
|
12735
|
-
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
12736
|
-
repoLabels?: string[]
|
|
12737
|
-
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
12738
|
-
alertType?: string[]
|
|
12739
|
-
/** @description Name of artifact */
|
|
12740
|
-
artifactName?: string[]
|
|
12741
|
-
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
12742
|
-
artifactType?: string[]
|
|
12743
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
13055
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
12744
13056
|
alertAction?: string[]
|
|
12745
|
-
/** @description Comma-separated list of alert
|
|
13057
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
13058
|
+
'alertAction.notIn'?: string[]
|
|
13059
|
+
/** @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 */
|
|
12746
13060
|
alertActionSourceType?: string[]
|
|
12747
|
-
/** @description Comma-separated list of alert
|
|
12748
|
-
|
|
12749
|
-
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be
|
|
13061
|
+
/** @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 */
|
|
13062
|
+
'alertActionSourceType.notIn'?: string[]
|
|
13063
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
|
|
12750
13064
|
alertCategory?: string[]
|
|
13065
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
|
|
13066
|
+
'alertCategory.notIn'?: string[]
|
|
12751
13067
|
/** @description CVE ID */
|
|
12752
13068
|
alertCveId?: string[]
|
|
13069
|
+
/** @description CVE ID */
|
|
13070
|
+
'alertCveId.notIn'?: string[]
|
|
12753
13071
|
/** @description CVE title */
|
|
12754
13072
|
alertCveTitle?: string[]
|
|
13073
|
+
/** @description CVE title */
|
|
13074
|
+
'alertCveTitle.notIn'?: string[]
|
|
12755
13075
|
/** @description CWE ID */
|
|
12756
13076
|
alertCweId?: string[]
|
|
13077
|
+
/** @description CWE ID */
|
|
13078
|
+
'alertCweId.notIn'?: string[]
|
|
12757
13079
|
/** @description CWE name */
|
|
12758
13080
|
alertCweName?: string[]
|
|
12759
|
-
/** @description
|
|
12760
|
-
|
|
12761
|
-
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
12762
|
-
alertReachabilityAnalysisType?: string[]
|
|
12763
|
-
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12764
|
-
alertPriority?: string[]
|
|
12765
|
-
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12766
|
-
alertKEV?: boolean[]
|
|
13081
|
+
/** @description CWE name */
|
|
13082
|
+
'alertCweName.notIn'?: string[]
|
|
12767
13083
|
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
12768
13084
|
alertEPSS?: string[]
|
|
12769
|
-
/** @description
|
|
12770
|
-
|
|
12771
|
-
/** @description
|
|
12772
|
-
|
|
13085
|
+
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
13086
|
+
'alertEPSS.notIn'?: string[]
|
|
13087
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
13088
|
+
alertFixType?: string[]
|
|
13089
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
13090
|
+
'alertFixType.notIn'?: string[]
|
|
13091
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
13092
|
+
alertKEV?: boolean[]
|
|
13093
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
13094
|
+
alertPriority?: string[]
|
|
13095
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
13096
|
+
'alertPriority.notIn'?: string[]
|
|
13097
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
|
|
13098
|
+
alertReachabilityAnalysisType?: string[]
|
|
13099
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
13100
|
+
'alertReachabilityAnalysisType.notIn'?: string[]
|
|
13101
|
+
/** @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 */
|
|
13102
|
+
alertReachabilityType?: string[]
|
|
13103
|
+
/** @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 */
|
|
13104
|
+
'alertReachabilityType.notIn'?: string[]
|
|
13105
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
13106
|
+
alertSeverity?: string[]
|
|
13107
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
13108
|
+
'alertSeverity.notIn'?: string[]
|
|
13109
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
13110
|
+
alertType?: string[]
|
|
13111
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
13112
|
+
'alertType.notIn'?: string[]
|
|
13113
|
+
/** @description Name of artifact */
|
|
13114
|
+
artifactName?: string[]
|
|
13115
|
+
/** @description Name of artifact */
|
|
13116
|
+
'artifactName.notIn'?: string[]
|
|
13117
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
|
|
13118
|
+
artifactType?: string[]
|
|
13119
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
13120
|
+
'artifactType.notIn'?: string[]
|
|
12773
13121
|
/** @description Dead/reachable dependency filter flag */
|
|
12774
13122
|
dependencyDead?: boolean[]
|
|
13123
|
+
/** @description Development/production dependency filter flag */
|
|
13124
|
+
dependencyDev?: boolean[]
|
|
13125
|
+
/** @description Direct/transitive dependency filter flag */
|
|
13126
|
+
dependencyDirect?: boolean[]
|
|
13127
|
+
/** @description Comma-separated list of repo full names that should be included */
|
|
13128
|
+
repoFullName?: string[]
|
|
13129
|
+
/** @description Comma-separated list of repo full names that should be excluded */
|
|
13130
|
+
'repoFullName.notIn'?: string[]
|
|
13131
|
+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
13132
|
+
repoLabels?: string[]
|
|
13133
|
+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
13134
|
+
'repoLabels.notIn'?: string[]
|
|
13135
|
+
/** @description Comma-separated list of repo slugs that should be included */
|
|
13136
|
+
repoSlug?: string[]
|
|
13137
|
+
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
13138
|
+
'repoSlug.notIn'?: string[]
|
|
12775
13139
|
}
|
|
12776
13140
|
}
|
|
12777
13141
|
}
|
|
@@ -12801,34 +13165,6 @@ export interface operations {
|
|
|
12801
13165
|
range?: string
|
|
12802
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) */
|
|
12803
13167
|
'aggregation.fields'?: string
|
|
12804
|
-
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
12805
|
-
'filters.alertSeverity'?: string
|
|
12806
|
-
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
12807
|
-
'filters.alertSeverity.notIn'?: string
|
|
12808
|
-
/** @description Comma-separated list of repo slugs that should be included */
|
|
12809
|
-
'filters.repoSlug'?: string
|
|
12810
|
-
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
12811
|
-
'filters.repoSlug.notIn'?: string
|
|
12812
|
-
/** @description Comma-separated list of repo full names that should be included */
|
|
12813
|
-
'filters.repoFullName'?: string
|
|
12814
|
-
/** @description Comma-separated list of repo full names that should be excluded */
|
|
12815
|
-
'filters.repoFullName.notIn'?: string
|
|
12816
|
-
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
12817
|
-
'filters.repoLabels'?: string
|
|
12818
|
-
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
12819
|
-
'filters.repoLabels.notIn'?: string
|
|
12820
|
-
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
12821
|
-
'filters.alertType'?: string
|
|
12822
|
-
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
12823
|
-
'filters.alertType.notIn'?: string
|
|
12824
|
-
/** @description Name of artifact */
|
|
12825
|
-
'filters.artifactName'?: string
|
|
12826
|
-
/** @description Name of artifact */
|
|
12827
|
-
'filters.artifactName.notIn'?: string
|
|
12828
|
-
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
|
|
12829
|
-
'filters.artifactType'?: string
|
|
12830
|
-
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
12831
|
-
'filters.artifactType.notIn'?: string
|
|
12832
13168
|
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
12833
13169
|
'filters.alertAction'?: string
|
|
12834
13170
|
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
@@ -12837,10 +13173,6 @@ export interface operations {
|
|
|
12837
13173
|
'filters.alertActionSourceType'?: string
|
|
12838
13174
|
/** @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 */
|
|
12839
13175
|
'filters.alertActionSourceType.notIn'?: string
|
|
12840
|
-
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
12841
|
-
'filters.alertFixType'?: string
|
|
12842
|
-
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
12843
|
-
'filters.alertFixType.notIn'?: string
|
|
12844
13176
|
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
|
|
12845
13177
|
'filters.alertCategory'?: string
|
|
12846
13178
|
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
|
|
@@ -12861,43 +13193,75 @@ export interface operations {
|
|
|
12861
13193
|
'filters.alertCweName'?: string
|
|
12862
13194
|
/** @description CWE name */
|
|
12863
13195
|
'filters.alertCweName.notIn'?: string
|
|
12864
|
-
/** @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 */
|
|
12865
|
-
'filters.alertReachabilityType'?: string
|
|
12866
|
-
/** @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 */
|
|
12867
|
-
'filters.alertReachabilityType.notIn'?: string
|
|
12868
|
-
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
|
|
12869
|
-
'filters.alertReachabilityAnalysisType'?: string
|
|
12870
|
-
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
12871
|
-
'filters.alertReachabilityAnalysisType.notIn'?: string
|
|
12872
|
-
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12873
|
-
'filters.alertPriority'?: string
|
|
12874
|
-
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12875
|
-
'filters.alertPriority.notIn'?: string
|
|
12876
|
-
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12877
|
-
'filters.alertKEV'?: boolean
|
|
12878
|
-
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12879
|
-
'filters.alertKEV.notIn'?: boolean
|
|
12880
13196
|
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
12881
13197
|
'filters.alertEPSS'?: string
|
|
12882
13198
|
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
12883
13199
|
'filters.alertEPSS.notIn'?: string
|
|
12884
|
-
/** @description
|
|
12885
|
-
'filters.
|
|
12886
|
-
/** @description
|
|
12887
|
-
'filters.
|
|
12888
|
-
/** @description
|
|
12889
|
-
'filters.
|
|
12890
|
-
/** @description
|
|
12891
|
-
'filters.
|
|
13200
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
13201
|
+
'filters.alertFixType'?: string
|
|
13202
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
13203
|
+
'filters.alertFixType.notIn'?: string
|
|
13204
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
13205
|
+
'filters.alertKEV'?: boolean
|
|
13206
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
13207
|
+
'filters.alertKEV.notIn'?: boolean
|
|
13208
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
13209
|
+
'filters.alertPriority'?: string
|
|
13210
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
13211
|
+
'filters.alertPriority.notIn'?: string
|
|
13212
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
|
|
13213
|
+
'filters.alertReachabilityAnalysisType'?: string
|
|
13214
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
13215
|
+
'filters.alertReachabilityAnalysisType.notIn'?: string
|
|
13216
|
+
/** @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 */
|
|
13217
|
+
'filters.alertReachabilityType'?: string
|
|
13218
|
+
/** @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 */
|
|
13219
|
+
'filters.alertReachabilityType.notIn'?: string
|
|
13220
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
13221
|
+
'filters.alertSeverity'?: string
|
|
13222
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
13223
|
+
'filters.alertSeverity.notIn'?: string
|
|
13224
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
13225
|
+
'filters.alertType'?: string
|
|
13226
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
13227
|
+
'filters.alertType.notIn'?: string
|
|
13228
|
+
/** @description Name of artifact */
|
|
13229
|
+
'filters.artifactName'?: string
|
|
13230
|
+
/** @description Name of artifact */
|
|
13231
|
+
'filters.artifactName.notIn'?: string
|
|
13232
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
|
|
13233
|
+
'filters.artifactType'?: string
|
|
13234
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
13235
|
+
'filters.artifactType.notIn'?: string
|
|
12892
13236
|
/** @description Dead/reachable dependency filter flag */
|
|
12893
13237
|
'filters.dependencyDead'?: boolean
|
|
12894
13238
|
/** @description Dead/reachable dependency filter flag */
|
|
12895
13239
|
'filters.dependencyDead.notIn'?: boolean
|
|
12896
|
-
|
|
12897
|
-
|
|
12898
|
-
/** @description
|
|
12899
|
-
|
|
12900
|
-
|
|
13240
|
+
/** @description Development/production dependency filter flag */
|
|
13241
|
+
'filters.dependencyDev'?: boolean
|
|
13242
|
+
/** @description Development/production dependency filter flag */
|
|
13243
|
+
'filters.dependencyDev.notIn'?: boolean
|
|
13244
|
+
/** @description Direct/transitive dependency filter flag */
|
|
13245
|
+
'filters.dependencyDirect'?: boolean
|
|
13246
|
+
/** @description Direct/transitive dependency filter flag */
|
|
13247
|
+
'filters.dependencyDirect.notIn'?: boolean
|
|
13248
|
+
/** @description Comma-separated list of repo full names that should be included */
|
|
13249
|
+
'filters.repoFullName'?: string
|
|
13250
|
+
/** @description Comma-separated list of repo full names that should be excluded */
|
|
13251
|
+
'filters.repoFullName.notIn'?: string
|
|
13252
|
+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
13253
|
+
'filters.repoLabels'?: string
|
|
13254
|
+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
13255
|
+
'filters.repoLabels.notIn'?: string
|
|
13256
|
+
/** @description Comma-separated list of repo slugs that should be included */
|
|
13257
|
+
'filters.repoSlug'?: string
|
|
13258
|
+
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
13259
|
+
'filters.repoSlug.notIn'?: string
|
|
13260
|
+
}
|
|
13261
|
+
path: {
|
|
13262
|
+
/** @description The slug of the organization */
|
|
13263
|
+
org_slug: string
|
|
13264
|
+
}
|
|
12901
13265
|
}
|
|
12902
13266
|
responses: {
|
|
12903
13267
|
/** @description The trend data */
|
|
@@ -12918,52 +13282,90 @@ export interface operations {
|
|
|
12918
13282
|
groups: string[][]
|
|
12919
13283
|
}
|
|
12920
13284
|
filters: {
|
|
12921
|
-
/** @description Comma-separated list of alert
|
|
12922
|
-
alertSeverity?: string[]
|
|
12923
|
-
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
12924
|
-
repoSlug?: string[]
|
|
12925
|
-
/** @description Comma-separated list of repo full names that should be excluded */
|
|
12926
|
-
repoFullName?: string[]
|
|
12927
|
-
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
12928
|
-
repoLabels?: string[]
|
|
12929
|
-
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
12930
|
-
alertType?: string[]
|
|
12931
|
-
/** @description Name of artifact */
|
|
12932
|
-
artifactName?: string[]
|
|
12933
|
-
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
12934
|
-
artifactType?: string[]
|
|
12935
|
-
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
13285
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
12936
13286
|
alertAction?: string[]
|
|
12937
|
-
/** @description Comma-separated list of alert
|
|
13287
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
13288
|
+
'alertAction.notIn'?: string[]
|
|
13289
|
+
/** @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 */
|
|
12938
13290
|
alertActionSourceType?: string[]
|
|
12939
|
-
/** @description Comma-separated list of alert
|
|
12940
|
-
|
|
12941
|
-
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be
|
|
13291
|
+
/** @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 */
|
|
13292
|
+
'alertActionSourceType.notIn'?: string[]
|
|
13293
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
|
|
12942
13294
|
alertCategory?: string[]
|
|
13295
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
|
|
13296
|
+
'alertCategory.notIn'?: string[]
|
|
12943
13297
|
/** @description CVE ID */
|
|
12944
13298
|
alertCveId?: string[]
|
|
13299
|
+
/** @description CVE ID */
|
|
13300
|
+
'alertCveId.notIn'?: string[]
|
|
12945
13301
|
/** @description CVE title */
|
|
12946
13302
|
alertCveTitle?: string[]
|
|
13303
|
+
/** @description CVE title */
|
|
13304
|
+
'alertCveTitle.notIn'?: string[]
|
|
12947
13305
|
/** @description CWE ID */
|
|
12948
13306
|
alertCweId?: string[]
|
|
13307
|
+
/** @description CWE ID */
|
|
13308
|
+
'alertCweId.notIn'?: string[]
|
|
12949
13309
|
/** @description CWE name */
|
|
12950
13310
|
alertCweName?: string[]
|
|
12951
|
-
/** @description
|
|
12952
|
-
|
|
12953
|
-
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
12954
|
-
alertReachabilityAnalysisType?: string[]
|
|
12955
|
-
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
12956
|
-
alertPriority?: string[]
|
|
12957
|
-
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
12958
|
-
alertKEV?: boolean[]
|
|
13311
|
+
/** @description CWE name */
|
|
13312
|
+
'alertCweName.notIn'?: string[]
|
|
12959
13313
|
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
12960
13314
|
alertEPSS?: string[]
|
|
12961
|
-
/** @description
|
|
12962
|
-
|
|
12963
|
-
/** @description
|
|
12964
|
-
|
|
13315
|
+
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
13316
|
+
'alertEPSS.notIn'?: string[]
|
|
13317
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
13318
|
+
alertFixType?: string[]
|
|
13319
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
13320
|
+
'alertFixType.notIn'?: string[]
|
|
13321
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
13322
|
+
alertKEV?: boolean[]
|
|
13323
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
13324
|
+
alertPriority?: string[]
|
|
13325
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
13326
|
+
'alertPriority.notIn'?: string[]
|
|
13327
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included */
|
|
13328
|
+
alertReachabilityAnalysisType?: string[]
|
|
13329
|
+
/** @description Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded */
|
|
13330
|
+
'alertReachabilityAnalysisType.notIn'?: string[]
|
|
13331
|
+
/** @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 */
|
|
13332
|
+
alertReachabilityType?: string[]
|
|
13333
|
+
/** @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 */
|
|
13334
|
+
'alertReachabilityType.notIn'?: string[]
|
|
13335
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
13336
|
+
alertSeverity?: string[]
|
|
13337
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
13338
|
+
'alertSeverity.notIn'?: string[]
|
|
13339
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
13340
|
+
alertType?: string[]
|
|
13341
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
13342
|
+
'alertType.notIn'?: string[]
|
|
13343
|
+
/** @description Name of artifact */
|
|
13344
|
+
artifactName?: string[]
|
|
13345
|
+
/** @description Name of artifact */
|
|
13346
|
+
'artifactName.notIn'?: string[]
|
|
13347
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included */
|
|
13348
|
+
artifactType?: string[]
|
|
13349
|
+
/** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
|
|
13350
|
+
'artifactType.notIn'?: string[]
|
|
12965
13351
|
/** @description Dead/reachable dependency filter flag */
|
|
12966
13352
|
dependencyDead?: boolean[]
|
|
13353
|
+
/** @description Development/production dependency filter flag */
|
|
13354
|
+
dependencyDev?: boolean[]
|
|
13355
|
+
/** @description Direct/transitive dependency filter flag */
|
|
13356
|
+
dependencyDirect?: boolean[]
|
|
13357
|
+
/** @description Comma-separated list of repo full names that should be included */
|
|
13358
|
+
repoFullName?: string[]
|
|
13359
|
+
/** @description Comma-separated list of repo full names that should be excluded */
|
|
13360
|
+
'repoFullName.notIn'?: string[]
|
|
13361
|
+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
13362
|
+
repoLabels?: string[]
|
|
13363
|
+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
13364
|
+
'repoLabels.notIn'?: string[]
|
|
13365
|
+
/** @description Comma-separated list of repo slugs that should be included */
|
|
13366
|
+
repoSlug?: string[]
|
|
13367
|
+
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
13368
|
+
'repoSlug.notIn'?: string[]
|
|
12967
13369
|
}
|
|
12968
13370
|
}
|
|
12969
13371
|
items: Array<{
|
|
@@ -13337,6 +13739,9 @@ export interface operations {
|
|
|
13337
13739
|
| 'DisassociateLabel'
|
|
13338
13740
|
| 'DowngradeOrganizationPlan'
|
|
13339
13741
|
| 'JoinOrganization'
|
|
13742
|
+
| 'MemberAdded'
|
|
13743
|
+
| 'MemberRemoved'
|
|
13744
|
+
| 'MemberRoleChanged'
|
|
13340
13745
|
| 'RemoveLicenseOverlay'
|
|
13341
13746
|
| 'RemoveMember'
|
|
13342
13747
|
| 'ResetInvitationLink'
|
|
@@ -13451,21 +13856,39 @@ export interface operations {
|
|
|
13451
13856
|
content: {
|
|
13452
13857
|
'application/json': {
|
|
13453
13858
|
tokens: Array<{
|
|
13859
|
+
/** @description List of committers associated with this API Token */
|
|
13454
13860
|
committers: {
|
|
13455
|
-
/**
|
|
13861
|
+
/**
|
|
13862
|
+
* @description Email address of the committer
|
|
13863
|
+
* @default
|
|
13864
|
+
*/
|
|
13456
13865
|
email?: string
|
|
13457
13866
|
/**
|
|
13867
|
+
* @description The source control provider for the committer
|
|
13458
13868
|
* @default api
|
|
13459
13869
|
* @enum {string}
|
|
13460
13870
|
*/
|
|
13461
13871
|
provider?: 'api' | 'azure' | 'bitbucket' | 'github' | 'gitlab'
|
|
13462
|
-
/**
|
|
13872
|
+
/**
|
|
13873
|
+
* @description Login name on the provider platform
|
|
13874
|
+
* @default
|
|
13875
|
+
*/
|
|
13463
13876
|
providerLoginName?: string
|
|
13464
|
-
/**
|
|
13877
|
+
/**
|
|
13878
|
+
* @description User ID on the provider platform
|
|
13879
|
+
* @default
|
|
13880
|
+
*/
|
|
13465
13881
|
providerUserId?: string
|
|
13466
13882
|
}[]
|
|
13883
|
+
/**
|
|
13884
|
+
* Format: uuid
|
|
13885
|
+
* @description ID of the Socket user who created the API Token
|
|
13886
|
+
* @default
|
|
13887
|
+
*/
|
|
13888
|
+
created_by: string | null
|
|
13467
13889
|
/**
|
|
13468
13890
|
* Format: date
|
|
13891
|
+
* @description Timestamp when the API Token was created
|
|
13469
13892
|
* @default
|
|
13470
13893
|
*/
|
|
13471
13894
|
created_at: string
|
|
@@ -13476,16 +13899,21 @@ export interface operations {
|
|
|
13476
13899
|
id: string
|
|
13477
13900
|
/**
|
|
13478
13901
|
* Format: date
|
|
13902
|
+
* @description Timestamp when the API Token was last used
|
|
13479
13903
|
* @default
|
|
13480
13904
|
*/
|
|
13481
13905
|
last_used_at: string
|
|
13482
|
-
/**
|
|
13906
|
+
/**
|
|
13907
|
+
* @description Maximum number of API calls allowed per month
|
|
13908
|
+
* @default 1000
|
|
13909
|
+
*/
|
|
13483
13910
|
max_quota: number
|
|
13484
13911
|
/**
|
|
13485
13912
|
* @description Name for the API Token
|
|
13486
13913
|
* @default api token
|
|
13487
13914
|
*/
|
|
13488
13915
|
name: string | null
|
|
13916
|
+
/** @description List of scopes granted to the API Token */
|
|
13489
13917
|
scopes: (
|
|
13490
13918
|
| 'alerts'
|
|
13491
13919
|
| 'alerts:list'
|
|
@@ -13501,6 +13929,8 @@ export interface operations {
|
|
|
13501
13929
|
| 'dependencies'
|
|
13502
13930
|
| 'dependencies:list'
|
|
13503
13931
|
| 'dependencies:trend'
|
|
13932
|
+
| 'fixes'
|
|
13933
|
+
| 'fixes:list'
|
|
13504
13934
|
| 'full-scans'
|
|
13505
13935
|
| 'full-scans:list'
|
|
13506
13936
|
| 'full-scans:create'
|
|
@@ -13547,11 +13977,18 @@ export interface operations {
|
|
|
13547
13977
|
| 'security-policy:read'
|
|
13548
13978
|
| 'socket-basics'
|
|
13549
13979
|
| 'socket-basics:read'
|
|
13980
|
+
| 'telemetry-policy'
|
|
13981
|
+
| 'telemetry-policy:update'
|
|
13550
13982
|
| 'threat-feed'
|
|
13551
13983
|
| 'threat-feed:list'
|
|
13552
13984
|
| 'triage'
|
|
13553
13985
|
| 'triage:alerts-list'
|
|
13554
13986
|
| 'triage:alerts-update'
|
|
13987
|
+
| 'webhooks'
|
|
13988
|
+
| 'webhooks:create'
|
|
13989
|
+
| 'webhooks:list'
|
|
13990
|
+
| 'webhooks:update'
|
|
13991
|
+
| 'webhooks:delete'
|
|
13555
13992
|
)[]
|
|
13556
13993
|
/**
|
|
13557
13994
|
* @description The obfuscated token of the API Token
|
|
@@ -13595,8 +14032,12 @@ export interface operations {
|
|
|
13595
14032
|
requestBody?: {
|
|
13596
14033
|
content: {
|
|
13597
14034
|
'application/json': {
|
|
13598
|
-
/**
|
|
14035
|
+
/**
|
|
14036
|
+
* @description Maximum number of API calls allowed per month
|
|
14037
|
+
* @default 1000
|
|
14038
|
+
*/
|
|
13599
14039
|
max_quota: number
|
|
14040
|
+
/** @description List of scopes granted to the API Token */
|
|
13600
14041
|
scopes: Array<
|
|
13601
14042
|
| 'alerts'
|
|
13602
14043
|
| 'alerts:list'
|
|
@@ -13612,6 +14053,8 @@ export interface operations {
|
|
|
13612
14053
|
| 'dependencies'
|
|
13613
14054
|
| 'dependencies:list'
|
|
13614
14055
|
| 'dependencies:trend'
|
|
14056
|
+
| 'fixes'
|
|
14057
|
+
| 'fixes:list'
|
|
13615
14058
|
| 'full-scans'
|
|
13616
14059
|
| 'full-scans:list'
|
|
13617
14060
|
| 'full-scans:create'
|
|
@@ -13658,11 +14101,18 @@ export interface operations {
|
|
|
13658
14101
|
| 'security-policy:read'
|
|
13659
14102
|
| 'socket-basics'
|
|
13660
14103
|
| 'socket-basics:read'
|
|
14104
|
+
| 'telemetry-policy'
|
|
14105
|
+
| 'telemetry-policy:update'
|
|
13661
14106
|
| 'threat-feed'
|
|
13662
14107
|
| 'threat-feed:list'
|
|
13663
14108
|
| 'triage'
|
|
13664
14109
|
| 'triage:alerts-list'
|
|
13665
14110
|
| 'triage:alerts-update'
|
|
14111
|
+
| 'webhooks'
|
|
14112
|
+
| 'webhooks:create'
|
|
14113
|
+
| 'webhooks:list'
|
|
14114
|
+
| 'webhooks:update'
|
|
14115
|
+
| 'webhooks:delete'
|
|
13666
14116
|
>
|
|
13667
14117
|
/**
|
|
13668
14118
|
* @description The visibility of the API Token. Warning: this field is deprecated and will be removed in the future.
|
|
@@ -13670,17 +14120,28 @@ export interface operations {
|
|
|
13670
14120
|
* @enum {string}
|
|
13671
14121
|
*/
|
|
13672
14122
|
visibility: 'admin' | 'organization'
|
|
14123
|
+
/** @description Committer information to associate with the API Token */
|
|
13673
14124
|
committer: {
|
|
13674
|
-
/**
|
|
14125
|
+
/**
|
|
14126
|
+
* @description Email address of the committer
|
|
14127
|
+
* @default
|
|
14128
|
+
*/
|
|
13675
14129
|
email?: string
|
|
13676
14130
|
/**
|
|
14131
|
+
* @description The source control provider for the committer
|
|
13677
14132
|
* @default api
|
|
13678
14133
|
* @enum {string}
|
|
13679
14134
|
*/
|
|
13680
14135
|
provider?: 'api' | 'azure' | 'bitbucket' | 'github' | 'gitlab'
|
|
13681
|
-
/**
|
|
14136
|
+
/**
|
|
14137
|
+
* @description Login name on the provider platform
|
|
14138
|
+
* @default
|
|
14139
|
+
*/
|
|
13682
14140
|
providerLoginName?: string
|
|
13683
|
-
/**
|
|
14141
|
+
/**
|
|
14142
|
+
* @description User ID on the provider platform
|
|
14143
|
+
* @default
|
|
14144
|
+
*/
|
|
13684
14145
|
providerUserId?: string
|
|
13685
14146
|
}
|
|
13686
14147
|
/**
|
|
@@ -13688,6 +14149,24 @@ export interface operations {
|
|
|
13688
14149
|
* @default api token
|
|
13689
14150
|
*/
|
|
13690
14151
|
name?: string
|
|
14152
|
+
/** @description List of resources this API Token can access. Tokens with resource grants can only access a subset of routes that support this feature. */
|
|
14153
|
+
resources?: Array<{
|
|
14154
|
+
/**
|
|
14155
|
+
* @description Slug of the organization to grant access to
|
|
14156
|
+
* @default
|
|
14157
|
+
*/
|
|
14158
|
+
organizationSlug: string
|
|
14159
|
+
/**
|
|
14160
|
+
* @description Slug of the repository to grant access to
|
|
14161
|
+
* @default
|
|
14162
|
+
*/
|
|
14163
|
+
repositorySlug: string
|
|
14164
|
+
/**
|
|
14165
|
+
* @description Workspace slug containing the specified repo
|
|
14166
|
+
* @default
|
|
14167
|
+
*/
|
|
14168
|
+
workspace?: string
|
|
14169
|
+
}>
|
|
13691
14170
|
}
|
|
13692
14171
|
}
|
|
13693
14172
|
}
|
|
@@ -13696,6 +14175,12 @@ export interface operations {
|
|
|
13696
14175
|
200: {
|
|
13697
14176
|
content: {
|
|
13698
14177
|
'application/json': {
|
|
14178
|
+
/**
|
|
14179
|
+
* Format: uuid
|
|
14180
|
+
* @description ID of the Socket user who created the API Token, if available
|
|
14181
|
+
* @default
|
|
14182
|
+
*/
|
|
14183
|
+
created_by: string | null
|
|
13699
14184
|
/** @default */
|
|
13700
14185
|
token: string
|
|
13701
14186
|
}
|
|
@@ -13726,8 +14211,12 @@ export interface operations {
|
|
|
13726
14211
|
requestBody?: {
|
|
13727
14212
|
content: {
|
|
13728
14213
|
'application/json': {
|
|
13729
|
-
/**
|
|
14214
|
+
/**
|
|
14215
|
+
* @description Maximum number of API calls allowed per hour
|
|
14216
|
+
* @default 1000
|
|
14217
|
+
*/
|
|
13730
14218
|
max_quota: number
|
|
14219
|
+
/** @description List of scopes granted to the API Token */
|
|
13731
14220
|
scopes: Array<
|
|
13732
14221
|
| 'alerts'
|
|
13733
14222
|
| 'alerts:list'
|
|
@@ -13743,6 +14232,8 @@ export interface operations {
|
|
|
13743
14232
|
| 'dependencies'
|
|
13744
14233
|
| 'dependencies:list'
|
|
13745
14234
|
| 'dependencies:trend'
|
|
14235
|
+
| 'fixes'
|
|
14236
|
+
| 'fixes:list'
|
|
13746
14237
|
| 'full-scans'
|
|
13747
14238
|
| 'full-scans:list'
|
|
13748
14239
|
| 'full-scans:create'
|
|
@@ -13789,13 +14280,23 @@ export interface operations {
|
|
|
13789
14280
|
| 'security-policy:read'
|
|
13790
14281
|
| 'socket-basics'
|
|
13791
14282
|
| 'socket-basics:read'
|
|
14283
|
+
| 'telemetry-policy'
|
|
14284
|
+
| 'telemetry-policy:update'
|
|
13792
14285
|
| 'threat-feed'
|
|
13793
14286
|
| 'threat-feed:list'
|
|
13794
14287
|
| 'triage'
|
|
13795
14288
|
| 'triage:alerts-list'
|
|
13796
14289
|
| 'triage:alerts-update'
|
|
14290
|
+
| 'webhooks'
|
|
14291
|
+
| 'webhooks:create'
|
|
14292
|
+
| 'webhooks:list'
|
|
14293
|
+
| 'webhooks:update'
|
|
14294
|
+
| 'webhooks:delete'
|
|
13797
14295
|
>
|
|
13798
|
-
/**
|
|
14296
|
+
/**
|
|
14297
|
+
* @description The API token to update
|
|
14298
|
+
* @default
|
|
14299
|
+
*/
|
|
13799
14300
|
token: string
|
|
13800
14301
|
/**
|
|
13801
14302
|
* @description The visibility of the API Token. Warning: this field is deprecated and will be removed in the future.
|
|
@@ -13803,17 +14304,28 @@ export interface operations {
|
|
|
13803
14304
|
* @enum {string}
|
|
13804
14305
|
*/
|
|
13805
14306
|
visibility: 'admin' | 'organization'
|
|
14307
|
+
/** @description Committer information to associate with the API Token */
|
|
13806
14308
|
committer: {
|
|
13807
|
-
/**
|
|
14309
|
+
/**
|
|
14310
|
+
* @description Email address of the committer
|
|
14311
|
+
* @default
|
|
14312
|
+
*/
|
|
13808
14313
|
email?: string
|
|
13809
14314
|
/**
|
|
14315
|
+
* @description The source control provider for the committer
|
|
13810
14316
|
* @default api
|
|
13811
14317
|
* @enum {string}
|
|
13812
14318
|
*/
|
|
13813
14319
|
provider?: 'api' | 'azure' | 'bitbucket' | 'github' | 'gitlab'
|
|
13814
|
-
/**
|
|
14320
|
+
/**
|
|
14321
|
+
* @description Login name on the provider platform
|
|
14322
|
+
* @default
|
|
14323
|
+
*/
|
|
13815
14324
|
providerLoginName?: string
|
|
13816
|
-
/**
|
|
14325
|
+
/**
|
|
14326
|
+
* @description User ID on the provider platform
|
|
14327
|
+
* @default
|
|
14328
|
+
*/
|
|
13817
14329
|
providerUserId?: string
|
|
13818
14330
|
}
|
|
13819
14331
|
/**
|
|
@@ -13869,6 +14381,12 @@ export interface operations {
|
|
|
13869
14381
|
200: {
|
|
13870
14382
|
content: {
|
|
13871
14383
|
'application/json': {
|
|
14384
|
+
/**
|
|
14385
|
+
* Format: uuid
|
|
14386
|
+
* @description ID of the Socket user who initiated the rotation, if available
|
|
14387
|
+
* @default
|
|
14388
|
+
*/
|
|
14389
|
+
created_by: string | null
|
|
13872
14390
|
/** @default */
|
|
13873
14391
|
token: string
|
|
13874
14392
|
}
|
|
@@ -14012,6 +14530,7 @@ export interface operations {
|
|
|
14012
14530
|
ecosystem?:
|
|
14013
14531
|
| 'github'
|
|
14014
14532
|
| 'cargo'
|
|
14533
|
+
| 'composer'
|
|
14015
14534
|
| 'chrome'
|
|
14016
14535
|
| 'golang'
|
|
14017
14536
|
| 'huggingface'
|
|
@@ -14052,6 +14571,11 @@ export interface operations {
|
|
|
14052
14571
|
* @default false
|
|
14053
14572
|
*/
|
|
14054
14573
|
needsHumanReview?: boolean
|
|
14574
|
+
/**
|
|
14575
|
+
* @description Unique threat instance identifier across artifacts
|
|
14576
|
+
* @default 0
|
|
14577
|
+
*/
|
|
14578
|
+
threatInstanceId?: number
|
|
14055
14579
|
}>
|
|
14056
14580
|
/** @default */
|
|
14057
14581
|
nextPage: string | null
|
|
@@ -14066,65 +14590,1161 @@ export interface operations {
|
|
|
14066
14590
|
}
|
|
14067
14591
|
}
|
|
14068
14592
|
/**
|
|
14069
|
-
* Get Threat Feed Items (Beta)
|
|
14070
|
-
* @description Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.
|
|
14071
|
-
*
|
|
14072
|
-
* 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.
|
|
14593
|
+
* Get Threat Feed Items (Beta)
|
|
14594
|
+
* @description Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.
|
|
14595
|
+
*
|
|
14596
|
+
* 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
|
+
*
|
|
14598
|
+
* This endpoint consumes 1 unit of your quota.
|
|
14599
|
+
*
|
|
14600
|
+
* This endpoint requires the following org token scopes:
|
|
14601
|
+
* - threat-feed:list
|
|
14602
|
+
*/
|
|
14603
|
+
getOrgThreatFeedItems: {
|
|
14604
|
+
parameters: {
|
|
14605
|
+
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'
|
|
14653
|
+
}
|
|
14654
|
+
path: {
|
|
14655
|
+
/** @description The slug of the organization */
|
|
14656
|
+
org_slug: string
|
|
14657
|
+
}
|
|
14658
|
+
}
|
|
14659
|
+
responses: {
|
|
14660
|
+
/** @description The paginated list of items in the threat feed and the next page cursor. */
|
|
14661
|
+
200: {
|
|
14662
|
+
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
|
+
}
|
|
14697
|
+
}
|
|
14698
|
+
}
|
|
14699
|
+
400: components['responses']['SocketBadRequest']
|
|
14700
|
+
401: components['responses']['SocketUnauthorized']
|
|
14701
|
+
403: components['responses']['SocketForbidden']
|
|
14702
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
14703
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
14704
|
+
}
|
|
14705
|
+
}
|
|
14706
|
+
/**
|
|
14707
|
+
* Fetch fixes for vulnerabilities in a repository or scan
|
|
14708
|
+
* @description Fetches available fixes for vulnerabilities in a repository or scan.
|
|
14709
|
+
* Requires either repo_slug or full_scan_id as well as vulnerability_ids to be provided.
|
|
14710
|
+
* vulnerability_ids can be a comma-separated list of GHSA or CVE IDs, or "*" for all vulnerabilities.
|
|
14711
|
+
*
|
|
14712
|
+
* This endpoint consumes 10 units of your quota.
|
|
14713
|
+
*
|
|
14714
|
+
* This endpoint requires the following org token scopes:
|
|
14715
|
+
* - fixes:list
|
|
14716
|
+
*/
|
|
14717
|
+
'fetch-fixes': {
|
|
14718
|
+
parameters: {
|
|
14719
|
+
query: {
|
|
14720
|
+
/** @description The slug of the repository to fetch fixes for. Computes fixes based on the latest scan on the default branch */
|
|
14721
|
+
repo_slug?: string
|
|
14722
|
+
/** @description The ID of the scan to fetch fixes for */
|
|
14723
|
+
full_scan_id?: string
|
|
14724
|
+
/** @description Comma-separated list of GHSA or CVE IDs, or "*" for all vulnerabilities */
|
|
14725
|
+
vulnerability_ids: string
|
|
14726
|
+
/** @description Whether to allow major version updates in fixes */
|
|
14727
|
+
allow_major_updates: boolean
|
|
14728
|
+
/** @description Minimum release age for fixes packages (e.g., "1h", "2d", "1w"). Higher values reduces risk of installing recently released untested package versions. */
|
|
14729
|
+
minimum_release_age?: string
|
|
14730
|
+
/** @description Whether to include advisory details in the response */
|
|
14731
|
+
include_details?: boolean
|
|
14732
|
+
/** @description Set to include the direct dependencies responsible for introducing the dependency or dependencies with the vulnerability in the response */
|
|
14733
|
+
include_responsible_direct_dependencies?: boolean
|
|
14734
|
+
}
|
|
14735
|
+
path: {
|
|
14736
|
+
/** @description The slug of the organization */
|
|
14737
|
+
org_slug: string
|
|
14738
|
+
}
|
|
14739
|
+
}
|
|
14740
|
+
responses: {
|
|
14741
|
+
/** @description Fix details for requested vulnerabilities */
|
|
14742
|
+
200: {
|
|
14743
|
+
content: {
|
|
14744
|
+
'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
|
+
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
|
+
}
|
|
15124
|
+
}
|
|
15125
|
+
}
|
|
15126
|
+
}
|
|
15127
|
+
}
|
|
15128
|
+
400: components['responses']['SocketBadRequest']
|
|
15129
|
+
401: components['responses']['SocketUnauthorized']
|
|
15130
|
+
403: components['responses']['SocketForbidden']
|
|
15131
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15132
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15133
|
+
}
|
|
15134
|
+
}
|
|
15135
|
+
/**
|
|
15136
|
+
* Get Organization Telemetry Config
|
|
15137
|
+
* @description Retrieve the telemetry config of an organization.
|
|
15138
|
+
*
|
|
15139
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15140
|
+
*
|
|
15141
|
+
* This endpoint requires the following org token scopes:
|
|
15142
|
+
*/
|
|
15143
|
+
getOrgTelemetryConfig: {
|
|
15144
|
+
parameters: {
|
|
15145
|
+
path: {
|
|
15146
|
+
/** @description The slug of the organization */
|
|
15147
|
+
org_slug: string
|
|
15148
|
+
}
|
|
15149
|
+
}
|
|
15150
|
+
responses: {
|
|
15151
|
+
/** @description Retrieved telemetry config details */
|
|
15152
|
+
200: {
|
|
15153
|
+
content: {
|
|
15154
|
+
'application/json': {
|
|
15155
|
+
/** @description Telemetry configuration */
|
|
15156
|
+
telemetry: {
|
|
15157
|
+
/**
|
|
15158
|
+
* @description Telemetry enabled
|
|
15159
|
+
* @default false
|
|
15160
|
+
*/
|
|
15161
|
+
enabled: boolean
|
|
15162
|
+
}
|
|
15163
|
+
}
|
|
15164
|
+
}
|
|
15165
|
+
}
|
|
15166
|
+
400: components['responses']['SocketBadRequest']
|
|
15167
|
+
401: components['responses']['SocketUnauthorized']
|
|
15168
|
+
403: components['responses']['SocketForbidden']
|
|
15169
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15170
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15171
|
+
}
|
|
15172
|
+
}
|
|
15173
|
+
/**
|
|
15174
|
+
* Update Telemetry Config
|
|
15175
|
+
* @description Update the telemetry config of an organization.
|
|
15176
|
+
*
|
|
15177
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15178
|
+
*
|
|
15179
|
+
* This endpoint requires the following org token scopes:
|
|
15180
|
+
* - telemetry-policy:update
|
|
15181
|
+
*/
|
|
15182
|
+
updateOrgTelemetryConfig: {
|
|
15183
|
+
parameters: {
|
|
15184
|
+
path: {
|
|
15185
|
+
/** @description The slug of the organization */
|
|
15186
|
+
org_slug: string
|
|
15187
|
+
}
|
|
15188
|
+
}
|
|
15189
|
+
requestBody?: {
|
|
15190
|
+
content: {
|
|
15191
|
+
'application/json': {
|
|
15192
|
+
/**
|
|
15193
|
+
* @description Telemetry enabled
|
|
15194
|
+
* @default false
|
|
15195
|
+
*/
|
|
15196
|
+
enabled?: boolean
|
|
15197
|
+
}
|
|
15198
|
+
}
|
|
15199
|
+
}
|
|
15200
|
+
responses: {
|
|
15201
|
+
/** @description Updated telemetry config details */
|
|
15202
|
+
200: {
|
|
15203
|
+
content: {
|
|
15204
|
+
'application/json': {
|
|
15205
|
+
/** @description Telemetry configuration */
|
|
15206
|
+
telemetry: {
|
|
15207
|
+
/**
|
|
15208
|
+
* @description Telemetry enabled
|
|
15209
|
+
* @default false
|
|
15210
|
+
*/
|
|
15211
|
+
enabled: boolean
|
|
15212
|
+
}
|
|
15213
|
+
}
|
|
15214
|
+
}
|
|
15215
|
+
}
|
|
15216
|
+
400: components['responses']['SocketBadRequest']
|
|
15217
|
+
401: components['responses']['SocketUnauthorized']
|
|
15218
|
+
403: components['responses']['SocketForbidden']
|
|
15219
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15220
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15221
|
+
}
|
|
15222
|
+
}
|
|
15223
|
+
/**
|
|
15224
|
+
* List all webhooks
|
|
15225
|
+
* @description List all webhooks in the specified organization.
|
|
15226
|
+
*
|
|
15227
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15228
|
+
*
|
|
15229
|
+
* This endpoint requires the following org token scopes:
|
|
15230
|
+
* - webhooks:list
|
|
15231
|
+
*/
|
|
15232
|
+
getOrgWebhooksList: {
|
|
15233
|
+
parameters: {
|
|
15234
|
+
query?: {
|
|
15235
|
+
sort?: string
|
|
15236
|
+
direction?: string
|
|
15237
|
+
per_page?: number
|
|
15238
|
+
page?: number
|
|
15239
|
+
}
|
|
15240
|
+
path: {
|
|
15241
|
+
/** @description The slug of the organization */
|
|
15242
|
+
org_slug: string
|
|
15243
|
+
}
|
|
15244
|
+
}
|
|
15245
|
+
responses: {
|
|
15246
|
+
/** @description List of webhooks */
|
|
15247
|
+
200: {
|
|
15248
|
+
content: {
|
|
15249
|
+
'application/json': {
|
|
15250
|
+
results: Array<{
|
|
15251
|
+
/**
|
|
15252
|
+
* @description The ID of the webhook
|
|
15253
|
+
* @default
|
|
15254
|
+
*/
|
|
15255
|
+
id: string
|
|
15256
|
+
/**
|
|
15257
|
+
* @description The creation date of the webhook
|
|
15258
|
+
* @default
|
|
15259
|
+
*/
|
|
15260
|
+
created_at: string
|
|
15261
|
+
/**
|
|
15262
|
+
* @description The last update date of the webhook
|
|
15263
|
+
* @default
|
|
15264
|
+
*/
|
|
15265
|
+
updated_at: string
|
|
15266
|
+
/**
|
|
15267
|
+
* @description The name of the webhook
|
|
15268
|
+
* @default
|
|
15269
|
+
*/
|
|
15270
|
+
name: string
|
|
15271
|
+
/**
|
|
15272
|
+
* @description The description of the webhook
|
|
15273
|
+
* @default
|
|
15274
|
+
*/
|
|
15275
|
+
description: string | null
|
|
15276
|
+
/**
|
|
15277
|
+
* @description The URL where webhook events will be sent
|
|
15278
|
+
* @default
|
|
15279
|
+
*/
|
|
15280
|
+
url: string
|
|
15281
|
+
/**
|
|
15282
|
+
* @description The signing key used to sign webhook payloads
|
|
15283
|
+
* @default
|
|
15284
|
+
*/
|
|
15285
|
+
secret: string | null
|
|
15286
|
+
/** @description Array of event names */
|
|
15287
|
+
events: string[]
|
|
15288
|
+
/**
|
|
15289
|
+
* @description Custom headers to include in webhook requests
|
|
15290
|
+
* @default null
|
|
15291
|
+
*/
|
|
15292
|
+
headers: Record<string, unknown> | null
|
|
15293
|
+
filters: {
|
|
15294
|
+
/** @description Array of repository IDs */
|
|
15295
|
+
repositoryIds: string[] | null
|
|
15296
|
+
} | null
|
|
15297
|
+
}>
|
|
15298
|
+
/** @default 0 */
|
|
15299
|
+
nextPage: number | null
|
|
15300
|
+
}
|
|
15301
|
+
}
|
|
15302
|
+
}
|
|
15303
|
+
400: components['responses']['SocketBadRequest']
|
|
15304
|
+
401: components['responses']['SocketUnauthorized']
|
|
15305
|
+
403: components['responses']['SocketForbidden']
|
|
15306
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15307
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15308
|
+
}
|
|
15309
|
+
}
|
|
15310
|
+
/**
|
|
15311
|
+
* Create a webhook
|
|
15312
|
+
* @description Create a new webhook. Returns the created webhook details.
|
|
15313
|
+
*
|
|
15314
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15315
|
+
*
|
|
15316
|
+
* This endpoint requires the following org token scopes:
|
|
15317
|
+
* - webhooks:create
|
|
15318
|
+
*/
|
|
15319
|
+
createOrgWebhook: {
|
|
15320
|
+
parameters: {
|
|
15321
|
+
path: {
|
|
15322
|
+
/** @description The slug of the organization */
|
|
15323
|
+
org_slug: string
|
|
15324
|
+
}
|
|
15325
|
+
}
|
|
15326
|
+
requestBody?: {
|
|
15327
|
+
content: {
|
|
15328
|
+
'application/json': {
|
|
15329
|
+
/**
|
|
15330
|
+
* @description The name of the webhook
|
|
15331
|
+
* @default
|
|
15332
|
+
*/
|
|
15333
|
+
name: string
|
|
15334
|
+
/**
|
|
15335
|
+
* @description The URL where webhook events will be sent
|
|
15336
|
+
* @default
|
|
15337
|
+
*/
|
|
15338
|
+
url: string
|
|
15339
|
+
/**
|
|
15340
|
+
* @description The signing key used to sign webhook payloads
|
|
15341
|
+
* @default
|
|
15342
|
+
*/
|
|
15343
|
+
secret: string
|
|
15344
|
+
/** @description Array of event names */
|
|
15345
|
+
events: string[]
|
|
15346
|
+
/**
|
|
15347
|
+
* @description The description of the webhook
|
|
15348
|
+
* @default
|
|
15349
|
+
*/
|
|
15350
|
+
description?: string | null
|
|
15351
|
+
/**
|
|
15352
|
+
* @description Custom headers to include in webhook requests
|
|
15353
|
+
* @default null
|
|
15354
|
+
*/
|
|
15355
|
+
headers?: Record<string, unknown> | null
|
|
15356
|
+
filters?: {
|
|
15357
|
+
/** @description Array of repository IDs */
|
|
15358
|
+
repositoryIds: string[] | null
|
|
15359
|
+
} | null
|
|
15360
|
+
}
|
|
15361
|
+
}
|
|
15362
|
+
}
|
|
15363
|
+
responses: {
|
|
15364
|
+
/** @description The created webhook */
|
|
15365
|
+
201: {
|
|
15366
|
+
content: {
|
|
15367
|
+
'application/json': {
|
|
15368
|
+
/**
|
|
15369
|
+
* @description The ID of the webhook
|
|
15370
|
+
* @default
|
|
15371
|
+
*/
|
|
15372
|
+
id: string
|
|
15373
|
+
/**
|
|
15374
|
+
* @description The creation date of the webhook
|
|
15375
|
+
* @default
|
|
15376
|
+
*/
|
|
15377
|
+
created_at: string
|
|
15378
|
+
/**
|
|
15379
|
+
* @description The last update date of the webhook
|
|
15380
|
+
* @default
|
|
15381
|
+
*/
|
|
15382
|
+
updated_at: string
|
|
15383
|
+
/**
|
|
15384
|
+
* @description The name of the webhook
|
|
15385
|
+
* @default
|
|
15386
|
+
*/
|
|
15387
|
+
name: string
|
|
15388
|
+
/**
|
|
15389
|
+
* @description The description of the webhook
|
|
15390
|
+
* @default
|
|
15391
|
+
*/
|
|
15392
|
+
description: string | null
|
|
15393
|
+
/**
|
|
15394
|
+
* @description The URL where webhook events will be sent
|
|
15395
|
+
* @default
|
|
15396
|
+
*/
|
|
15397
|
+
url: string
|
|
15398
|
+
/**
|
|
15399
|
+
* @description The signing key used to sign webhook payloads
|
|
15400
|
+
* @default
|
|
15401
|
+
*/
|
|
15402
|
+
secret: string | null
|
|
15403
|
+
/** @description Array of event names */
|
|
15404
|
+
events: string[]
|
|
15405
|
+
/**
|
|
15406
|
+
* @description Custom headers to include in webhook requests
|
|
15407
|
+
* @default null
|
|
15408
|
+
*/
|
|
15409
|
+
headers: Record<string, unknown> | null
|
|
15410
|
+
filters: {
|
|
15411
|
+
/** @description Array of repository IDs */
|
|
15412
|
+
repositoryIds: string[] | null
|
|
15413
|
+
} | null
|
|
15414
|
+
}
|
|
15415
|
+
}
|
|
15416
|
+
}
|
|
15417
|
+
400: components['responses']['SocketBadRequest']
|
|
15418
|
+
401: components['responses']['SocketUnauthorized']
|
|
15419
|
+
403: components['responses']['SocketForbidden']
|
|
15420
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15421
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15422
|
+
}
|
|
15423
|
+
}
|
|
15424
|
+
/**
|
|
15425
|
+
* Get webhook
|
|
15426
|
+
* @description Get a webhook for the specified organization.
|
|
15427
|
+
*
|
|
15428
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15429
|
+
*
|
|
15430
|
+
* This endpoint requires the following org token scopes:
|
|
15431
|
+
* - webhooks:list
|
|
15432
|
+
*/
|
|
15433
|
+
getOrgWebhook: {
|
|
15434
|
+
parameters: {
|
|
15435
|
+
path: {
|
|
15436
|
+
/** @description The slug of the organization */
|
|
15437
|
+
org_slug: string
|
|
15438
|
+
/** @description The ID of the webhook */
|
|
15439
|
+
webhook_id: string
|
|
15440
|
+
}
|
|
15441
|
+
}
|
|
15442
|
+
responses: {
|
|
15443
|
+
/** @description Webhook details */
|
|
15444
|
+
200: {
|
|
15445
|
+
content: {
|
|
15446
|
+
'application/json': {
|
|
15447
|
+
/**
|
|
15448
|
+
* @description The ID of the webhook
|
|
15449
|
+
* @default
|
|
15450
|
+
*/
|
|
15451
|
+
id: string
|
|
15452
|
+
/**
|
|
15453
|
+
* @description The creation date of the webhook
|
|
15454
|
+
* @default
|
|
15455
|
+
*/
|
|
15456
|
+
created_at: string
|
|
15457
|
+
/**
|
|
15458
|
+
* @description The last update date of the webhook
|
|
15459
|
+
* @default
|
|
15460
|
+
*/
|
|
15461
|
+
updated_at: string
|
|
15462
|
+
/**
|
|
15463
|
+
* @description The name of the webhook
|
|
15464
|
+
* @default
|
|
15465
|
+
*/
|
|
15466
|
+
name: string
|
|
15467
|
+
/**
|
|
15468
|
+
* @description The description of the webhook
|
|
15469
|
+
* @default
|
|
15470
|
+
*/
|
|
15471
|
+
description: string | null
|
|
15472
|
+
/**
|
|
15473
|
+
* @description The URL where webhook events will be sent
|
|
15474
|
+
* @default
|
|
15475
|
+
*/
|
|
15476
|
+
url: string
|
|
15477
|
+
/**
|
|
15478
|
+
* @description The signing key used to sign webhook payloads
|
|
15479
|
+
* @default
|
|
15480
|
+
*/
|
|
15481
|
+
secret: string | null
|
|
15482
|
+
/** @description Array of event names */
|
|
15483
|
+
events: string[]
|
|
15484
|
+
/**
|
|
15485
|
+
* @description Custom headers to include in webhook requests
|
|
15486
|
+
* @default null
|
|
15487
|
+
*/
|
|
15488
|
+
headers: Record<string, unknown> | null
|
|
15489
|
+
filters: {
|
|
15490
|
+
/** @description Array of repository IDs */
|
|
15491
|
+
repositoryIds: string[] | null
|
|
15492
|
+
} | null
|
|
15493
|
+
}
|
|
15494
|
+
}
|
|
15495
|
+
}
|
|
15496
|
+
400: components['responses']['SocketBadRequest']
|
|
15497
|
+
401: components['responses']['SocketUnauthorized']
|
|
15498
|
+
403: components['responses']['SocketForbidden']
|
|
15499
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15500
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15501
|
+
}
|
|
15502
|
+
}
|
|
15503
|
+
/**
|
|
15504
|
+
* Update webhook
|
|
15505
|
+
* @description Update details of an existing webhook.
|
|
15506
|
+
*
|
|
15507
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15508
|
+
*
|
|
15509
|
+
* This endpoint requires the following org token scopes:
|
|
15510
|
+
* - webhooks:update
|
|
15511
|
+
*/
|
|
15512
|
+
updateOrgWebhook: {
|
|
15513
|
+
parameters: {
|
|
15514
|
+
path: {
|
|
15515
|
+
/** @description The slug of the organization */
|
|
15516
|
+
org_slug: string
|
|
15517
|
+
/** @description The ID of the webhook */
|
|
15518
|
+
webhook_id: string
|
|
15519
|
+
}
|
|
15520
|
+
}
|
|
15521
|
+
requestBody?: {
|
|
15522
|
+
content: {
|
|
15523
|
+
'application/json': {
|
|
15524
|
+
/**
|
|
15525
|
+
* @description The name of the webhook
|
|
15526
|
+
* @default
|
|
15527
|
+
*/
|
|
15528
|
+
name?: string
|
|
15529
|
+
/**
|
|
15530
|
+
* @description The description of the webhook
|
|
15531
|
+
* @default
|
|
15532
|
+
*/
|
|
15533
|
+
description?: string | null
|
|
15534
|
+
/**
|
|
15535
|
+
* @description The URL where webhook events will be sent
|
|
15536
|
+
* @default
|
|
15537
|
+
*/
|
|
15538
|
+
url?: string
|
|
15539
|
+
/**
|
|
15540
|
+
* @description The signing key used to sign webhook payloads
|
|
15541
|
+
* @default
|
|
15542
|
+
*/
|
|
15543
|
+
secret?: string | null
|
|
15544
|
+
/** @description Array of event names */
|
|
15545
|
+
events?: string[]
|
|
15546
|
+
/**
|
|
15547
|
+
* @description Custom headers to include in webhook requests
|
|
15548
|
+
* @default null
|
|
15549
|
+
*/
|
|
15550
|
+
headers?: Record<string, unknown> | null
|
|
15551
|
+
filters?: {
|
|
15552
|
+
/** @description Array of repository IDs */
|
|
15553
|
+
repositoryIds: string[] | null
|
|
15554
|
+
} | null
|
|
15555
|
+
}
|
|
15556
|
+
}
|
|
15557
|
+
}
|
|
15558
|
+
responses: {
|
|
15559
|
+
/** @description Updated webhook details */
|
|
15560
|
+
200: {
|
|
15561
|
+
content: {
|
|
15562
|
+
'application/json': {
|
|
15563
|
+
/**
|
|
15564
|
+
* @description The ID of the webhook
|
|
15565
|
+
* @default
|
|
15566
|
+
*/
|
|
15567
|
+
id: string
|
|
15568
|
+
/**
|
|
15569
|
+
* @description The creation date of the webhook
|
|
15570
|
+
* @default
|
|
15571
|
+
*/
|
|
15572
|
+
created_at: string
|
|
15573
|
+
/**
|
|
15574
|
+
* @description The last update date of the webhook
|
|
15575
|
+
* @default
|
|
15576
|
+
*/
|
|
15577
|
+
updated_at: string
|
|
15578
|
+
/**
|
|
15579
|
+
* @description The name of the webhook
|
|
15580
|
+
* @default
|
|
15581
|
+
*/
|
|
15582
|
+
name: string
|
|
15583
|
+
/**
|
|
15584
|
+
* @description The description of the webhook
|
|
15585
|
+
* @default
|
|
15586
|
+
*/
|
|
15587
|
+
description: string | null
|
|
15588
|
+
/**
|
|
15589
|
+
* @description The URL where webhook events will be sent
|
|
15590
|
+
* @default
|
|
15591
|
+
*/
|
|
15592
|
+
url: string
|
|
15593
|
+
/**
|
|
15594
|
+
* @description The signing key used to sign webhook payloads
|
|
15595
|
+
* @default
|
|
15596
|
+
*/
|
|
15597
|
+
secret: string | null
|
|
15598
|
+
/** @description Array of event names */
|
|
15599
|
+
events: string[]
|
|
15600
|
+
/**
|
|
15601
|
+
* @description Custom headers to include in webhook requests
|
|
15602
|
+
* @default null
|
|
15603
|
+
*/
|
|
15604
|
+
headers: Record<string, unknown> | null
|
|
15605
|
+
filters: {
|
|
15606
|
+
/** @description Array of repository IDs */
|
|
15607
|
+
repositoryIds: string[] | null
|
|
15608
|
+
} | null
|
|
15609
|
+
}
|
|
15610
|
+
}
|
|
15611
|
+
}
|
|
15612
|
+
400: components['responses']['SocketBadRequest']
|
|
15613
|
+
401: components['responses']['SocketUnauthorized']
|
|
15614
|
+
403: components['responses']['SocketForbidden']
|
|
15615
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15616
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15617
|
+
}
|
|
15618
|
+
}
|
|
15619
|
+
/**
|
|
15620
|
+
* Delete webhook
|
|
15621
|
+
* @description Delete a webhook. This will stop all future webhook deliveries to the webhook URL.
|
|
15622
|
+
*
|
|
15623
|
+
* This endpoint consumes 1 unit of your quota.
|
|
15624
|
+
*
|
|
15625
|
+
* This endpoint requires the following org token scopes:
|
|
15626
|
+
* - webhooks:delete
|
|
15627
|
+
*/
|
|
15628
|
+
deleteOrgWebhook: {
|
|
15629
|
+
parameters: {
|
|
15630
|
+
path: {
|
|
15631
|
+
/** @description The slug of the organization */
|
|
15632
|
+
org_slug: string
|
|
15633
|
+
/** @description The ID of the webhook */
|
|
15634
|
+
webhook_id: string
|
|
15635
|
+
}
|
|
15636
|
+
}
|
|
15637
|
+
responses: {
|
|
15638
|
+
/** @description Success */
|
|
15639
|
+
200: {
|
|
15640
|
+
content: {
|
|
15641
|
+
'application/json': {
|
|
15642
|
+
/** @default ok */
|
|
15643
|
+
status: string
|
|
15644
|
+
}
|
|
15645
|
+
}
|
|
15646
|
+
}
|
|
15647
|
+
400: components['responses']['SocketBadRequest']
|
|
15648
|
+
401: components['responses']['SocketUnauthorized']
|
|
15649
|
+
403: components['responses']['SocketForbidden']
|
|
15650
|
+
404: components['responses']['SocketNotFoundResponse']
|
|
15651
|
+
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15652
|
+
}
|
|
15653
|
+
}
|
|
15654
|
+
/**
|
|
15655
|
+
* List latest alerts (Beta)
|
|
15656
|
+
* @description List latest alerts.
|
|
14073
15657
|
*
|
|
14074
|
-
* This endpoint consumes
|
|
15658
|
+
* This endpoint consumes 10 units of your quota.
|
|
14075
15659
|
*
|
|
14076
15660
|
* This endpoint requires the following org token scopes:
|
|
14077
|
-
* -
|
|
15661
|
+
* - alerts:list
|
|
14078
15662
|
*/
|
|
14079
|
-
|
|
15663
|
+
alertsList: {
|
|
14080
15664
|
parameters: {
|
|
14081
15665
|
query?: {
|
|
14082
|
-
/** @description
|
|
15666
|
+
/** @description Specify the maximum number of results 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) */
|
|
14083
15667
|
per_page?: number
|
|
14084
|
-
/** @description
|
|
14085
|
-
|
|
14086
|
-
/** @description
|
|
14087
|
-
|
|
14088
|
-
/** @description
|
|
14089
|
-
|
|
14090
|
-
/** @description
|
|
14091
|
-
|
|
14092
|
-
/** @description
|
|
14093
|
-
|
|
14094
|
-
/** @description
|
|
14095
|
-
|
|
14096
|
-
|
|
14097
|
-
|
|
14098
|
-
|
|
14099
|
-
|
|
14100
|
-
|
|
14101
|
-
|
|
14102
|
-
|
|
14103
|
-
|
|
14104
|
-
|
|
14105
|
-
|
|
14106
|
-
|
|
14107
|
-
|
|
14108
|
-
|
|
14109
|
-
|
|
14110
|
-
|
|
14111
|
-
|
|
14112
|
-
|
|
14113
|
-
|
|
14114
|
-
|
|
14115
|
-
|
|
14116
|
-
|
|
14117
|
-
|
|
14118
|
-
|
|
14119
|
-
|
|
14120
|
-
|
|
14121
|
-
|
|
14122
|
-
|
|
14123
|
-
|
|
14124
|
-
|
|
14125
|
-
|
|
14126
|
-
|
|
14127
|
-
|
|
15668
|
+
/** @description The pagination cursor that was returned as the "endCursor" property in previous request */
|
|
15669
|
+
startAfterCursor?: string
|
|
15670
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
15671
|
+
'filters.alertAction'?: string
|
|
15672
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
15673
|
+
'filters.alertAction.notIn'?: string
|
|
15674
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
|
|
15675
|
+
'filters.alertCategory'?: string
|
|
15676
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
|
|
15677
|
+
'filters.alertCategory.notIn'?: string
|
|
15678
|
+
/** @description CVE ID */
|
|
15679
|
+
'filters.alertCveId'?: string
|
|
15680
|
+
/** @description CVE ID */
|
|
15681
|
+
'filters.alertCveId.notIn'?: string
|
|
15682
|
+
/** @description CVE title */
|
|
15683
|
+
'filters.alertCveTitle'?: string
|
|
15684
|
+
/** @description CVE title */
|
|
15685
|
+
'filters.alertCveTitle.notIn'?: string
|
|
15686
|
+
/** @description CWE ID */
|
|
15687
|
+
'filters.alertCweId'?: string
|
|
15688
|
+
/** @description CWE ID */
|
|
15689
|
+
'filters.alertCweId.notIn'?: string
|
|
15690
|
+
/** @description CWE name */
|
|
15691
|
+
'filters.alertCweName'?: string
|
|
15692
|
+
/** @description CWE name */
|
|
15693
|
+
'filters.alertCweName.notIn'?: string
|
|
15694
|
+
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
15695
|
+
'filters.alertEPSS'?: string
|
|
15696
|
+
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
15697
|
+
'filters.alertEPSS.notIn'?: string
|
|
15698
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
15699
|
+
'filters.alertFixType'?: string
|
|
15700
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
15701
|
+
'filters.alertFixType.notIn'?: string
|
|
15702
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
15703
|
+
'filters.alertKEV'?: boolean
|
|
15704
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
15705
|
+
'filters.alertKEV.notIn'?: boolean
|
|
15706
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
15707
|
+
'filters.alertPriority'?: string
|
|
15708
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
15709
|
+
'filters.alertPriority.notIn'?: string
|
|
15710
|
+
/** @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
|
+
'filters.alertReachabilityType'?: string
|
|
15712
|
+
/** @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 */
|
|
15713
|
+
'filters.alertReachabilityType.notIn'?: string
|
|
15714
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
15715
|
+
'filters.alertSeverity'?: string
|
|
15716
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
15717
|
+
'filters.alertSeverity.notIn'?: string
|
|
15718
|
+
/** @description A single alert status ("open" or "cleared") */
|
|
15719
|
+
'filters.alertStatus'?: string
|
|
15720
|
+
/** @description A single alert status ("open" or "cleared") */
|
|
15721
|
+
'filters.alertStatus.notIn'?: string
|
|
15722
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
15723
|
+
'filters.alertType'?: string
|
|
15724
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
15725
|
+
'filters.alertType.notIn'?: string
|
|
15726
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15727
|
+
'filters.alertUpdatedAt.eq'?: string
|
|
15728
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15729
|
+
'filters.alertUpdatedAt.lt'?: string
|
|
15730
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15731
|
+
'filters.alertUpdatedAt.lte'?: string
|
|
15732
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15733
|
+
'filters.alertUpdatedAt.gt'?: string
|
|
15734
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15735
|
+
'filters.alertUpdatedAt.gte'?: string
|
|
15736
|
+
/** @description Comma-separated list of repo full names that should be included */
|
|
15737
|
+
'filters.repoFullName'?: string
|
|
15738
|
+
/** @description Comma-separated list of repo full names that should be excluded */
|
|
15739
|
+
'filters.repoFullName.notIn'?: string
|
|
15740
|
+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
15741
|
+
'filters.repoLabels'?: string
|
|
15742
|
+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
15743
|
+
'filters.repoLabels.notIn'?: string
|
|
15744
|
+
/** @description Comma-separated list of repo slugs that should be included */
|
|
15745
|
+
'filters.repoSlug'?: string
|
|
15746
|
+
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
15747
|
+
'filters.repoSlug.notIn'?: string
|
|
14128
15748
|
}
|
|
14129
15749
|
path: {
|
|
14130
15750
|
/** @description The slug of the organization */
|
|
@@ -14132,44 +15752,247 @@ export interface operations {
|
|
|
14132
15752
|
}
|
|
14133
15753
|
}
|
|
14134
15754
|
responses: {
|
|
14135
|
-
/** @description The paginated
|
|
15755
|
+
/** @description The paginated array of API tokens for the organization, and related metadata. */
|
|
14136
15756
|
200: {
|
|
14137
15757
|
content: {
|
|
14138
15758
|
'application/json': {
|
|
14139
|
-
|
|
15759
|
+
/** @default */
|
|
15760
|
+
endCursor: string | null
|
|
15761
|
+
items: Array<{
|
|
14140
15762
|
/** @default */
|
|
14141
|
-
|
|
15763
|
+
key: string
|
|
14142
15764
|
/** @default */
|
|
14143
|
-
|
|
15765
|
+
type: string
|
|
14144
15766
|
/** @default */
|
|
14145
|
-
|
|
14146
|
-
|
|
14147
|
-
|
|
15767
|
+
category: string
|
|
15768
|
+
fix: {
|
|
15769
|
+
/** @default */
|
|
15770
|
+
type: string
|
|
15771
|
+
/** @default */
|
|
15772
|
+
description: string | null
|
|
15773
|
+
} | null
|
|
15774
|
+
vulnerability: {
|
|
15775
|
+
/** @default */
|
|
15776
|
+
cveId: string | null
|
|
15777
|
+
/** @default */
|
|
15778
|
+
cveTitle: string | null
|
|
15779
|
+
/** @default */
|
|
15780
|
+
cveDescription: string | null
|
|
15781
|
+
/** @default 0 */
|
|
15782
|
+
cvssScore: number
|
|
15783
|
+
cweIds: string[] | null
|
|
15784
|
+
cweNames: string[] | null
|
|
15785
|
+
ghsaIds: string[] | null
|
|
15786
|
+
/** @default 0 */
|
|
15787
|
+
epssScore: number
|
|
15788
|
+
/** @default 0 */
|
|
15789
|
+
epssPercentile: number
|
|
15790
|
+
/** @default false */
|
|
15791
|
+
isKev: boolean
|
|
15792
|
+
} | null
|
|
14148
15793
|
/** @default */
|
|
14149
|
-
|
|
15794
|
+
id: string
|
|
15795
|
+
/** @default 0 */
|
|
15796
|
+
version: number
|
|
15797
|
+
/**
|
|
15798
|
+
* @default open
|
|
15799
|
+
* @enum {string}
|
|
15800
|
+
*/
|
|
15801
|
+
status: 'open' | 'cleared'
|
|
14150
15802
|
/** @default */
|
|
14151
|
-
|
|
15803
|
+
createdAt: string
|
|
14152
15804
|
/** @default */
|
|
14153
|
-
|
|
15805
|
+
updatedAt: string
|
|
14154
15806
|
/** @default */
|
|
14155
|
-
|
|
15807
|
+
clearedAt: string | null
|
|
14156
15808
|
/** @default */
|
|
14157
|
-
|
|
15809
|
+
dashboardUrl: string
|
|
14158
15810
|
/**
|
|
14159
|
-
* @
|
|
14160
|
-
* @
|
|
15811
|
+
* @default low
|
|
15812
|
+
* @enum {string}
|
|
14161
15813
|
*/
|
|
14162
|
-
|
|
15814
|
+
severity: 'low' | 'medium' | 'high' | 'critical'
|
|
15815
|
+
locations: {
|
|
15816
|
+
/** @default */
|
|
15817
|
+
action: string
|
|
15818
|
+
/** @default */
|
|
15819
|
+
actionSourceType: string
|
|
15820
|
+
reachability: {
|
|
15821
|
+
/** @default */
|
|
15822
|
+
type: string
|
|
15823
|
+
/** @default */
|
|
15824
|
+
analysisType: string | null
|
|
15825
|
+
}
|
|
15826
|
+
licenseViolation: {
|
|
15827
|
+
violationData: {
|
|
15828
|
+
/** @default */
|
|
15829
|
+
purl: string | null
|
|
15830
|
+
/** @default */
|
|
15831
|
+
spdxAtomOrExtraData: string
|
|
15832
|
+
}[]
|
|
15833
|
+
} | null
|
|
15834
|
+
prioritization: {
|
|
15835
|
+
/** @default 0 */
|
|
15836
|
+
overallScore: number
|
|
15837
|
+
/** @default 0 */
|
|
15838
|
+
fixableScore: number
|
|
15839
|
+
/** @default 0 */
|
|
15840
|
+
reachableScore: number
|
|
15841
|
+
/** @default 0 */
|
|
15842
|
+
severityScore: number
|
|
15843
|
+
}
|
|
15844
|
+
repository: {
|
|
15845
|
+
/** @default */
|
|
15846
|
+
fullName: string | null
|
|
15847
|
+
/** @default */
|
|
15848
|
+
id: string | null
|
|
15849
|
+
/** @default */
|
|
15850
|
+
slug: string | null
|
|
15851
|
+
/** @default */
|
|
15852
|
+
workspace: string | null
|
|
15853
|
+
labels: string[]
|
|
15854
|
+
labelIds: string[]
|
|
15855
|
+
} | null
|
|
15856
|
+
branch: {
|
|
15857
|
+
/** @default */
|
|
15858
|
+
name: string
|
|
15859
|
+
/** @default */
|
|
15860
|
+
type: string | null
|
|
15861
|
+
} | null
|
|
15862
|
+
patch: {
|
|
15863
|
+
/** @default */
|
|
15864
|
+
uuid: string | null
|
|
15865
|
+
/**
|
|
15866
|
+
* @default patch_unavailable
|
|
15867
|
+
* @enum {string}
|
|
15868
|
+
*/
|
|
15869
|
+
status:
|
|
15870
|
+
| 'patch_unavailable'
|
|
15871
|
+
| 'patch_available'
|
|
15872
|
+
| 'patch_applied'
|
|
15873
|
+
/** @default false */
|
|
15874
|
+
deprecated: boolean
|
|
15875
|
+
}
|
|
15876
|
+
dependency: {
|
|
15877
|
+
/** @default false */
|
|
15878
|
+
direct: boolean
|
|
15879
|
+
/** @default false */
|
|
15880
|
+
dev: boolean
|
|
15881
|
+
/** @default false */
|
|
15882
|
+
dead: boolean
|
|
15883
|
+
manifestFiles: components['schemas']['SocketManifestReference'][]
|
|
15884
|
+
}
|
|
15885
|
+
artifact: {
|
|
15886
|
+
/** @default */
|
|
15887
|
+
type: string
|
|
15888
|
+
/** @default */
|
|
15889
|
+
namespace: string | null
|
|
15890
|
+
/** @default */
|
|
15891
|
+
name: string
|
|
15892
|
+
/** @default */
|
|
15893
|
+
id: string
|
|
15894
|
+
/** @default */
|
|
15895
|
+
version: string
|
|
15896
|
+
/** @default */
|
|
15897
|
+
author: string | null
|
|
15898
|
+
/** @default */
|
|
15899
|
+
license: string | null
|
|
15900
|
+
scores: components['schemas']['SocketScore']
|
|
15901
|
+
/** @default */
|
|
15902
|
+
artifactId: string | null
|
|
15903
|
+
}
|
|
15904
|
+
}[]
|
|
14163
15905
|
}>
|
|
14164
|
-
|
|
14165
|
-
|
|
15906
|
+
meta: {
|
|
15907
|
+
/** @default */
|
|
15908
|
+
organizationId: string
|
|
15909
|
+
/** @default 0 */
|
|
15910
|
+
queryStartTimestamp: number
|
|
15911
|
+
filters: {
|
|
15912
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
|
|
15913
|
+
alertAction?: string[]
|
|
15914
|
+
/** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
|
|
15915
|
+
'alertAction.notIn'?: string[]
|
|
15916
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included */
|
|
15917
|
+
alertCategory?: string[]
|
|
15918
|
+
/** @description Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded */
|
|
15919
|
+
'alertCategory.notIn'?: string[]
|
|
15920
|
+
/** @description CVE ID */
|
|
15921
|
+
alertCveId?: string[]
|
|
15922
|
+
/** @description CVE ID */
|
|
15923
|
+
'alertCveId.notIn'?: string[]
|
|
15924
|
+
/** @description CVE title */
|
|
15925
|
+
alertCveTitle?: string[]
|
|
15926
|
+
/** @description CVE title */
|
|
15927
|
+
'alertCveTitle.notIn'?: string[]
|
|
15928
|
+
/** @description CWE ID */
|
|
15929
|
+
alertCweId?: string[]
|
|
15930
|
+
/** @description CWE ID */
|
|
15931
|
+
'alertCweId.notIn'?: string[]
|
|
15932
|
+
/** @description CWE name */
|
|
15933
|
+
alertCweName?: string[]
|
|
15934
|
+
/** @description CWE name */
|
|
15935
|
+
'alertCweName.notIn'?: string[]
|
|
15936
|
+
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
15937
|
+
alertEPSS?: string[]
|
|
15938
|
+
/** @description Alert EPSS ("low", "medium", "high", "critical") */
|
|
15939
|
+
'alertEPSS.notIn'?: string[]
|
|
15940
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included */
|
|
15941
|
+
alertFixType?: string[]
|
|
15942
|
+
/** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
|
|
15943
|
+
'alertFixType.notIn'?: string[]
|
|
15944
|
+
/** @description Alert KEV (Known Exploited Vulnerability) filter flag */
|
|
15945
|
+
alertKEV?: boolean[]
|
|
15946
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
15947
|
+
alertPriority?: string[]
|
|
15948
|
+
/** @description Alert priority ("low", "medium", "high", or "critical") */
|
|
15949
|
+
'alertPriority.notIn'?: string[]
|
|
15950
|
+
/** @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
|
+
alertReachabilityType?: string[]
|
|
15952
|
+
/** @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 */
|
|
15953
|
+
'alertReachabilityType.notIn'?: string[]
|
|
15954
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included */
|
|
15955
|
+
alertSeverity?: string[]
|
|
15956
|
+
/** @description Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded */
|
|
15957
|
+
'alertSeverity.notIn'?: string[]
|
|
15958
|
+
/** @description A single alert status ("open" or "cleared") */
|
|
15959
|
+
alertStatus?: string[]
|
|
15960
|
+
/** @description A single alert status ("open" or "cleared") */
|
|
15961
|
+
'alertStatus.notIn'?: string[]
|
|
15962
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included */
|
|
15963
|
+
alertType?: string[]
|
|
15964
|
+
/** @description Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded */
|
|
15965
|
+
'alertType.notIn'?: string[]
|
|
15966
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15967
|
+
'alertUpdatedAt.eq'?: string[]
|
|
15968
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15969
|
+
'alertUpdatedAt.lt'?: string[]
|
|
15970
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15971
|
+
'alertUpdatedAt.lte'?: string[]
|
|
15972
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15973
|
+
'alertUpdatedAt.gt'?: string[]
|
|
15974
|
+
/** @description Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone) */
|
|
15975
|
+
'alertUpdatedAt.gte'?: string[]
|
|
15976
|
+
/** @description Comma-separated list of repo full names that should be included */
|
|
15977
|
+
repoFullName?: string[]
|
|
15978
|
+
/** @description Comma-separated list of repo full names that should be excluded */
|
|
15979
|
+
'repoFullName.notIn'?: string[]
|
|
15980
|
+
/** @description Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels. */
|
|
15981
|
+
repoLabels?: string[]
|
|
15982
|
+
/** @description Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels. */
|
|
15983
|
+
'repoLabels.notIn'?: string[]
|
|
15984
|
+
/** @description Comma-separated list of repo slugs that should be included */
|
|
15985
|
+
repoSlug?: string[]
|
|
15986
|
+
/** @description Comma-separated list of repo slugs that should be excluded */
|
|
15987
|
+
'repoSlug.notIn'?: string[]
|
|
15988
|
+
}
|
|
15989
|
+
}
|
|
14166
15990
|
}
|
|
14167
15991
|
}
|
|
14168
15992
|
}
|
|
14169
15993
|
400: components['responses']['SocketBadRequest']
|
|
14170
15994
|
401: components['responses']['SocketUnauthorized']
|
|
14171
15995
|
403: components['responses']['SocketForbidden']
|
|
14172
|
-
404: components['responses']['SocketNotFoundResponse']
|
|
14173
15996
|
429: components['responses']['SocketTooManyRequestsResponse']
|
|
14174
15997
|
}
|
|
14175
15998
|
}
|
|
@@ -15277,8 +17100,7 @@ export interface operations {
|
|
|
15277
17100
|
404: components['responses']['SocketNotFoundResponse']
|
|
15278
17101
|
429: components['responses']['SocketTooManyRequestsResponse']
|
|
15279
17102
|
}
|
|
15280
|
-
}
|
|
15281
|
-
// SDK v3 method name aliases for TypeScript compatibility.
|
|
17103
|
+
} // SDK v3 method name aliases for TypeScript compatibility.
|
|
15282
17104
|
// These map the new SDK method names to their underlying OpenAPI operation names.
|
|
15283
17105
|
listOrganizations: operations['getOrganizations']
|
|
15284
17106
|
listRepositories: operations['getOrgRepoList']
|