@censys/platform-sdk 0.4.3 → 0.5.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.
Files changed (177) hide show
  1. package/FUNCTIONS.md +0 -1
  2. package/README.md +17 -2
  3. package/docs/sdks/collections/README.md +12 -6
  4. package/docs/sdks/globaldata/README.md +347 -6
  5. package/docs/sdks/threathunting/README.md +248 -0
  6. package/examples/globalDataSearch.example.ts +0 -1
  7. package/examples/package-lock.json +5 -6
  8. package/funcs/globalDataCreateTrackedScan.d.ts +18 -0
  9. package/funcs/globalDataCreateTrackedScan.d.ts.map +1 -0
  10. package/funcs/globalDataCreateTrackedScan.js +132 -0
  11. package/funcs/globalDataCreateTrackedScan.js.map +1 -0
  12. package/funcs/globalDataGetHostObservationsWithCertificate.d.ts +18 -0
  13. package/funcs/globalDataGetHostObservationsWithCertificate.d.ts.map +1 -0
  14. package/funcs/globalDataGetHostObservationsWithCertificate.js +141 -0
  15. package/funcs/globalDataGetHostObservationsWithCertificate.js.map +1 -0
  16. package/funcs/globalDataGetTrackedScan.d.ts +19 -0
  17. package/funcs/globalDataGetTrackedScan.d.ts.map +1 -0
  18. package/funcs/globalDataGetTrackedScan.js +137 -0
  19. package/funcs/globalDataGetTrackedScan.js.map +1 -0
  20. package/funcs/globalDataGetTrackedScanThreatHunting.d.ts +19 -0
  21. package/funcs/globalDataGetTrackedScanThreatHunting.d.ts.map +1 -0
  22. package/funcs/globalDataGetTrackedScanThreatHunting.js +137 -0
  23. package/funcs/globalDataGetTrackedScanThreatHunting.js.map +1 -0
  24. package/funcs/threatHuntingCreateTrackedScan.d.ts +18 -0
  25. package/funcs/threatHuntingCreateTrackedScan.d.ts.map +1 -0
  26. package/funcs/threatHuntingCreateTrackedScan.js +129 -0
  27. package/funcs/threatHuntingCreateTrackedScan.js.map +1 -0
  28. package/jsr.json +1 -1
  29. package/lib/config.d.ts +4 -4
  30. package/lib/config.js +4 -4
  31. package/models/components/elasticsearch.d.ts +3 -0
  32. package/models/components/elasticsearch.d.ts.map +1 -1
  33. package/models/components/elasticsearch.js +5 -0
  34. package/models/components/elasticsearch.js.map +1 -1
  35. package/models/components/elasticsearcherrormessage.d.ts +33 -0
  36. package/models/components/elasticsearcherrormessage.d.ts.map +1 -0
  37. package/models/components/elasticsearcherrormessage.js +73 -0
  38. package/models/components/elasticsearcherrormessage.js.map +1 -0
  39. package/models/components/hostobservationrange.d.ts +39 -0
  40. package/models/components/hostobservationrange.d.ts.map +1 -0
  41. package/models/components/hostobservationrange.js +92 -0
  42. package/models/components/hostobservationrange.js.map +1 -0
  43. package/models/components/hostobservationresponse.d.ts +34 -0
  44. package/models/components/hostobservationresponse.d.ts.map +1 -0
  45. package/models/components/hostobservationresponse.js +85 -0
  46. package/models/components/hostobservationresponse.js.map +1 -0
  47. package/models/components/httpfavicon.d.ts +5 -0
  48. package/models/components/httpfavicon.d.ts.map +1 -1
  49. package/models/components/httpfavicon.js +4 -0
  50. package/models/components/httpfavicon.js.map +1 -1
  51. package/models/components/index.d.ts +14 -0
  52. package/models/components/index.d.ts.map +1 -1
  53. package/models/components/index.js +14 -0
  54. package/models/components/index.js.map +1 -1
  55. package/models/components/responseenvelopehostobservationresponse.d.ts +30 -0
  56. package/models/components/responseenvelopehostobservationresponse.d.ts.map +1 -0
  57. package/models/components/responseenvelopehostobservationresponse.js +70 -0
  58. package/models/components/responseenvelopehostobservationresponse.js.map +1 -0
  59. package/models/components/responseenvelopetrackedscan.d.ts +30 -0
  60. package/models/components/responseenvelopetrackedscan.d.ts.map +1 -0
  61. package/models/components/responseenvelopetrackedscan.js +70 -0
  62. package/models/components/responseenvelopetrackedscan.js.map +1 -0
  63. package/models/components/scansdiscoveryinputbody.d.ts +172 -0
  64. package/models/components/scansdiscoveryinputbody.d.ts.map +1 -0
  65. package/models/components/scansdiscoveryinputbody.js +233 -0
  66. package/models/components/scansdiscoveryinputbody.js.map +1 -0
  67. package/models/components/scansrescaninputbody.d.ts +214 -0
  68. package/models/components/scansrescaninputbody.d.ts.map +1 -0
  69. package/models/components/scansrescaninputbody.js +268 -0
  70. package/models/components/scansrescaninputbody.js.map +1 -0
  71. package/models/components/screenshot.d.ts +2 -0
  72. package/models/components/screenshot.d.ts.map +1 -1
  73. package/models/components/screenshot.js +11 -0
  74. package/models/components/screenshot.js.map +1 -1
  75. package/models/components/searchaggregateinputbody.d.ts +5 -0
  76. package/models/components/searchaggregateinputbody.d.ts.map +1 -1
  77. package/models/components/searchaggregateinputbody.js +4 -0
  78. package/models/components/searchaggregateinputbody.js.map +1 -1
  79. package/models/components/searchvaluecountsinputbody.d.ts +5 -0
  80. package/models/components/searchvaluecountsinputbody.d.ts.map +1 -1
  81. package/models/components/searchvaluecountsinputbody.js +2 -0
  82. package/models/components/searchvaluecountsinputbody.js.map +1 -1
  83. package/models/components/serviceid.d.ts +70 -0
  84. package/models/components/serviceid.d.ts.map +1 -0
  85. package/models/components/serviceid.js +106 -0
  86. package/models/components/serviceid.js.map +1 -0
  87. package/models/components/trackedscan.d.ts +39 -0
  88. package/models/components/trackedscan.d.ts.map +1 -0
  89. package/models/components/trackedscan.js +90 -0
  90. package/models/components/trackedscan.js.map +1 -0
  91. package/models/components/trackedscanscantarget.d.ts +39 -0
  92. package/models/components/trackedscanscantarget.d.ts.map +1 -0
  93. package/models/components/trackedscanscantarget.js +94 -0
  94. package/models/components/trackedscanscantarget.js.map +1 -0
  95. package/models/components/trackedscanscantargethostnameport.d.ts +31 -0
  96. package/models/components/trackedscanscantargethostnameport.d.ts.map +1 -0
  97. package/models/components/trackedscanscantargethostnameport.js +71 -0
  98. package/models/components/trackedscanscantargethostnameport.js.map +1 -0
  99. package/models/components/trackedscanscantargethostport.d.ts +31 -0
  100. package/models/components/trackedscanscantargethostport.d.ts.map +1 -0
  101. package/models/components/trackedscanscantargethostport.js +71 -0
  102. package/models/components/trackedscanscantargethostport.js.map +1 -0
  103. package/models/components/trackedscantask.d.ts +74 -0
  104. package/models/components/trackedscantask.d.ts.map +1 -0
  105. package/models/components/trackedscantask.js +106 -0
  106. package/models/components/trackedscantask.js.map +1 -0
  107. package/models/components/weborigin.d.ts +31 -0
  108. package/models/components/weborigin.d.ts.map +1 -0
  109. package/models/components/weborigin.js +71 -0
  110. package/models/components/weborigin.js.map +1 -0
  111. package/models/operations/index.d.ts +5 -0
  112. package/models/operations/index.d.ts.map +1 -1
  113. package/models/operations/index.js +5 -0
  114. package/models/operations/index.js.map +1 -1
  115. package/models/operations/v3globaldatagethostobservationswithcertificate.d.ts +124 -0
  116. package/models/operations/v3globaldatagethostobservationswithcertificate.d.ts.map +1 -0
  117. package/models/operations/v3globaldatagethostobservationswithcertificate.js +178 -0
  118. package/models/operations/v3globaldatagethostobservationswithcertificate.js.map +1 -0
  119. package/models/operations/v3globaldatascansget.d.ts +94 -0
  120. package/models/operations/v3globaldatascansget.d.ts.map +1 -0
  121. package/models/operations/v3globaldatascansget.js +157 -0
  122. package/models/operations/v3globaldatascansget.js.map +1 -0
  123. package/models/operations/v3globaldatascansrescan.d.ts +91 -0
  124. package/models/operations/v3globaldatascansrescan.d.ts.map +1 -0
  125. package/models/operations/v3globaldatascansrescan.js +157 -0
  126. package/models/operations/v3globaldatascansrescan.js.map +1 -0
  127. package/models/operations/v3threathuntingscansdiscovery.d.ts +91 -0
  128. package/models/operations/v3threathuntingscansdiscovery.d.ts.map +1 -0
  129. package/models/operations/v3threathuntingscansdiscovery.js +157 -0
  130. package/models/operations/v3threathuntingscansdiscovery.js.map +1 -0
  131. package/models/operations/v3threathuntingscansget.d.ts +94 -0
  132. package/models/operations/v3threathuntingscansget.d.ts.map +1 -0
  133. package/models/operations/v3threathuntingscansget.js +157 -0
  134. package/models/operations/v3threathuntingscansget.js.map +1 -0
  135. package/package.json +4 -5
  136. package/sdk/globaldata.d.ts +30 -0
  137. package/sdk/globaldata.d.ts.map +1 -1
  138. package/sdk/globaldata.js +42 -0
  139. package/sdk/globaldata.js.map +1 -1
  140. package/sdk/threathunting.d.ts +23 -0
  141. package/sdk/threathunting.d.ts.map +1 -1
  142. package/sdk/threathunting.js +32 -0
  143. package/sdk/threathunting.js.map +1 -1
  144. package/src/funcs/globalDataCreateTrackedScan.ts +185 -0
  145. package/src/funcs/globalDataGetHostObservationsWithCertificate.ts +201 -0
  146. package/src/funcs/globalDataGetTrackedScan.ts +191 -0
  147. package/src/funcs/globalDataGetTrackedScanThreatHunting.ts +191 -0
  148. package/src/funcs/threatHuntingCreateTrackedScan.ts +188 -0
  149. package/src/lib/config.ts +4 -4
  150. package/src/models/components/elasticsearch.ts +12 -0
  151. package/src/models/components/elasticsearcherrormessage.ts +74 -0
  152. package/src/models/components/hostobservationrange.ts +99 -0
  153. package/src/models/components/hostobservationresponse.ts +91 -0
  154. package/src/models/components/httpfavicon.ts +9 -0
  155. package/src/models/components/index.ts +14 -0
  156. package/src/models/components/responseenvelopehostobservationresponse.ts +83 -0
  157. package/src/models/components/responseenvelopetrackedscan.ts +74 -0
  158. package/src/models/components/scansdiscoveryinputbody.ts +385 -0
  159. package/src/models/components/scansrescaninputbody.ts +428 -0
  160. package/src/models/components/screenshot.ts +13 -0
  161. package/src/models/components/searchaggregateinputbody.ts +9 -0
  162. package/src/models/components/searchvaluecountsinputbody.ts +7 -0
  163. package/src/models/components/serviceid.ts +116 -0
  164. package/src/models/components/trackedscan.ts +101 -0
  165. package/src/models/components/trackedscanscantarget.ts +117 -0
  166. package/src/models/components/trackedscanscantargethostnameport.ts +73 -0
  167. package/src/models/components/trackedscanscantargethostport.ts +72 -0
  168. package/src/models/components/trackedscantask.ts +114 -0
  169. package/src/models/components/weborigin.ts +66 -0
  170. package/src/models/operations/index.ts +5 -0
  171. package/src/models/operations/v3globaldatagethostobservationswithcertificate.ts +317 -0
  172. package/src/models/operations/v3globaldatascansget.ts +232 -0
  173. package/src/models/operations/v3globaldatascansrescan.ts +229 -0
  174. package/src/models/operations/v3threathuntingscansdiscovery.ts +238 -0
  175. package/src/models/operations/v3threathuntingscansget.ts +232 -0
  176. package/src/sdk/globaldata.ts +76 -0
  177. package/src/sdk/threathunting.ts +56 -0
@@ -7,14 +7,262 @@ Endpoints related to the Threat Hunting product
7
7
 
8
8
  ### Available Operations
9
9
 
10
+ * [getTrackedScan](#gettrackedscan) - Get tracked scan details
11
+ * [createTrackedScan](#createtrackedscan) - Create a tracked discovery scan
12
+ * [getTrackedScanThreatHunting](#gettrackedscanthreathunting) - Get tracked scan details
10
13
  * [valueCounts](#valuecounts) - CensEye: Retrieve value counts to discover pivots
11
14
 
15
+ ## getTrackedScan
16
+
17
+ Retrieve the current status and results of a tracked scan by its ID.
18
+ This endpoint works for both discovery scans and rescans.
19
+
20
+ ### Example Usage
21
+
22
+ <!-- UsageSnippet language="typescript" operationID="v3-globaldata-scans-get" method="get" path="/v3/global/scans/{scan_id}" -->
23
+ ```typescript
24
+ import { SDK } from "@censys/platform-sdk";
25
+
26
+ const sdk = new SDK({
27
+ organizationId: "11111111-2222-3333-4444-555555555555",
28
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
29
+ });
30
+
31
+ async function run() {
32
+ const result = await sdk.threatHunting.getTrackedScan({
33
+ scanId: "5f39588f-d4c5-48e5-8894-0bb5918c28fa",
34
+ });
35
+
36
+ console.log(result);
37
+ }
38
+
39
+ run();
40
+ ```
41
+
42
+ ### Standalone function
43
+
44
+ The standalone function version of this method:
45
+
46
+ ```typescript
47
+ import { SDKCore } from "@censys/platform-sdk/core.js";
48
+ import { globalDataGetTrackedScan } from "@censys/platform-sdk/funcs/globalDataGetTrackedScan.js";
49
+
50
+ // Use `SDKCore` for best tree-shaking performance.
51
+ // You can create one instance of it to use across an application.
52
+ const sdk = new SDKCore({
53
+ organizationId: "11111111-2222-3333-4444-555555555555",
54
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
55
+ });
56
+
57
+ async function run() {
58
+ const res = await globalDataGetTrackedScan(sdk, {
59
+ scanId: "5f39588f-d4c5-48e5-8894-0bb5918c28fa",
60
+ });
61
+ if (res.ok) {
62
+ const { value: result } = res;
63
+ console.log(result);
64
+ } else {
65
+ console.log("globalDataGetTrackedScan failed:", res.error);
66
+ }
67
+ }
68
+
69
+ run();
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ | Parameter | Type | Required | Description |
75
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
76
+ | `request` | [operations.V3GlobaldataScansGetRequest](../../models/operations/v3globaldatascansgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
77
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
78
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
79
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
80
+
81
+ ### Response
82
+
83
+ **Promise\<[operations.V3GlobaldataScansGetResponse](../../models/operations/v3globaldatascansgetresponse.md)\>**
84
+
85
+ ### Errors
86
+
87
+ | Error Type | Status Code | Content Type |
88
+ | ------------------------ | ------------------------ | ------------------------ |
89
+ | errors.ErrorModel | 401, 403 | application/problem+json |
90
+ | errors.SDKError | 4XX, 5XX | \*/\* |
91
+
92
+ ## createTrackedScan
93
+
94
+ Create a new tracked discovery scan for a specified target. Discovery scans are used to scan new targets that have not been previously identified. The scan will be queued. The response will contain a scan ID that you can use with the [get tracked scan details endpoint](https://docs.censys.com/reference/v3-globaldata-scans-get#/) to monitor its status and results.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
95
+
96
+ ### Example Usage
97
+
98
+ <!-- UsageSnippet language="typescript" operationID="v3-threathunting-scans-discovery" method="post" path="/v3/threat-hunting/scans/discovery" -->
99
+ ```typescript
100
+ import { SDK } from "@censys/platform-sdk";
101
+
102
+ const sdk = new SDK({
103
+ organizationId: "11111111-2222-3333-4444-555555555555",
104
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
105
+ });
106
+
107
+ async function run() {
108
+ const result = await sdk.threatHunting.createTrackedScan({
109
+ scansDiscoveryInputBody: {
110
+ target: {
111
+ hostnamePort: {
112
+ hostname: "censys.io",
113
+ port: 443,
114
+ },
115
+ },
116
+ },
117
+ });
118
+
119
+ console.log(result);
120
+ }
121
+
122
+ run();
123
+ ```
124
+
125
+ ### Standalone function
126
+
127
+ The standalone function version of this method:
128
+
129
+ ```typescript
130
+ import { SDKCore } from "@censys/platform-sdk/core.js";
131
+ import { threatHuntingCreateTrackedScan } from "@censys/platform-sdk/funcs/threatHuntingCreateTrackedScan.js";
132
+
133
+ // Use `SDKCore` for best tree-shaking performance.
134
+ // You can create one instance of it to use across an application.
135
+ const sdk = new SDKCore({
136
+ organizationId: "11111111-2222-3333-4444-555555555555",
137
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
138
+ });
139
+
140
+ async function run() {
141
+ const res = await threatHuntingCreateTrackedScan(sdk, {
142
+ scansDiscoveryInputBody: {
143
+ target: {
144
+ hostnamePort: {
145
+ hostname: "censys.io",
146
+ port: 443,
147
+ },
148
+ },
149
+ },
150
+ });
151
+ if (res.ok) {
152
+ const { value: result } = res;
153
+ console.log(result);
154
+ } else {
155
+ console.log("threatHuntingCreateTrackedScan failed:", res.error);
156
+ }
157
+ }
158
+
159
+ run();
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ | Parameter | Type | Required | Description |
165
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
+ | `request` | [operations.V3ThreathuntingScansDiscoveryRequest](../../models/operations/v3threathuntingscansdiscoveryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
167
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
169
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
+
171
+ ### Response
172
+
173
+ **Promise\<[operations.V3ThreathuntingScansDiscoveryResponse](../../models/operations/v3threathuntingscansdiscoveryresponse.md)\>**
174
+
175
+ ### Errors
176
+
177
+ | Error Type | Status Code | Content Type |
178
+ | ------------------------ | ------------------------ | ------------------------ |
179
+ | errors.ErrorModel | 401, 403 | application/problem+json |
180
+ | errors.SDKError | 4XX, 5XX | \*/\* |
181
+
182
+ ## getTrackedScanThreatHunting
183
+
184
+ Retrieve the current status and results of a tracked scan by its ID.
185
+ This endpoint works for both discovery scans and rescans.
186
+
187
+ ### Example Usage
188
+
189
+ <!-- UsageSnippet language="typescript" operationID="v3-threathunting-scans-get" method="get" path="/v3/threat-hunting/scans/{scan_id}" -->
190
+ ```typescript
191
+ import { SDK } from "@censys/platform-sdk";
192
+
193
+ const sdk = new SDK({
194
+ organizationId: "11111111-2222-3333-4444-555555555555",
195
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
196
+ });
197
+
198
+ async function run() {
199
+ const result = await sdk.threatHunting.getTrackedScanThreatHunting({
200
+ scanId: "cd62e794-9f12-4c2f-b5b3-153853aaf8d9",
201
+ });
202
+
203
+ console.log(result);
204
+ }
205
+
206
+ run();
207
+ ```
208
+
209
+ ### Standalone function
210
+
211
+ The standalone function version of this method:
212
+
213
+ ```typescript
214
+ import { SDKCore } from "@censys/platform-sdk/core.js";
215
+ import { globalDataGetTrackedScanThreatHunting } from "@censys/platform-sdk/funcs/globalDataGetTrackedScanThreatHunting.js";
216
+
217
+ // Use `SDKCore` for best tree-shaking performance.
218
+ // You can create one instance of it to use across an application.
219
+ const sdk = new SDKCore({
220
+ organizationId: "11111111-2222-3333-4444-555555555555",
221
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
222
+ });
223
+
224
+ async function run() {
225
+ const res = await globalDataGetTrackedScanThreatHunting(sdk, {
226
+ scanId: "cd62e794-9f12-4c2f-b5b3-153853aaf8d9",
227
+ });
228
+ if (res.ok) {
229
+ const { value: result } = res;
230
+ console.log(result);
231
+ } else {
232
+ console.log("globalDataGetTrackedScanThreatHunting failed:", res.error);
233
+ }
234
+ }
235
+
236
+ run();
237
+ ```
238
+
239
+ ### Parameters
240
+
241
+ | Parameter | Type | Required | Description |
242
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
243
+ | `request` | [operations.V3ThreathuntingScansGetRequest](../../models/operations/v3threathuntingscansgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
244
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
245
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
246
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
247
+
248
+ ### Response
249
+
250
+ **Promise\<[operations.V3ThreathuntingScansGetResponse](../../models/operations/v3threathuntingscansgetresponse.md)\>**
251
+
252
+ ### Errors
253
+
254
+ | Error Type | Status Code | Content Type |
255
+ | ------------------------ | ------------------------ | ------------------------ |
256
+ | errors.ErrorModel | 401, 403 | application/problem+json |
257
+ | errors.SDKError | 4XX, 5XX | \*/\* |
258
+
12
259
  ## valueCounts
13
260
 
14
261
  Get counts of web assets for specific field-value pairs and combinations of field-value pairs. This is similar to the [CensEye functionality](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#/) available in the Platform web UI, but it allows you to define specific fields of interest rather than the [default fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) leveraged by the tool in the UI.<br><br>Each array can only target fields within the same nested object. For example, you can combine `host.services.port=80` and `host.services.protocol=SSH` in the same array, but you cannot combine `host.services.port=80` and `host.location.country=”United States”` in the same array. You can input multiple arrays of objects in each API call.<br><br>To use this endpoint, your organization must have access to the Threat Hunting Module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
15
262
 
16
263
  ### Example Usage
17
264
 
265
+ <!-- UsageSnippet language="typescript" operationID="v3-threathunting-value-counts" method="post" path="/v3/threat-hunting/value-counts" -->
18
266
  ```typescript
19
267
  import { SDK } from "@censys/platform-sdk";
20
268
 
@@ -25,7 +25,6 @@ async function main() {
25
25
  "host.ip",
26
26
  ],
27
27
  pageSize: 1,
28
- pageToken: "<next_page_token>",
29
28
  query: "host.services: (protocol=SSH and not port: 22)",
30
29
  },
31
30
  });
@@ -18,17 +18,16 @@
18
18
  },
19
19
  "..": {
20
20
  "name": "@censys/platform-sdk",
21
- "version": "0.4.3",
21
+ "version": "0.5.0",
22
+ "dependencies": {
23
+ "zod": "^3.20.0"
24
+ },
22
25
  "devDependencies": {
23
26
  "@eslint/js": "^9.19.0",
24
27
  "eslint": "^9.19.0",
25
28
  "globals": "^15.14.0",
26
29
  "typescript": "^5.4.5",
27
- "typescript-eslint": "^8.22.0",
28
- "zod": "^3.25.17"
29
- },
30
- "peerDependencies": {
31
- "zod": "^3"
30
+ "typescript-eslint": "^8.22.0"
32
31
  }
33
32
  },
34
33
  "node_modules/@censys/platform-sdk": {
@@ -0,0 +1,18 @@
1
+ import { SDKCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
4
+ import * as errors from "../models/errors/index.js";
5
+ import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
6
+ import { SDKBaseError } from "../models/errors/sdkbaseerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { APIPromise } from "../types/async.js";
10
+ import { Result } from "../types/fp.js";
11
+ /**
12
+ * Create a tracked rescan
13
+ *
14
+ * @remarks
15
+ * Create a new tracked rescan for a known service or web property. Rescans are used to update information for previously discovered targets. The scan will be queued. The response will contain a scan ID that you can use with the [get tracked scan details endpoint](https://docs.censys.com/reference/v3-globaldata-scans-get#/) to monitor its status and results.<br><br>This endpoint is available to all Enterprise customers.
16
+ */
17
+ export declare function globalDataCreateTrackedScan(client: SDKCore, request: operations.V3GlobaldataScansRescanRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataScansRescanResponse, errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
+ //# sourceMappingURL=globalDataCreateTrackedScan.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"globalDataCreateTrackedScan.d.ts","sourceRoot":"","sources":["../src/funcs/globalDataCreateTrackedScan.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,+BAA+B,EACxC,MAAM,CAAC,UAAU,GACjB,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
@@ -0,0 +1,132 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.globalDataCreateTrackedScan = globalDataCreateTrackedScan;
40
+ const encodings_js_1 = require("../lib/encodings.js");
41
+ const M = __importStar(require("../lib/matchers.js"));
42
+ const primitives_js_1 = require("../lib/primitives.js");
43
+ const schemas_js_1 = require("../lib/schemas.js");
44
+ const security_js_1 = require("../lib/security.js");
45
+ const url_js_1 = require("../lib/url.js");
46
+ const errors = __importStar(require("../models/errors/index.js"));
47
+ const operations = __importStar(require("../models/operations/index.js"));
48
+ const async_js_1 = require("../types/async.js");
49
+ /**
50
+ * Create a tracked rescan
51
+ *
52
+ * @remarks
53
+ * Create a new tracked rescan for a known service or web property. Rescans are used to update information for previously discovered targets. The scan will be queued. The response will contain a scan ID that you can use with the [get tracked scan details endpoint](https://docs.censys.com/reference/v3-globaldata-scans-get#/) to monitor its status and results.<br><br>This endpoint is available to all Enterprise customers.
54
+ */
55
+ function globalDataCreateTrackedScan(client, request, options) {
56
+ return new async_js_1.APIPromise($do(client, request, options));
57
+ }
58
+ async function $do(client, request, options) {
59
+ const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.V3GlobaldataScansRescanRequest$outboundSchema.parse(value), "Input validation failed");
60
+ if (!parsed.ok) {
61
+ return [parsed, { status: "invalid" }];
62
+ }
63
+ const payload = parsed.value;
64
+ const body = (0, encodings_js_1.encodeJSON)("body", payload.ScansRescanInputBody, {
65
+ explode: true,
66
+ });
67
+ const path = (0, url_js_1.pathToFunc)("/v3/global/scans/rescan")();
68
+ const query = (0, encodings_js_1.encodeFormQuery)({
69
+ "organization_id": payload.organization_id
70
+ ?? client._options.organizationId,
71
+ }, { explode: false });
72
+ const headers = new Headers((0, primitives_js_1.compactMap)({
73
+ "Content-Type": "application/json",
74
+ Accept: "application/json",
75
+ }));
76
+ const secConfig = await (0, security_js_1.extractSecurity)(client._options.personalAccessToken);
77
+ const securityInput = secConfig == null
78
+ ? {}
79
+ : { personalAccessToken: secConfig };
80
+ const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
81
+ const context = {
82
+ options: client._options,
83
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
84
+ operationID: "v3-globaldata-scans-rescan",
85
+ oAuth2Scopes: [],
86
+ resolvedSecurity: requestSecurity,
87
+ securitySource: client._options.personalAccessToken,
88
+ retryConfig: options?.retries
89
+ || client._options.retryConfig
90
+ || { strategy: "none" },
91
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
92
+ };
93
+ const requestRes = client._createRequest(context, {
94
+ security: requestSecurity,
95
+ method: "POST",
96
+ baseURL: options?.serverURL,
97
+ path: path,
98
+ headers: headers,
99
+ query: query,
100
+ body: body,
101
+ userAgent: client._options.userAgent,
102
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
103
+ }, options);
104
+ if (!requestRes.ok) {
105
+ return [requestRes, { status: "invalid" }];
106
+ }
107
+ const req = requestRes.value;
108
+ const doResult = await client._do(req, {
109
+ context,
110
+ errorCodes: ["401", "403", "4XX", "5XX"],
111
+ retryConfig: context.retryConfig,
112
+ retryCodes: context.retryCodes,
113
+ });
114
+ if (!doResult.ok) {
115
+ return [doResult, { status: "request-error", request: req }];
116
+ }
117
+ const response = doResult.value;
118
+ const responseFields = {
119
+ HttpMeta: { Response: response, Request: req },
120
+ };
121
+ const [result] = await M.match(M.json(200, operations.V3GlobaldataScansRescanResponse$inboundSchema, {
122
+ hdrs: true,
123
+ key: "Result",
124
+ }), M.jsonErr([401, 403], errors.ErrorModel$inboundSchema, {
125
+ ctype: "application/problem+json",
126
+ }), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
127
+ if (!result.ok) {
128
+ return [result, { status: "complete", request: req, response }];
129
+ }
130
+ return [result, { status: "complete", request: req, response }];
131
+ }
132
+ //# sourceMappingURL=globalDataCreateTrackedScan.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"globalDataCreateTrackedScan.js","sourceRoot":"","sources":["../src/funcs/globalDataCreateTrackedScan.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,kEAuBC;AAnDD,sDAAkE;AAClE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,MAAe,EACf,OAAkD,EAClD,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAkD,EAClD,OAAwB;IAkBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,6CAA6C,CAAC,KAAK,CAAC,KAAK,CAAC,EACvE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,CAAC,oBAAoB,EAAE;QAC5D,OAAO,EAAE,IAAI;KACd,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,yBAAyB,CAAC,EAAE,CAAC;IAErD,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,iBAAiB,EAAE,OAAO,CAAC,eAAe;eACrC,MAAM,CAAC,QAAQ,CAAC,cAAc;KACpC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,4BAA4B;QACzC,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACxC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,6CAA6C,EAAE;QACpE,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,QAAQ;KACd,CAAC,EACF,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QACrD,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
@@ -0,0 +1,18 @@
1
+ import { SDKCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
4
+ import * as errors from "../models/errors/index.js";
5
+ import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
6
+ import { SDKBaseError } from "../models/errors/sdkbaseerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { APIPromise } from "../types/async.js";
10
+ import { Result } from "../types/fp.js";
11
+ /**
12
+ * Get Host Observations With Certificate
13
+ *
14
+ * @remarks
15
+ * Retrieve historical observations of hosts associated with a certificate fingerprint. Useful for threat hunting, detection engineering, and timeline generation.
16
+ */
17
+ export declare function globalDataGetHostObservationsWithCertificate(client: SDKCore, request: operations.V3GlobaldataGetHostObservationsWithCertificateRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataGetHostObservationsWithCertificateResponse, errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
+ //# sourceMappingURL=globalDataGetHostObservationsWithCertificate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"globalDataGetHostObservationsWithCertificate.d.ts","sourceRoot":"","sources":["../src/funcs/globalDataGetHostObservationsWithCertificate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,4CAA4C,CAC1D,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,qDAAqD,EACzE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,sDAAsD,EAC/D,MAAM,CAAC,UAAU,GACjB,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
@@ -0,0 +1,141 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.globalDataGetHostObservationsWithCertificate = globalDataGetHostObservationsWithCertificate;
40
+ const encodings_js_1 = require("../lib/encodings.js");
41
+ const M = __importStar(require("../lib/matchers.js"));
42
+ const primitives_js_1 = require("../lib/primitives.js");
43
+ const schemas_js_1 = require("../lib/schemas.js");
44
+ const security_js_1 = require("../lib/security.js");
45
+ const url_js_1 = require("../lib/url.js");
46
+ const errors = __importStar(require("../models/errors/index.js"));
47
+ const operations = __importStar(require("../models/operations/index.js"));
48
+ const async_js_1 = require("../types/async.js");
49
+ /**
50
+ * Get Host Observations With Certificate
51
+ *
52
+ * @remarks
53
+ * Retrieve historical observations of hosts associated with a certificate fingerprint. Useful for threat hunting, detection engineering, and timeline generation.
54
+ */
55
+ function globalDataGetHostObservationsWithCertificate(client, request, options) {
56
+ return new async_js_1.APIPromise($do(client, request, options));
57
+ }
58
+ async function $do(client, request, options) {
59
+ const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations
60
+ .V3GlobaldataGetHostObservationsWithCertificateRequest$outboundSchema
61
+ .parse(value), "Input validation failed");
62
+ if (!parsed.ok) {
63
+ return [parsed, { status: "invalid" }];
64
+ }
65
+ const payload = parsed.value;
66
+ const body = null;
67
+ const pathParams = {
68
+ certificate_id: (0, encodings_js_1.encodeSimple)("certificate_id", payload.certificate_id, {
69
+ explode: false,
70
+ charEncoding: "percent",
71
+ }),
72
+ };
73
+ const path = (0, url_js_1.pathToFunc)("/v3/global/asset/certificate/{certificate_id}/observations/hosts")(pathParams);
74
+ const query = (0, encodings_js_1.encodeFormQuery)({
75
+ "end_time": payload.end_time,
76
+ "organization_id": payload.organization_id
77
+ ?? client._options.organizationId,
78
+ "page_size": payload.page_size,
79
+ "page_token": payload.page_token,
80
+ "port": payload.port,
81
+ "protocol": payload.protocol,
82
+ "start_time": payload.start_time,
83
+ }, { explode: false });
84
+ const headers = new Headers((0, primitives_js_1.compactMap)({
85
+ Accept: "application/json",
86
+ }));
87
+ const secConfig = await (0, security_js_1.extractSecurity)(client._options.personalAccessToken);
88
+ const securityInput = secConfig == null
89
+ ? {}
90
+ : { personalAccessToken: secConfig };
91
+ const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
92
+ const context = {
93
+ options: client._options,
94
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
95
+ operationID: "v3-globaldata-get-host-observations-with-certificate",
96
+ oAuth2Scopes: [],
97
+ resolvedSecurity: requestSecurity,
98
+ securitySource: client._options.personalAccessToken,
99
+ retryConfig: options?.retries
100
+ || client._options.retryConfig
101
+ || { strategy: "none" },
102
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
103
+ };
104
+ const requestRes = client._createRequest(context, {
105
+ security: requestSecurity,
106
+ method: "GET",
107
+ baseURL: options?.serverURL,
108
+ path: path,
109
+ headers: headers,
110
+ query: query,
111
+ body: body,
112
+ userAgent: client._options.userAgent,
113
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
114
+ }, options);
115
+ if (!requestRes.ok) {
116
+ return [requestRes, { status: "invalid" }];
117
+ }
118
+ const req = requestRes.value;
119
+ const doResult = await client._do(req, {
120
+ context,
121
+ errorCodes: ["401", "403", "4XX", "5XX"],
122
+ retryConfig: context.retryConfig,
123
+ retryCodes: context.retryCodes,
124
+ });
125
+ if (!doResult.ok) {
126
+ return [doResult, { status: "request-error", request: req }];
127
+ }
128
+ const response = doResult.value;
129
+ const responseFields = {
130
+ HttpMeta: { Response: response, Request: req },
131
+ };
132
+ const [result] = await M.match(M.json(200, operations
133
+ .V3GlobaldataGetHostObservationsWithCertificateResponse$inboundSchema, { hdrs: true, key: "Result" }), M.jsonErr([401, 403], errors.ErrorModel$inboundSchema, {
134
+ ctype: "application/problem+json",
135
+ }), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
136
+ if (!result.ok) {
137
+ return [result, { status: "complete", request: req, response }];
138
+ }
139
+ return [result, { status: "complete", request: req, response }];
140
+ }
141
+ //# sourceMappingURL=globalDataGetHostObservationsWithCertificate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"globalDataGetHostObservationsWithCertificate.js","sourceRoot":"","sources":["../src/funcs/globalDataGetHostObservationsWithCertificate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,oGAuBC;AAnDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,4CAA4C,CAC1D,MAAe,EACf,OAAyE,EACzE,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAyE,EACzE,OAAwB;IAkBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU;SACP,oEAAoE;SACpE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,cAAc,EAAE,IAAA,2BAAY,EAAC,gBAAgB,EAAE,OAAO,CAAC,cAAc,EAAE;YACrE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,kEAAkE,CACnE,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,UAAU,EAAE,OAAO,CAAC,QAAQ;QAC5B,iBAAiB,EAAE,OAAO,CAAC,eAAe;eACrC,MAAM,CAAC,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,OAAO,CAAC,SAAS;QAC9B,YAAY,EAAE,OAAO,CAAC,UAAU;QAChC,MAAM,EAAE,OAAO,CAAC,IAAI;QACpB,UAAU,EAAE,OAAO,CAAC,QAAQ;QAC5B,YAAY,EAAE,OAAO,CAAC,UAAU;KACjC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,sDAAsD;QACnE,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACxC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU;SACP,oEAAoE,EACvE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QACrD,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}