@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.
- package/FUNCTIONS.md +0 -1
- package/README.md +17 -2
- package/docs/sdks/collections/README.md +12 -6
- package/docs/sdks/globaldata/README.md +347 -6
- package/docs/sdks/threathunting/README.md +248 -0
- package/examples/globalDataSearch.example.ts +0 -1
- package/examples/package-lock.json +5 -6
- package/funcs/globalDataCreateTrackedScan.d.ts +18 -0
- package/funcs/globalDataCreateTrackedScan.d.ts.map +1 -0
- package/funcs/globalDataCreateTrackedScan.js +132 -0
- package/funcs/globalDataCreateTrackedScan.js.map +1 -0
- package/funcs/globalDataGetHostObservationsWithCertificate.d.ts +18 -0
- package/funcs/globalDataGetHostObservationsWithCertificate.d.ts.map +1 -0
- package/funcs/globalDataGetHostObservationsWithCertificate.js +141 -0
- package/funcs/globalDataGetHostObservationsWithCertificate.js.map +1 -0
- package/funcs/globalDataGetTrackedScan.d.ts +19 -0
- package/funcs/globalDataGetTrackedScan.d.ts.map +1 -0
- package/funcs/globalDataGetTrackedScan.js +137 -0
- package/funcs/globalDataGetTrackedScan.js.map +1 -0
- package/funcs/globalDataGetTrackedScanThreatHunting.d.ts +19 -0
- package/funcs/globalDataGetTrackedScanThreatHunting.d.ts.map +1 -0
- package/funcs/globalDataGetTrackedScanThreatHunting.js +137 -0
- package/funcs/globalDataGetTrackedScanThreatHunting.js.map +1 -0
- package/funcs/threatHuntingCreateTrackedScan.d.ts +18 -0
- package/funcs/threatHuntingCreateTrackedScan.d.ts.map +1 -0
- package/funcs/threatHuntingCreateTrackedScan.js +129 -0
- package/funcs/threatHuntingCreateTrackedScan.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/models/components/elasticsearch.d.ts +3 -0
- package/models/components/elasticsearch.d.ts.map +1 -1
- package/models/components/elasticsearch.js +5 -0
- package/models/components/elasticsearch.js.map +1 -1
- package/models/components/elasticsearcherrormessage.d.ts +33 -0
- package/models/components/elasticsearcherrormessage.d.ts.map +1 -0
- package/models/components/elasticsearcherrormessage.js +73 -0
- package/models/components/elasticsearcherrormessage.js.map +1 -0
- package/models/components/hostobservationrange.d.ts +39 -0
- package/models/components/hostobservationrange.d.ts.map +1 -0
- package/models/components/hostobservationrange.js +92 -0
- package/models/components/hostobservationrange.js.map +1 -0
- package/models/components/hostobservationresponse.d.ts +34 -0
- package/models/components/hostobservationresponse.d.ts.map +1 -0
- package/models/components/hostobservationresponse.js +85 -0
- package/models/components/hostobservationresponse.js.map +1 -0
- package/models/components/httpfavicon.d.ts +5 -0
- package/models/components/httpfavicon.d.ts.map +1 -1
- package/models/components/httpfavicon.js +4 -0
- package/models/components/httpfavicon.js.map +1 -1
- package/models/components/index.d.ts +14 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +14 -0
- package/models/components/index.js.map +1 -1
- package/models/components/responseenvelopehostobservationresponse.d.ts +30 -0
- package/models/components/responseenvelopehostobservationresponse.d.ts.map +1 -0
- package/models/components/responseenvelopehostobservationresponse.js +70 -0
- package/models/components/responseenvelopehostobservationresponse.js.map +1 -0
- package/models/components/responseenvelopetrackedscan.d.ts +30 -0
- package/models/components/responseenvelopetrackedscan.d.ts.map +1 -0
- package/models/components/responseenvelopetrackedscan.js +70 -0
- package/models/components/responseenvelopetrackedscan.js.map +1 -0
- package/models/components/scansdiscoveryinputbody.d.ts +172 -0
- package/models/components/scansdiscoveryinputbody.d.ts.map +1 -0
- package/models/components/scansdiscoveryinputbody.js +233 -0
- package/models/components/scansdiscoveryinputbody.js.map +1 -0
- package/models/components/scansrescaninputbody.d.ts +214 -0
- package/models/components/scansrescaninputbody.d.ts.map +1 -0
- package/models/components/scansrescaninputbody.js +268 -0
- package/models/components/scansrescaninputbody.js.map +1 -0
- package/models/components/screenshot.d.ts +2 -0
- package/models/components/screenshot.d.ts.map +1 -1
- package/models/components/screenshot.js +11 -0
- package/models/components/screenshot.js.map +1 -1
- package/models/components/searchaggregateinputbody.d.ts +5 -0
- package/models/components/searchaggregateinputbody.d.ts.map +1 -1
- package/models/components/searchaggregateinputbody.js +4 -0
- package/models/components/searchaggregateinputbody.js.map +1 -1
- package/models/components/searchvaluecountsinputbody.d.ts +5 -0
- package/models/components/searchvaluecountsinputbody.d.ts.map +1 -1
- package/models/components/searchvaluecountsinputbody.js +2 -0
- package/models/components/searchvaluecountsinputbody.js.map +1 -1
- package/models/components/serviceid.d.ts +70 -0
- package/models/components/serviceid.d.ts.map +1 -0
- package/models/components/serviceid.js +106 -0
- package/models/components/serviceid.js.map +1 -0
- package/models/components/trackedscan.d.ts +39 -0
- package/models/components/trackedscan.d.ts.map +1 -0
- package/models/components/trackedscan.js +90 -0
- package/models/components/trackedscan.js.map +1 -0
- package/models/components/trackedscanscantarget.d.ts +39 -0
- package/models/components/trackedscanscantarget.d.ts.map +1 -0
- package/models/components/trackedscanscantarget.js +94 -0
- package/models/components/trackedscanscantarget.js.map +1 -0
- package/models/components/trackedscanscantargethostnameport.d.ts +31 -0
- package/models/components/trackedscanscantargethostnameport.d.ts.map +1 -0
- package/models/components/trackedscanscantargethostnameport.js +71 -0
- package/models/components/trackedscanscantargethostnameport.js.map +1 -0
- package/models/components/trackedscanscantargethostport.d.ts +31 -0
- package/models/components/trackedscanscantargethostport.d.ts.map +1 -0
- package/models/components/trackedscanscantargethostport.js +71 -0
- package/models/components/trackedscanscantargethostport.js.map +1 -0
- package/models/components/trackedscantask.d.ts +74 -0
- package/models/components/trackedscantask.d.ts.map +1 -0
- package/models/components/trackedscantask.js +106 -0
- package/models/components/trackedscantask.js.map +1 -0
- package/models/components/weborigin.d.ts +31 -0
- package/models/components/weborigin.d.ts.map +1 -0
- package/models/components/weborigin.js +71 -0
- package/models/components/weborigin.js.map +1 -0
- package/models/operations/index.d.ts +5 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +5 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/v3globaldatagethostobservationswithcertificate.d.ts +124 -0
- package/models/operations/v3globaldatagethostobservationswithcertificate.d.ts.map +1 -0
- package/models/operations/v3globaldatagethostobservationswithcertificate.js +178 -0
- package/models/operations/v3globaldatagethostobservationswithcertificate.js.map +1 -0
- package/models/operations/v3globaldatascansget.d.ts +94 -0
- package/models/operations/v3globaldatascansget.d.ts.map +1 -0
- package/models/operations/v3globaldatascansget.js +157 -0
- package/models/operations/v3globaldatascansget.js.map +1 -0
- package/models/operations/v3globaldatascansrescan.d.ts +91 -0
- package/models/operations/v3globaldatascansrescan.d.ts.map +1 -0
- package/models/operations/v3globaldatascansrescan.js +157 -0
- package/models/operations/v3globaldatascansrescan.js.map +1 -0
- package/models/operations/v3threathuntingscansdiscovery.d.ts +91 -0
- package/models/operations/v3threathuntingscansdiscovery.d.ts.map +1 -0
- package/models/operations/v3threathuntingscansdiscovery.js +157 -0
- package/models/operations/v3threathuntingscansdiscovery.js.map +1 -0
- package/models/operations/v3threathuntingscansget.d.ts +94 -0
- package/models/operations/v3threathuntingscansget.d.ts.map +1 -0
- package/models/operations/v3threathuntingscansget.js +157 -0
- package/models/operations/v3threathuntingscansget.js.map +1 -0
- package/package.json +4 -5
- package/sdk/globaldata.d.ts +30 -0
- package/sdk/globaldata.d.ts.map +1 -1
- package/sdk/globaldata.js +42 -0
- package/sdk/globaldata.js.map +1 -1
- package/sdk/threathunting.d.ts +23 -0
- package/sdk/threathunting.d.ts.map +1 -1
- package/sdk/threathunting.js +32 -0
- package/sdk/threathunting.js.map +1 -1
- package/src/funcs/globalDataCreateTrackedScan.ts +185 -0
- package/src/funcs/globalDataGetHostObservationsWithCertificate.ts +201 -0
- package/src/funcs/globalDataGetTrackedScan.ts +191 -0
- package/src/funcs/globalDataGetTrackedScanThreatHunting.ts +191 -0
- package/src/funcs/threatHuntingCreateTrackedScan.ts +188 -0
- package/src/lib/config.ts +4 -4
- package/src/models/components/elasticsearch.ts +12 -0
- package/src/models/components/elasticsearcherrormessage.ts +74 -0
- package/src/models/components/hostobservationrange.ts +99 -0
- package/src/models/components/hostobservationresponse.ts +91 -0
- package/src/models/components/httpfavicon.ts +9 -0
- package/src/models/components/index.ts +14 -0
- package/src/models/components/responseenvelopehostobservationresponse.ts +83 -0
- package/src/models/components/responseenvelopetrackedscan.ts +74 -0
- package/src/models/components/scansdiscoveryinputbody.ts +385 -0
- package/src/models/components/scansrescaninputbody.ts +428 -0
- package/src/models/components/screenshot.ts +13 -0
- package/src/models/components/searchaggregateinputbody.ts +9 -0
- package/src/models/components/searchvaluecountsinputbody.ts +7 -0
- package/src/models/components/serviceid.ts +116 -0
- package/src/models/components/trackedscan.ts +101 -0
- package/src/models/components/trackedscanscantarget.ts +117 -0
- package/src/models/components/trackedscanscantargethostnameport.ts +73 -0
- package/src/models/components/trackedscanscantargethostport.ts +72 -0
- package/src/models/components/trackedscantask.ts +114 -0
- package/src/models/components/weborigin.ts +66 -0
- package/src/models/operations/index.ts +5 -0
- package/src/models/operations/v3globaldatagethostobservationswithcertificate.ts +317 -0
- package/src/models/operations/v3globaldatascansget.ts +232 -0
- package/src/models/operations/v3globaldatascansrescan.ts +229 -0
- package/src/models/operations/v3threathuntingscansdiscovery.ts +238 -0
- package/src/models/operations/v3threathuntingscansget.ts +232 -0
- package/src/sdk/globaldata.ts +76 -0
- package/src/sdk/threathunting.ts +56 -0
package/src/sdk/globaldata.ts
CHANGED
|
@@ -3,11 +3,15 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import { globalDataAggregate } from "../funcs/globalDataAggregate.js";
|
|
6
|
+
import { globalDataCreateTrackedScan } from "../funcs/globalDataCreateTrackedScan.js";
|
|
6
7
|
import { globalDataGetCertificate } from "../funcs/globalDataGetCertificate.js";
|
|
7
8
|
import { globalDataGetCertificates } from "../funcs/globalDataGetCertificates.js";
|
|
8
9
|
import { globalDataGetHost } from "../funcs/globalDataGetHost.js";
|
|
10
|
+
import { globalDataGetHostObservationsWithCertificate } from "../funcs/globalDataGetHostObservationsWithCertificate.js";
|
|
9
11
|
import { globalDataGetHosts } from "../funcs/globalDataGetHosts.js";
|
|
10
12
|
import { globalDataGetHostTimeline } from "../funcs/globalDataGetHostTimeline.js";
|
|
13
|
+
import { globalDataGetTrackedScan } from "../funcs/globalDataGetTrackedScan.js";
|
|
14
|
+
import { globalDataGetTrackedScanThreatHunting } from "../funcs/globalDataGetTrackedScanThreatHunting.js";
|
|
11
15
|
import { globalDataGetWebProperties } from "../funcs/globalDataGetWebProperties.js";
|
|
12
16
|
import { globalDataGetWebProperty } from "../funcs/globalDataGetWebProperty.js";
|
|
13
17
|
import { globalDataSearch } from "../funcs/globalDataSearch.js";
|
|
@@ -50,6 +54,25 @@ export class GlobalData extends ClientSDK {
|
|
|
50
54
|
));
|
|
51
55
|
}
|
|
52
56
|
|
|
57
|
+
/**
|
|
58
|
+
* Get Host Observations With Certificate
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* Retrieve historical observations of hosts associated with a certificate fingerprint. Useful for threat hunting, detection engineering, and timeline generation.
|
|
62
|
+
*/
|
|
63
|
+
async getHostObservationsWithCertificate(
|
|
64
|
+
request: operations.V3GlobaldataGetHostObservationsWithCertificateRequest,
|
|
65
|
+
options?: RequestOptions,
|
|
66
|
+
): Promise<
|
|
67
|
+
operations.V3GlobaldataGetHostObservationsWithCertificateResponse
|
|
68
|
+
> {
|
|
69
|
+
return unwrapAsync(globalDataGetHostObservationsWithCertificate(
|
|
70
|
+
this,
|
|
71
|
+
request,
|
|
72
|
+
options,
|
|
73
|
+
));
|
|
74
|
+
}
|
|
75
|
+
|
|
53
76
|
/**
|
|
54
77
|
* Get multiple hosts
|
|
55
78
|
*
|
|
@@ -135,6 +158,41 @@ export class GlobalData extends ClientSDK {
|
|
|
135
158
|
));
|
|
136
159
|
}
|
|
137
160
|
|
|
161
|
+
/**
|
|
162
|
+
* Create a tracked rescan
|
|
163
|
+
*
|
|
164
|
+
* @remarks
|
|
165
|
+
* 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.
|
|
166
|
+
*/
|
|
167
|
+
async createTrackedScan(
|
|
168
|
+
request: operations.V3GlobaldataScansRescanRequest,
|
|
169
|
+
options?: RequestOptions,
|
|
170
|
+
): Promise<operations.V3GlobaldataScansRescanResponse> {
|
|
171
|
+
return unwrapAsync(globalDataCreateTrackedScan(
|
|
172
|
+
this,
|
|
173
|
+
request,
|
|
174
|
+
options,
|
|
175
|
+
));
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Get tracked scan details
|
|
180
|
+
*
|
|
181
|
+
* @remarks
|
|
182
|
+
* Retrieve the current status and results of a tracked scan by its ID.
|
|
183
|
+
* This endpoint works for both discovery scans and rescans.
|
|
184
|
+
*/
|
|
185
|
+
async getTrackedScan(
|
|
186
|
+
request: operations.V3GlobaldataScansGetRequest,
|
|
187
|
+
options?: RequestOptions,
|
|
188
|
+
): Promise<operations.V3GlobaldataScansGetResponse> {
|
|
189
|
+
return unwrapAsync(globalDataGetTrackedScan(
|
|
190
|
+
this,
|
|
191
|
+
request,
|
|
192
|
+
options,
|
|
193
|
+
));
|
|
194
|
+
}
|
|
195
|
+
|
|
138
196
|
/**
|
|
139
197
|
* Aggregate results for a search query
|
|
140
198
|
*
|
|
@@ -168,4 +226,22 @@ export class GlobalData extends ClientSDK {
|
|
|
168
226
|
options,
|
|
169
227
|
));
|
|
170
228
|
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Get tracked scan details
|
|
232
|
+
*
|
|
233
|
+
* @remarks
|
|
234
|
+
* Retrieve the current status and results of a tracked scan by its ID.
|
|
235
|
+
* This endpoint works for both discovery scans and rescans.
|
|
236
|
+
*/
|
|
237
|
+
async getTrackedScanThreatHunting(
|
|
238
|
+
request: operations.V3ThreathuntingScansGetRequest,
|
|
239
|
+
options?: RequestOptions,
|
|
240
|
+
): Promise<operations.V3ThreathuntingScansGetResponse> {
|
|
241
|
+
return unwrapAsync(globalDataGetTrackedScanThreatHunting(
|
|
242
|
+
this,
|
|
243
|
+
request,
|
|
244
|
+
options,
|
|
245
|
+
));
|
|
246
|
+
}
|
|
171
247
|
}
|
package/src/sdk/threathunting.ts
CHANGED
|
@@ -2,12 +2,68 @@
|
|
|
2
2
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
|
+
import { globalDataGetTrackedScan } from "../funcs/globalDataGetTrackedScan.js";
|
|
6
|
+
import { globalDataGetTrackedScanThreatHunting } from "../funcs/globalDataGetTrackedScanThreatHunting.js";
|
|
7
|
+
import { threatHuntingCreateTrackedScan } from "../funcs/threatHuntingCreateTrackedScan.js";
|
|
5
8
|
import { threatHuntingValueCounts } from "../funcs/threatHuntingValueCounts.js";
|
|
6
9
|
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
7
10
|
import * as operations from "../models/operations/index.js";
|
|
8
11
|
import { unwrapAsync } from "../types/fp.js";
|
|
9
12
|
|
|
10
13
|
export class ThreatHunting extends ClientSDK {
|
|
14
|
+
/**
|
|
15
|
+
* Get tracked scan details
|
|
16
|
+
*
|
|
17
|
+
* @remarks
|
|
18
|
+
* Retrieve the current status and results of a tracked scan by its ID.
|
|
19
|
+
* This endpoint works for both discovery scans and rescans.
|
|
20
|
+
*/
|
|
21
|
+
async getTrackedScan(
|
|
22
|
+
request: operations.V3GlobaldataScansGetRequest,
|
|
23
|
+
options?: RequestOptions,
|
|
24
|
+
): Promise<operations.V3GlobaldataScansGetResponse> {
|
|
25
|
+
return unwrapAsync(globalDataGetTrackedScan(
|
|
26
|
+
this,
|
|
27
|
+
request,
|
|
28
|
+
options,
|
|
29
|
+
));
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Create a tracked discovery scan
|
|
34
|
+
*
|
|
35
|
+
* @remarks
|
|
36
|
+
* 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.
|
|
37
|
+
*/
|
|
38
|
+
async createTrackedScan(
|
|
39
|
+
request: operations.V3ThreathuntingScansDiscoveryRequest,
|
|
40
|
+
options?: RequestOptions,
|
|
41
|
+
): Promise<operations.V3ThreathuntingScansDiscoveryResponse> {
|
|
42
|
+
return unwrapAsync(threatHuntingCreateTrackedScan(
|
|
43
|
+
this,
|
|
44
|
+
request,
|
|
45
|
+
options,
|
|
46
|
+
));
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Get tracked scan details
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* Retrieve the current status and results of a tracked scan by its ID.
|
|
54
|
+
* This endpoint works for both discovery scans and rescans.
|
|
55
|
+
*/
|
|
56
|
+
async getTrackedScanThreatHunting(
|
|
57
|
+
request: operations.V3ThreathuntingScansGetRequest,
|
|
58
|
+
options?: RequestOptions,
|
|
59
|
+
): Promise<operations.V3ThreathuntingScansGetResponse> {
|
|
60
|
+
return unwrapAsync(globalDataGetTrackedScanThreatHunting(
|
|
61
|
+
this,
|
|
62
|
+
request,
|
|
63
|
+
options,
|
|
64
|
+
));
|
|
65
|
+
}
|
|
66
|
+
|
|
11
67
|
/**
|
|
12
68
|
* CensEye: Retrieve value counts to discover pivots
|
|
13
69
|
*
|