@censys/platform-sdk 0.12.12 → 0.12.14
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/docs/sdks/adversaryinvestigation/README.md +8 -8
- package/docs/sdks/collections/README.md +6 -6
- package/docs/sdks/globaldata/README.md +38 -22
- package/docs/sdks/tagsandcomments/README.md +1 -1
- package/docs/sdks/threathunting/README.md +9 -9
- package/funcs/collectionsAggregate.d.ts +1 -1
- package/funcs/collectionsAggregate.js +1 -1
- package/funcs/collectionsCreate.d.ts +1 -1
- package/funcs/collectionsCreate.js +1 -1
- package/funcs/collectionsGet.d.ts +1 -1
- package/funcs/collectionsGet.js +1 -1
- package/funcs/collectionsListEvents.d.ts +1 -1
- package/funcs/collectionsListEvents.js +1 -1
- package/funcs/collectionsSearch.d.ts +1 -1
- package/funcs/collectionsSearch.js +1 -1
- package/funcs/collectionsUpdate.d.ts +1 -1
- package/funcs/collectionsUpdate.js +1 -1
- package/funcs/globalDataAggregate.d.ts +1 -1
- package/funcs/globalDataAggregate.js +1 -1
- package/funcs/globalDataCreateTrackedScan.d.ts +1 -1
- package/funcs/globalDataCreateTrackedScan.js +1 -1
- package/funcs/globalDataGetCertificate.d.ts +1 -1
- package/funcs/globalDataGetCertificate.js +4 -2
- package/funcs/globalDataGetCertificate.js.map +1 -1
- package/funcs/globalDataGetCertificateRaw.d.ts +1 -1
- package/funcs/globalDataGetCertificateRaw.js +1 -1
- package/funcs/globalDataGetCertificates.d.ts +1 -1
- package/funcs/globalDataGetCertificates.js +1 -1
- package/funcs/globalDataGetCertificatesRaw.d.ts +1 -1
- package/funcs/globalDataGetCertificatesRaw.js +1 -1
- package/funcs/globalDataGetHost.d.ts +1 -1
- package/funcs/globalDataGetHost.js +4 -2
- package/funcs/globalDataGetHost.js.map +1 -1
- package/funcs/globalDataGetHostEnrichment.d.ts +1 -1
- package/funcs/globalDataGetHostEnrichment.js +4 -2
- package/funcs/globalDataGetHostEnrichment.js.map +1 -1
- package/funcs/globalDataGetHostTimeline.d.ts +1 -1
- package/funcs/globalDataGetHostTimeline.js +1 -1
- package/funcs/globalDataGetHosts.d.ts +1 -1
- package/funcs/globalDataGetHosts.js +1 -1
- package/funcs/globalDataGetTrackedScan.d.ts +1 -1
- package/funcs/globalDataGetTrackedScan.js +1 -1
- package/funcs/globalDataGetWebProperties.d.ts +1 -1
- package/funcs/globalDataGetWebProperties.js +1 -1
- package/funcs/globalDataGetWebProperty.d.ts +1 -1
- package/funcs/globalDataGetWebProperty.js +3 -1
- package/funcs/globalDataGetWebProperty.js.map +1 -1
- package/funcs/globalDataListDnsIpResolutionBounds.d.ts +1 -1
- package/funcs/globalDataListDnsIpResolutionBounds.js +1 -1
- package/funcs/globalDataListDnsIpResolutionRanges.d.ts +1 -1
- package/funcs/globalDataListDnsIpResolutionRanges.js +1 -1
- package/funcs/globalDataListDnsNameResolutionBounds.d.ts +1 -1
- package/funcs/globalDataListDnsNameResolutionBounds.js +1 -1
- package/funcs/globalDataListDnsNameResolutionRanges.d.ts +1 -1
- package/funcs/globalDataListDnsNameResolutionRanges.js +1 -1
- package/funcs/globalDataListServicesOnHost.d.ts +1 -1
- package/funcs/globalDataListServicesOnHost.js +1 -1
- package/funcs/globalDataSearch.d.ts +1 -1
- package/funcs/globalDataSearch.js +1 -1
- package/funcs/tagsAndCommentsUpdateTag.d.ts +1 -1
- package/funcs/tagsAndCommentsUpdateTag.js +1 -1
- package/funcs/threatHuntingCreateCenseyeJob.d.ts +1 -1
- package/funcs/threatHuntingCreateCenseyeJob.js +1 -1
- package/funcs/threatHuntingCreateInvestigationFileUpload.d.ts +1 -1
- package/funcs/threatHuntingCreateInvestigationFileUpload.js +1 -1
- package/funcs/threatHuntingCreateInvestigationJob.d.ts +1 -1
- package/funcs/threatHuntingCreateInvestigationJob.js +1 -1
- package/funcs/threatHuntingCreateTrackedScan.d.ts +1 -1
- package/funcs/threatHuntingCreateTrackedScan.js +1 -1
- package/funcs/threatHuntingGetCenseyeJobResults.d.ts +1 -1
- package/funcs/threatHuntingGetCenseyeJobResults.js +1 -1
- package/funcs/threatHuntingGetHostObservationsWithCertificate.d.ts +1 -1
- package/funcs/threatHuntingGetHostObservationsWithCertificate.js +1 -1
- package/funcs/threatHuntingGetTrackedScanThreatHunting.d.ts +1 -1
- package/funcs/threatHuntingGetTrackedScanThreatHunting.js +1 -1
- package/funcs/threatHuntingListThreats.d.ts +1 -1
- package/funcs/threatHuntingListThreats.js +1 -1
- package/funcs/threatHuntingValueCounts.d.ts +1 -1
- package/funcs/threatHuntingValueCounts.js +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/models/components/collection.d.ts +18 -1
- package/models/components/collection.d.ts.map +1 -1
- package/models/components/collection.js +11 -1
- package/models/components/collection.js.map +1 -1
- package/models/components/crudcreateinputbody.d.ts +19 -0
- package/models/components/crudcreateinputbody.d.ts.map +1 -1
- package/models/components/crudcreateinputbody.js +11 -1
- package/models/components/crudcreateinputbody.js.map +1 -1
- package/models/components/crudupdateinputbody.d.ts +19 -0
- package/models/components/crudupdateinputbody.d.ts.map +1 -1
- package/models/components/crudupdateinputbody.js +11 -1
- package/models/components/crudupdateinputbody.js.map +1 -1
- package/models/components/http.d.ts +6 -0
- package/models/components/http.d.ts.map +1 -1
- package/models/components/http.js +4 -0
- package/models/components/http.js.map +1 -1
- package/models/components/httpcopyright.d.ts +17 -0
- package/models/components/httpcopyright.d.ts.map +1 -0
- package/models/components/httpcopyright.js +51 -0
- package/models/components/httpcopyright.js.map +1 -0
- package/models/components/index.d.ts +1 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +1 -0
- package/models/components/index.js.map +1 -1
- package/models/operations/v3globaldataassetcertificate.d.ts +10 -0
- package/models/operations/v3globaldataassetcertificate.d.ts.map +1 -1
- package/models/operations/v3globaldataassetcertificate.js +3 -0
- package/models/operations/v3globaldataassetcertificate.js.map +1 -1
- package/models/operations/v3globaldataassethost.d.ts +10 -0
- package/models/operations/v3globaldataassethost.d.ts.map +1 -1
- package/models/operations/v3globaldataassethost.js +3 -0
- package/models/operations/v3globaldataassethost.js.map +1 -1
- package/models/operations/v3globaldataassethostenrichment.d.ts +10 -0
- package/models/operations/v3globaldataassethostenrichment.d.ts.map +1 -1
- package/models/operations/v3globaldataassethostenrichment.js +3 -0
- package/models/operations/v3globaldataassethostenrichment.js.map +1 -1
- package/models/operations/v3globaldataassetwebproperty.d.ts +10 -0
- package/models/operations/v3globaldataassetwebproperty.d.ts.map +1 -1
- package/models/operations/v3globaldataassetwebproperty.js +3 -0
- package/models/operations/v3globaldataassetwebproperty.js.map +1 -1
- package/package.json +2 -2
- package/sdk/adversaryinvestigation.d.ts +8 -8
- package/sdk/adversaryinvestigation.js +8 -8
- package/sdk/collections.d.ts +6 -6
- package/sdk/collections.js +6 -6
- package/sdk/globaldata.d.ts +19 -19
- package/sdk/globaldata.js +19 -19
- package/sdk/tagsandcomments.d.ts +1 -1
- package/sdk/tagsandcomments.js +1 -1
- package/sdk/threathunting.d.ts +9 -9
- package/sdk/threathunting.js +9 -9
- package/src/funcs/collectionsAggregate.ts +1 -1
- package/src/funcs/collectionsCreate.ts +1 -1
- package/src/funcs/collectionsGet.ts +1 -1
- package/src/funcs/collectionsListEvents.ts +1 -1
- package/src/funcs/collectionsSearch.ts +1 -1
- package/src/funcs/collectionsUpdate.ts +1 -1
- package/src/funcs/globalDataAggregate.ts +1 -1
- package/src/funcs/globalDataCreateTrackedScan.ts +1 -1
- package/src/funcs/globalDataGetCertificate.ts +4 -2
- package/src/funcs/globalDataGetCertificateRaw.ts +1 -1
- package/src/funcs/globalDataGetCertificates.ts +1 -1
- package/src/funcs/globalDataGetCertificatesRaw.ts +1 -1
- package/src/funcs/globalDataGetHost.ts +4 -2
- package/src/funcs/globalDataGetHostEnrichment.ts +4 -2
- package/src/funcs/globalDataGetHostTimeline.ts +1 -1
- package/src/funcs/globalDataGetHosts.ts +1 -1
- package/src/funcs/globalDataGetTrackedScan.ts +1 -1
- package/src/funcs/globalDataGetWebProperties.ts +1 -1
- package/src/funcs/globalDataGetWebProperty.ts +3 -1
- package/src/funcs/globalDataListDnsIpResolutionBounds.ts +1 -1
- package/src/funcs/globalDataListDnsIpResolutionRanges.ts +1 -1
- package/src/funcs/globalDataListDnsNameResolutionBounds.ts +1 -1
- package/src/funcs/globalDataListDnsNameResolutionRanges.ts +1 -1
- package/src/funcs/globalDataListServicesOnHost.ts +1 -1
- package/src/funcs/globalDataSearch.ts +1 -1
- package/src/funcs/tagsAndCommentsUpdateTag.ts +1 -1
- package/src/funcs/threatHuntingCreateCenseyeJob.ts +1 -1
- package/src/funcs/threatHuntingCreateInvestigationFileUpload.ts +1 -1
- package/src/funcs/threatHuntingCreateInvestigationJob.ts +1 -1
- package/src/funcs/threatHuntingCreateTrackedScan.ts +1 -1
- package/src/funcs/threatHuntingGetCenseyeJobResults.ts +1 -1
- package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +1 -1
- package/src/funcs/threatHuntingGetTrackedScanThreatHunting.ts +1 -1
- package/src/funcs/threatHuntingListThreats.ts +1 -1
- package/src/funcs/threatHuntingValueCounts.ts +1 -1
- package/src/lib/config.ts +4 -4
- package/src/models/components/collection.ts +25 -1
- package/src/models/components/crudcreateinputbody.ts +26 -0
- package/src/models/components/crudupdateinputbody.ts +26 -0
- package/src/models/components/http.ts +9 -0
- package/src/models/components/httpcopyright.ts +39 -0
- package/src/models/components/index.ts +1 -0
- package/src/models/operations/v3globaldataassetcertificate.ts +13 -0
- package/src/models/operations/v3globaldataassethost.ts +13 -0
- package/src/models/operations/v3globaldataassethostenrichment.ts +13 -0
- package/src/models/operations/v3globaldataassetwebproperty.ts +13 -0
- package/src/sdk/adversaryinvestigation.ts +8 -8
- package/src/sdk/collections.ts +6 -6
- package/src/sdk/globaldata.ts +19 -19
- package/src/sdk/tagsandcomments.ts +1 -1
- package/src/sdk/threathunting.ts +9 -9
|
@@ -22,7 +22,7 @@ Endpoints related to the Adversary Investigation product
|
|
|
22
22
|
|
|
23
23
|
## createCenseyeJob
|
|
24
24
|
|
|
25
|
-
Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
|
|
25
|
+
Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>Use this endpoint to start an analysis of a suspicious host, web property, or certificate that finds the rare attributes it shares with other assets, so you can uncover related attacker infrastructure.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
|
|
26
26
|
|
|
27
27
|
### Example Usage
|
|
28
28
|
|
|
@@ -190,7 +190,7 @@ run();
|
|
|
190
190
|
|
|
191
191
|
## getCenseyeJobResults
|
|
192
192
|
|
|
193
|
-
Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
|
|
193
|
+
Retrieve the results of a completed CensEye pivot analysis job. Use this endpoint to retrieve the pivots from a finished job, then turn the most distinctive ones into searches or blocklist candidates.<br><br>Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
|
|
194
194
|
|
|
195
195
|
### Example Usage
|
|
196
196
|
|
|
@@ -268,7 +268,7 @@ run();
|
|
|
268
268
|
|
|
269
269
|
## getHostObservationsWithCertificate
|
|
270
270
|
|
|
271
|
-
Retrieve the historical observations of hosts associated with a certificate.
|
|
271
|
+
Retrieve the historical observations of hosts associated with a certificate. Use this endpoint to see every host that has presented a given certificate over time, so you can build a timeline and find other infrastructure using it.<br><br>Certificate history is also visible to Adversary Investigation users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>For workspaces with a history limit, the API returns observation ranges that overlap the allowed history window. The window starts at 00:00 UTC the allowed number of days ago and ends at the time of the request. Ranges are returned in full, with their original start and end times, even if they extend outside the window.<br><br>You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. This endpoint costs one credit per page of results.
|
|
272
272
|
|
|
273
273
|
### Example Usage
|
|
274
274
|
|
|
@@ -356,7 +356,7 @@ run();
|
|
|
356
356
|
|
|
357
357
|
## createInvestigationFileUpload
|
|
358
358
|
|
|
359
|
-
Prepare to attach an evidence file to an investigation. This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
|
|
359
|
+
Prepare to attach an evidence file to an investigation. Use this endpoint to stage evidence, such as logs, malware reports, or alert exports, so an AI investigation can use it.<br><br>This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
|
|
360
360
|
|
|
361
361
|
### Example Usage
|
|
362
362
|
|
|
@@ -516,7 +516,7 @@ run();
|
|
|
516
516
|
|
|
517
517
|
## createInvestigationJob
|
|
518
518
|
|
|
519
|
-
Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both
|
|
519
|
+
Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both to obtain a report on suspect infrastructure without doing the pivots by hand.<br><br>Supply at least one `indicators` or `file_ids`. To use files, upload them first with the [create file upload endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-files-create).<br><br>This endpoint returns a `job_id` that you can poll to retrieve its status and results.<br><br>Provide `start_time` and `end_time` to scope the investigation to a time frame, or `start_time` alone to scope it from that time up to now. Omit both to investigate current data.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
|
|
520
520
|
|
|
521
521
|
### Example Usage
|
|
522
522
|
|
|
@@ -844,7 +844,7 @@ run();
|
|
|
844
844
|
|
|
845
845
|
## createTrackedScan
|
|
846
846
|
|
|
847
|
-
Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
|
|
847
|
+
Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>Use this endpoint to scan for a service at an `ip:port` or `hostname:port`, such as a new IOC from an incident, so you can get data on it right away.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
|
|
848
848
|
|
|
849
849
|
### Example Usage
|
|
850
850
|
|
|
@@ -936,7 +936,7 @@ run();
|
|
|
936
936
|
|
|
937
937
|
## listThreats
|
|
938
938
|
|
|
939
|
-
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module.
|
|
939
|
+
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Use this endpoint to see currently active threats so you can prioritize which malicious infrastructure to hunt or block first.<br><br>Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module.
|
|
940
940
|
|
|
941
941
|
### Example Usage
|
|
942
942
|
|
|
@@ -1014,7 +1014,7 @@ run();
|
|
|
1014
1014
|
|
|
1015
1015
|
## valueCounts
|
|
1016
1016
|
|
|
1017
|
-
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 and may contain at most 5 field-value pairs. 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 Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
|
|
1017
|
+
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 and may contain at most 5 field-value pairs. 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>Use this endpoint to see how many assets share a given field value, so you can tell which attributes are rare enough to pivot on and which are too common to be useful.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
|
|
1018
1018
|
|
|
1019
1019
|
### Example Usage
|
|
1020
1020
|
|
|
@@ -105,7 +105,7 @@ run();
|
|
|
105
105
|
|
|
106
106
|
## create
|
|
107
107
|
|
|
108
|
-
Create a new collection.<br><br>This endpoint does not cost credits to execute.
|
|
108
|
+
Create a new [collection](https://docs.censys.com/docs/platform-collections).<br><br>In a SOC environment, use this endpoint to save a query as a dynamic asset group, such as all internet-facing RDP hosts or a threat's footprint, so SOC monitoring and reporting stay scoped as assets change.<br><br>This endpoint does not cost credits to execute.
|
|
109
109
|
|
|
110
110
|
### Example Usage
|
|
111
111
|
|
|
@@ -269,7 +269,7 @@ run();
|
|
|
269
269
|
|
|
270
270
|
## get
|
|
271
271
|
|
|
272
|
-
Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
272
|
+
Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count. Use it to confirm it still reflects the scope you intend to monitor.<br><br>This endpoint does not cost credits to execute.
|
|
273
273
|
|
|
274
274
|
### Example Usage
|
|
275
275
|
|
|
@@ -347,7 +347,7 @@ run();
|
|
|
347
347
|
|
|
348
348
|
## update
|
|
349
349
|
|
|
350
|
-
Update a collection's name, description, and/or
|
|
350
|
+
Update a collection's name, description, query, and/or privacy.<br><br>This endpoint does not cost credits to execute.
|
|
351
351
|
|
|
352
352
|
### Example Usage
|
|
353
353
|
|
|
@@ -435,7 +435,7 @@ run();
|
|
|
435
435
|
|
|
436
436
|
## listEvents
|
|
437
437
|
|
|
438
|
-
Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>This endpoint does not cost credits to execute.
|
|
438
|
+
Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>In a SOC environment, use this endpoint to see which assets were added or removed and when, to catch new exposure or unexpected changes in a monitored scope.<br><br>This endpoint does not cost credits to execute.
|
|
439
439
|
|
|
440
440
|
### Example Usage
|
|
441
441
|
|
|
@@ -521,7 +521,7 @@ run();
|
|
|
521
521
|
|
|
522
522
|
## aggregate
|
|
523
523
|
|
|
524
|
-
Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
|
|
524
|
+
Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.<br><br>In a SOC environment, use this endpoint to count and bucket matches by field, such as port, country, or software, inside a collection so you can spot exposure trends without pulling every asset.
|
|
525
525
|
|
|
526
526
|
### Example Usage
|
|
527
527
|
|
|
@@ -609,7 +609,7 @@ run();
|
|
|
609
609
|
|
|
610
610
|
## search
|
|
611
611
|
|
|
612
|
-
Run a search query across a collection's assets. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax. Host services that match your search criteria will be returned in a `matched_services` object.
|
|
612
|
+
Run a search query across a collection's assets. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax. Host services that match your search criteria will be returned in a `matched_services` object.<br><br>In a SOC environment, use this endpoint to search only within the defined scope of a collection, so triage and hunting results stay relevant instead of covering the whole internet.
|
|
613
613
|
|
|
614
614
|
### Example Usage
|
|
615
615
|
|
|
@@ -30,7 +30,7 @@ Endpoints related to the Global Data product
|
|
|
30
30
|
|
|
31
31
|
## getCertificates
|
|
32
32
|
|
|
33
|
-
Retrieve information about multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint
|
|
33
|
+
Retrieve information about multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint.<br><br>In a SOC environment, use this endpoint to bulk-check multiple certificates from network telemetry for self-signed, newly issued, or lookalike certs.
|
|
34
34
|
|
|
35
35
|
### Example Usage
|
|
36
36
|
|
|
@@ -116,7 +116,7 @@ run();
|
|
|
116
116
|
|
|
117
117
|
## getCertificatesRaw
|
|
118
118
|
|
|
119
|
-
Retrieve the raw PEM-encoded format for multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint
|
|
119
|
+
Retrieve the raw PEM-encoded format for multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint.<br><br>Use this endpoint to export raw PEMs for multiple certificates at once, for bulk analysis or sharing with your detection pipeline.
|
|
120
120
|
|
|
121
121
|
### Example Usage
|
|
122
122
|
|
|
@@ -202,7 +202,7 @@ run();
|
|
|
202
202
|
|
|
203
203
|
## getCertificate
|
|
204
204
|
|
|
205
|
-
Retrieve information about a single certificate. A certificate ID is its SHA-256 fingerprint in
|
|
205
|
+
Retrieve information about a single certificate. A certificate ID is its SHA-256 fingerprint.<br><br>In a SOC environment, use this endpoint to look up a certificate by SHA-256 fingerprint to see its subject, issuer, and validity, so you can vet certs seen in TLS logs or alerts.
|
|
206
206
|
|
|
207
207
|
### Example Usage
|
|
208
208
|
|
|
@@ -218,6 +218,8 @@ const sdk = new SDK({
|
|
|
218
218
|
async function run() {
|
|
219
219
|
const result = await sdk.globalData.getCertificate({
|
|
220
220
|
certificateId: "3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf",
|
|
221
|
+
fields: "fingerprint_sha256,parsed.subject_dn",
|
|
222
|
+
excludeFields: "names,fingerprint_sha1",
|
|
221
223
|
});
|
|
222
224
|
|
|
223
225
|
console.log(result);
|
|
@@ -244,6 +246,8 @@ const sdk = new SDKCore({
|
|
|
244
246
|
async function run() {
|
|
245
247
|
const res = await globalDataGetCertificate(sdk, {
|
|
246
248
|
certificateId: "3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf",
|
|
249
|
+
fields: "fingerprint_sha256,parsed.subject_dn",
|
|
250
|
+
excludeFields: "names,fingerprint_sha1",
|
|
247
251
|
});
|
|
248
252
|
if (res.ok) {
|
|
249
253
|
const { value: result } = res;
|
|
@@ -274,13 +278,13 @@ run();
|
|
|
274
278
|
| Error Type | Status Code | Content Type |
|
|
275
279
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
276
280
|
| errors.AuthenticationError | 401 | application/json |
|
|
277
|
-
| errors.ErrorModel | 400, 403, 404
|
|
281
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
278
282
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
279
283
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
280
284
|
|
|
281
285
|
## getCertificateRaw
|
|
282
286
|
|
|
283
|
-
Retrieve the raw PEM-encoded format of a certificate. A certificate ID is its SHA-256 fingerprint
|
|
287
|
+
Retrieve the raw PEM-encoded format of a certificate. A certificate ID is its SHA-256 fingerprint.<br><br>Use this endpoint to retrieve the raw PEM of a suspicious certificate for offline analysis or to feed other tooling.
|
|
284
288
|
|
|
285
289
|
### Example Usage
|
|
286
290
|
|
|
@@ -358,7 +362,7 @@ run();
|
|
|
358
362
|
|
|
359
363
|
## getHostEnrichment
|
|
360
364
|
|
|
361
|
-
Retrieve enrichment data for a single host. This endpoint is optimized for high-volume SOC enrichment use cases.<br><br>This endpoint does not consume standard Censys credits. Core organizations may perform up to 20,000 enrichment calls per day. Core + Unlimited Enrichment organizations may perform an unlimited amount of enrichment calls per day.<br><br>[Learn more about the enrichment API here](https://docs.censys.com/docs/host-enrichment).
|
|
365
|
+
Retrieve enrichment data for a single host. This endpoint is optimized for high-volume SOC enrichment use cases.<br><br>Use this endpoint to add Censys context (location, ASN, labels, reputation, and more) to IPs in your SIEM or SOAR at high volume, without spending standard credits.<br><br>This endpoint does not consume standard Censys credits. Core organizations may perform up to 20,000 enrichment calls per day. Core + Unlimited Enrichment organizations may perform an unlimited amount of enrichment calls per day.<br><br>[Learn more about the enrichment API here](https://docs.censys.com/docs/host-enrichment).
|
|
362
366
|
|
|
363
367
|
### Example Usage
|
|
364
368
|
|
|
@@ -374,6 +378,8 @@ const sdk = new SDK({
|
|
|
374
378
|
async function run() {
|
|
375
379
|
const result = await sdk.globalData.getHostEnrichment({
|
|
376
380
|
hostIp: "8.8.8.8",
|
|
381
|
+
fields: "ip,greynoise.classification,third_party.mallory",
|
|
382
|
+
excludeFields: "whois,services",
|
|
377
383
|
});
|
|
378
384
|
|
|
379
385
|
console.log(result);
|
|
@@ -400,6 +406,8 @@ const sdk = new SDKCore({
|
|
|
400
406
|
async function run() {
|
|
401
407
|
const res = await globalDataGetHostEnrichment(sdk, {
|
|
402
408
|
hostIp: "8.8.8.8",
|
|
409
|
+
fields: "ip,greynoise.classification,third_party.mallory",
|
|
410
|
+
excludeFields: "whois,services",
|
|
403
411
|
});
|
|
404
412
|
if (res.ok) {
|
|
405
413
|
const { value: result } = res;
|
|
@@ -430,14 +438,14 @@ run();
|
|
|
430
438
|
| Error Type | Status Code | Content Type |
|
|
431
439
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
432
440
|
| errors.AuthenticationError | 401 | application/json |
|
|
433
|
-
| errors.ErrorModel | 400, 403, 404, 409
|
|
441
|
+
| errors.ErrorModel | 400, 403, 404, 409, 422 | application/problem+json |
|
|
434
442
|
| errors.ErrorModel | 429 | application/problem+json |
|
|
435
443
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
436
444
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
437
445
|
|
|
438
446
|
## getHosts
|
|
439
447
|
|
|
440
|
-
Retrieve information about multiple hosts. You can retrieve up to 100 hosts per call. A host ID is its IP address.
|
|
448
|
+
Retrieve information about multiple hosts. You can retrieve up to 100 hosts per call. A host ID is its IP address.<br><br>In a SOC environment, use this endpoint to look up multiple IPs from an alert, log, or threat feed in one call, so you can triage a whole indicator list quickly.
|
|
441
449
|
|
|
442
450
|
### Example Usage
|
|
443
451
|
|
|
@@ -525,7 +533,7 @@ run();
|
|
|
525
533
|
|
|
526
534
|
## getHost
|
|
527
535
|
|
|
528
|
-
Retrieve information about a single host. A host ID is its IP address.
|
|
536
|
+
Retrieve information about a single host. A host ID is its IP address.<br><br>In a SOC environment, use this endpoint to pull the current services, software, certificates, and labels on an IP from an alert, so you can quickly judge whether it is malicious or benign.
|
|
529
537
|
|
|
530
538
|
### Example Usage
|
|
531
539
|
|
|
@@ -542,6 +550,8 @@ async function run() {
|
|
|
542
550
|
const result = await sdk.globalData.getHost({
|
|
543
551
|
hostId: "8.8.8.8",
|
|
544
552
|
atTime: new Date("2025-01-01T00:00:00Z"),
|
|
553
|
+
fields: "ip,services.port,services.protocol",
|
|
554
|
+
excludeFields: "services.banner,services.cert",
|
|
545
555
|
});
|
|
546
556
|
|
|
547
557
|
console.log(result);
|
|
@@ -569,6 +579,8 @@ async function run() {
|
|
|
569
579
|
const res = await globalDataGetHost(sdk, {
|
|
570
580
|
hostId: "8.8.8.8",
|
|
571
581
|
atTime: new Date("2025-01-01T00:00:00Z"),
|
|
582
|
+
fields: "ip,services.port,services.protocol",
|
|
583
|
+
excludeFields: "services.banner,services.cert",
|
|
572
584
|
});
|
|
573
585
|
if (res.ok) {
|
|
574
586
|
const { value: result } = res;
|
|
@@ -599,13 +611,13 @@ run();
|
|
|
599
611
|
| Error Type | Status Code | Content Type |
|
|
600
612
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
601
613
|
| errors.AuthenticationError | 401 | application/json |
|
|
602
|
-
| errors.ErrorModel | 400, 403, 404
|
|
614
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
603
615
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
604
616
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
605
617
|
|
|
606
618
|
## listServicesOnHost
|
|
607
619
|
|
|
608
|
-
Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>You can filter by port number, protocol, and transport protocol.
|
|
620
|
+
Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>You can filter by port number, protocol, and transport protocol.<br><br>In a SOC environment, use this endpoint to see when a specific service was exposed on an IP, so you can check whether it was live during the window of a suspected incident.
|
|
609
621
|
|
|
610
622
|
### Example Usage
|
|
611
623
|
|
|
@@ -695,7 +707,7 @@ run();
|
|
|
695
707
|
|
|
696
708
|
## getHostTimeline
|
|
697
709
|
|
|
698
|
-
Retrieve event history for a host. A host ID is its IP address.<br><br>Note that when a service protocol changes after a new scan (for example, from `UNKNOWN` to `NETBIOS`), this information will be reflected in the `scan` object.
|
|
710
|
+
Retrieve event history for a host. A host ID is its IP address.<br><br>Note that when a service protocol changes after a new scan (for example, from `UNKNOWN` to `NETBIOS`), this information will be reflected in the `scan` object.<br><br>In a SOC environment, use this endpoint to see what changed on an IP over time, such as new services, certificate swaps, and software changes, to reconstruct when attacker infrastructure was stood up or modified.
|
|
699
711
|
|
|
700
712
|
### Example Usage
|
|
701
713
|
|
|
@@ -777,7 +789,7 @@ run();
|
|
|
777
789
|
|
|
778
790
|
## getWebProperties
|
|
779
791
|
|
|
780
|
-
Retrieve information about multiple web properties. You can retrieve up to 100 web properties per call. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80
|
|
792
|
+
Retrieve information about multiple web properties. You can retrieve up to 100 web properties per call. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`.<br><br>In a SOC environment, use this endpoint to check up to 100 suspicious hostnames at once, such as domains from phishing reports or proxy logs, to find the live and malicious ones.
|
|
781
793
|
|
|
782
794
|
### Example Usage
|
|
783
795
|
|
|
@@ -865,7 +877,7 @@ run();
|
|
|
865
877
|
|
|
866
878
|
## getWebProperty
|
|
867
879
|
|
|
868
|
-
Retrieve information about a single web property. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80
|
|
880
|
+
Retrieve information about a single web property. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`.<br><br>In a SOC environment, use this endpoint to inspect the current content, technologies, and certificate for a hostname and port from a phishing or C2 alert.
|
|
869
881
|
|
|
870
882
|
### Example Usage
|
|
871
883
|
|
|
@@ -882,6 +894,8 @@ async function run() {
|
|
|
882
894
|
const result = await sdk.globalData.getWebProperty({
|
|
883
895
|
webpropertyId: "platform.censys.io:80",
|
|
884
896
|
atTime: new Date("2025-01-01T00:00:00Z"),
|
|
897
|
+
fields: "hostname,port,tls.cipher_selected",
|
|
898
|
+
excludeFields: "cert,endpoints.http.body",
|
|
885
899
|
});
|
|
886
900
|
|
|
887
901
|
console.log(result);
|
|
@@ -909,6 +923,8 @@ async function run() {
|
|
|
909
923
|
const res = await globalDataGetWebProperty(sdk, {
|
|
910
924
|
webpropertyId: "platform.censys.io:80",
|
|
911
925
|
atTime: new Date("2025-01-01T00:00:00Z"),
|
|
926
|
+
fields: "hostname,port,tls.cipher_selected",
|
|
927
|
+
excludeFields: "cert,endpoints.http.body",
|
|
912
928
|
});
|
|
913
929
|
if (res.ok) {
|
|
914
930
|
const { value: result } = res;
|
|
@@ -1027,7 +1043,7 @@ run();
|
|
|
1027
1043
|
|
|
1028
1044
|
## listDnsIpResolutionBounds
|
|
1029
1045
|
|
|
1030
|
-
Retrieve the domain names that resolved to an IP during a time frame. You can narrow results with `record_types` (A or AAAA).<br><br>Results are aggregated per domain name and multiple distinct ranges for a name will be grouped into one row of results. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will group those ranges into one entry for `censys.com` in the response.<br><br>To retrieve domain names for an IP with each record broken down by time range, use the [ranges endpoint](https://docs.censys.com/reference/v3-globaldata-dns-ip-resolution-ranges)<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1046
|
+
Retrieve the domain names that resolved to an IP during a time frame. You can narrow results with `record_types` (A or AAAA).<br><br>Results are aggregated per domain name and multiple distinct ranges for a name will be grouped into one row of results. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will group those ranges into one entry for `censys.com` in the response.<br><br>To retrieve domain names for an IP with each record broken down by time range, use the [ranges endpoint](https://docs.censys.com/reference/v3-globaldata-dns-ip-resolution-ranges)<br><br>In a SOC environment, use this endpoint to find every domain that has pointed at a malicious IP, with first- and last-seen bounds per name, so you can discover related domains and block them.<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1031
1047
|
|
|
1032
1048
|
### Example Usage
|
|
1033
1049
|
|
|
@@ -1117,7 +1133,7 @@ run();
|
|
|
1117
1133
|
|
|
1118
1134
|
## listDnsIpResolutionRanges
|
|
1119
1135
|
|
|
1120
|
-
Retrieve the domain names that resolved to an IP during a time frame. You can narrow results with `record_types` (A or AAAA).<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges.<br><br>To retrieve domain names for an IP with each result aggregated by name, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-ip-resolution-bound).<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1136
|
+
Retrieve the domain names that resolved to an IP during a time frame. You can narrow results with `record_types` (A or AAAA).<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges.<br><br>To retrieve domain names for an IP with each result aggregated by name, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-ip-resolution-bound).<br><br>In a SOC environment, use this endpoint to see the exact time ranges a domain resolved to an IP, to confirm it was active during the incident window or to spot infrastructure reuse.<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1121
1137
|
|
|
1122
1138
|
### Example Usage
|
|
1123
1139
|
|
|
@@ -1209,7 +1225,7 @@ run();
|
|
|
1209
1225
|
|
|
1210
1226
|
## listDnsNameResolutionBounds
|
|
1211
1227
|
|
|
1212
|
-
Retrieve the DNS resolution records for a name. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using record_types.<br><br>Results are aggregated per record distinct ranges for a record will be grouped into one row of results. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will group those ranges into one entry for the `1.1.1.1` A record in the response.<br><br>To retrieve records for a name with each record broken down by time range, use the [ranges endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-ranges).<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1228
|
+
Retrieve the DNS resolution records for a name. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using record_types.<br><br>Results are aggregated per record distinct ranges for a record will be grouped into one row of results. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will group those ranges into one entry for the `1.1.1.1` A record in the response.<br><br>To retrieve records for a name with each record broken down by time range, use the [ranges endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-ranges).<br><br>In a SOC environment, use this endpoint to see the A, AAAA, MX, NS, SOA, and TXT records observed for a suspicious domain, to pivot to its hosting and mail infrastructure.<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1213
1229
|
|
|
1214
1230
|
### Example Usage
|
|
1215
1231
|
|
|
@@ -1299,7 +1315,7 @@ run();
|
|
|
1299
1315
|
|
|
1300
1316
|
## listDnsNameResolutionRanges
|
|
1301
1317
|
|
|
1302
|
-
Retrieve the records that resolved for a name during a time frame. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges for the `1.1.1.1` A record.<br><br>To retrieve records for a name with each result aggregated per record, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-bound).<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1318
|
+
Retrieve the records that resolved for a name during a time frame. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges for the `1.1.1.1` A record.<br><br>To retrieve records for a name with each result aggregated per record, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-bound).<br><br>In a SOC environment, use this endpoint to see when a domain's records changed over time, such as a sudden hosting move after takedown.<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
|
|
1303
1319
|
|
|
1304
1320
|
### Example Usage
|
|
1305
1321
|
|
|
@@ -1389,7 +1405,7 @@ run();
|
|
|
1389
1405
|
|
|
1390
1406
|
## createTrackedScan
|
|
1391
1407
|
|
|
1392
|
-
Initiate a rescan for a known host service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Rescan](https://docs.censys.com/docs/platform-live-rescan#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-globaldata-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. It costs 10 credits to execute.
|
|
1408
|
+
Initiate a rescan for a known host service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Rescan](https://docs.censys.com/docs/platform-live-rescan#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-globaldata-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>In a SOC environment, rescan to ensure triage, an investigation, or a hunt has the most accurate and current state. This includes information like whether C2 servers are still operational, or whether an organization's asset is still exposed to the internet.<br><br>This endpoint is available to all Enterprise customers. It costs 10 credits to execute.
|
|
1393
1409
|
|
|
1394
1410
|
### Example Usage
|
|
1395
1411
|
|
|
@@ -1481,7 +1497,7 @@ run();
|
|
|
1481
1497
|
|
|
1482
1498
|
## getTrackedScan
|
|
1483
1499
|
|
|
1484
|
-
Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all
|
|
1500
|
+
Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>Use this endpoint to check whether a Live Discovery or Live Rescan scan has finished, so automation knows when fresh data is ready to pull.<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all enterprise customers. This endpoint does not cost any credits to execute.
|
|
1485
1501
|
|
|
1486
1502
|
### Example Usage
|
|
1487
1503
|
|
|
@@ -1559,7 +1575,7 @@ run();
|
|
|
1559
1575
|
|
|
1560
1576
|
## aggregate
|
|
1561
1577
|
|
|
1562
|
-
Aggregate results for a Platform search query. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
|
|
1578
|
+
Aggregate results for a Platform search query. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.<br><br>In a SOC environment, use this endpoint to count and bucket matches by field, such as country, ASN, or port, to size a campaign or spot where malicious infrastructure clusters without pulling every record.
|
|
1563
1579
|
|
|
1564
1580
|
### Example Usage
|
|
1565
1581
|
|
|
@@ -1735,7 +1751,7 @@ run();
|
|
|
1735
1751
|
|
|
1736
1752
|
## search
|
|
1737
1753
|
|
|
1738
|
-
Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax
|
|
1754
|
+
Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax.<br><br>Host services that match your search criteria will be returned in a `matched_services` object.<br><br>In a SOC environment, use this endpoint to hunt for hosts, web properties, or certificates that match an indicator, such as a C2 banner, JARM, or favicon hash to scope infrastructure tied to an alert.
|
|
1739
1755
|
|
|
1740
1756
|
### Example Usage
|
|
1741
1757
|
|
|
@@ -660,7 +660,7 @@ run();
|
|
|
660
660
|
|
|
661
661
|
## updateTag
|
|
662
662
|
|
|
663
|
-
Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member
|
|
663
|
+
Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member. A `shared` tag cannot be made `private`.<br><br>This endpoint does not cost any credits to execute.
|
|
664
664
|
|
|
665
665
|
### Example Usage
|
|
666
666
|
|
|
@@ -106,7 +106,7 @@ run();
|
|
|
106
106
|
|
|
107
107
|
## createCenseyeJob
|
|
108
108
|
|
|
109
|
-
Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
|
|
109
|
+
Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>Use this endpoint to start an analysis of a suspicious host, web property, or certificate that finds the rare attributes it shares with other assets, so you can uncover related attacker infrastructure.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
|
|
110
110
|
|
|
111
111
|
### Example Usage
|
|
112
112
|
|
|
@@ -274,7 +274,7 @@ run();
|
|
|
274
274
|
|
|
275
275
|
## getCenseyeJobResults
|
|
276
276
|
|
|
277
|
-
Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
|
|
277
|
+
Retrieve the results of a completed CensEye pivot analysis job. Use this endpoint to retrieve the pivots from a finished job, then turn the most distinctive ones into searches or blocklist candidates.<br><br>Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
|
|
278
278
|
|
|
279
279
|
### Example Usage
|
|
280
280
|
|
|
@@ -352,7 +352,7 @@ run();
|
|
|
352
352
|
|
|
353
353
|
## getHostObservationsWithCertificate
|
|
354
354
|
|
|
355
|
-
Retrieve the historical observations of hosts associated with a certificate.
|
|
355
|
+
Retrieve the historical observations of hosts associated with a certificate. Use this endpoint to see every host that has presented a given certificate over time, so you can build a timeline and find other infrastructure using it.<br><br>Certificate history is also visible to Adversary Investigation users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>For workspaces with a history limit, the API returns observation ranges that overlap the allowed history window. The window starts at 00:00 UTC the allowed number of days ago and ends at the time of the request. Ranges are returned in full, with their original start and end times, even if they extend outside the window.<br><br>You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. This endpoint costs one credit per page of results.
|
|
356
356
|
|
|
357
357
|
### Example Usage
|
|
358
358
|
|
|
@@ -440,7 +440,7 @@ run();
|
|
|
440
440
|
|
|
441
441
|
## createInvestigationFileUpload
|
|
442
442
|
|
|
443
|
-
Prepare to attach an evidence file to an investigation. This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
|
|
443
|
+
Prepare to attach an evidence file to an investigation. Use this endpoint to stage evidence, such as logs, malware reports, or alert exports, so an AI investigation can use it.<br><br>This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
|
|
444
444
|
|
|
445
445
|
### Example Usage
|
|
446
446
|
|
|
@@ -600,7 +600,7 @@ run();
|
|
|
600
600
|
|
|
601
601
|
## createInvestigationJob
|
|
602
602
|
|
|
603
|
-
Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both
|
|
603
|
+
Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both to obtain a report on suspect infrastructure without doing the pivots by hand.<br><br>Supply at least one `indicators` or `file_ids`. To use files, upload them first with the [create file upload endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-files-create).<br><br>This endpoint returns a `job_id` that you can poll to retrieve its status and results.<br><br>Provide `start_time` and `end_time` to scope the investigation to a time frame, or `start_time` alone to scope it from that time up to now. Omit both to investigate current data.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
|
|
604
604
|
|
|
605
605
|
### Example Usage
|
|
606
606
|
|
|
@@ -928,7 +928,7 @@ run();
|
|
|
928
928
|
|
|
929
929
|
## createTrackedScan
|
|
930
930
|
|
|
931
|
-
Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
|
|
931
|
+
Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>Use this endpoint to scan for a service at an `ip:port` or `hostname:port`, such as a new IOC from an incident, so you can get data on it right away.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
|
|
932
932
|
|
|
933
933
|
### Example Usage
|
|
934
934
|
|
|
@@ -1020,7 +1020,7 @@ run();
|
|
|
1020
1020
|
|
|
1021
1021
|
## getTrackedScanThreatHunting
|
|
1022
1022
|
|
|
1023
|
-
Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all
|
|
1023
|
+
Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>Use this endpoint to check whether a Live Discovery or Live Rescan scan has finished, so automation knows when fresh data is ready to pull.<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all enterprise customers. This endpoint does not cost any credits to execute.
|
|
1024
1024
|
|
|
1025
1025
|
### Example Usage
|
|
1026
1026
|
|
|
@@ -1098,7 +1098,7 @@ run();
|
|
|
1098
1098
|
|
|
1099
1099
|
## listThreats
|
|
1100
1100
|
|
|
1101
|
-
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module.
|
|
1101
|
+
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Use this endpoint to see currently active threats so you can prioritize which malicious infrastructure to hunt or block first.<br><br>Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module.
|
|
1102
1102
|
|
|
1103
1103
|
### Example Usage
|
|
1104
1104
|
|
|
@@ -1176,7 +1176,7 @@ run();
|
|
|
1176
1176
|
|
|
1177
1177
|
## valueCounts
|
|
1178
1178
|
|
|
1179
|
-
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 and may contain at most 5 field-value pairs. 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 Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
|
|
1179
|
+
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 and may contain at most 5 field-value pairs. 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>Use this endpoint to see how many assets share a given field value, so you can tell which attributes are rare enough to pivot on and which are too common to be useful.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
|
|
1180
1180
|
|
|
1181
1181
|
### Example Usage
|
|
1182
1182
|
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Aggregate results for a search query within a collection
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
|
|
15
|
+
* Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.<br><br>In a SOC environment, use this endpoint to count and bucket matches by field, such as port, country, or software, inside a collection so you can spot exposure trends without pulling every asset.
|
|
16
16
|
*/
|
|
17
17
|
export declare function collectionsAggregate(client: SDKCore, request: operations.V3CollectionsSearchAggregateRequest, options?: RequestOptions): APIPromise<Result<operations.V3CollectionsSearchAggregateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=collectionsAggregate.d.ts.map
|
|
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
51
51
|
* Aggregate results for a search query within a collection
|
|
52
52
|
*
|
|
53
53
|
* @remarks
|
|
54
|
-
* Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
|
|
54
|
+
* Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.<br><br>In a SOC environment, use this endpoint to count and bucket matches by field, such as port, country, or software, inside a collection so you can spot exposure trends without pulling every asset.
|
|
55
55
|
*/
|
|
56
56
|
function collectionsAggregate(client, request, options) {
|
|
57
57
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Create a collection
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Create a new collection.<br><br>This endpoint does not cost credits to execute.
|
|
15
|
+
* Create a new [collection](https://docs.censys.com/docs/platform-collections).<br><br>In a SOC environment, use this endpoint to save a query as a dynamic asset group, such as all internet-facing RDP hosts or a threat's footprint, so SOC monitoring and reporting stay scoped as assets change.<br><br>This endpoint does not cost credits to execute.
|
|
16
16
|
*/
|
|
17
17
|
export declare function collectionsCreate(client: SDKCore, request: operations.V3CollectionsCrudCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3CollectionsCrudCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=collectionsCreate.d.ts.map
|
|
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
51
51
|
* Create a collection
|
|
52
52
|
*
|
|
53
53
|
* @remarks
|
|
54
|
-
* Create a new collection.<br><br>This endpoint does not cost credits to execute.
|
|
54
|
+
* Create a new [collection](https://docs.censys.com/docs/platform-collections).<br><br>In a SOC environment, use this endpoint to save a query as a dynamic asset group, such as all internet-facing RDP hosts or a threat's footprint, so SOC monitoring and reporting stay scoped as assets change.<br><br>This endpoint does not cost credits to execute.
|
|
55
55
|
*/
|
|
56
56
|
function collectionsCreate(client, request, options) {
|
|
57
57
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Get a collection
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
15
|
+
* Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count. Use it to confirm it still reflects the scope you intend to monitor.<br><br>This endpoint does not cost credits to execute.
|
|
16
16
|
*/
|
|
17
17
|
export declare function collectionsGet(client: SDKCore, request: operations.V3CollectionsCrudGetRequest, options?: RequestOptions): APIPromise<Result<operations.V3CollectionsCrudGetResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=collectionsGet.d.ts.map
|
package/funcs/collectionsGet.js
CHANGED
|
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
51
51
|
* Get a collection
|
|
52
52
|
*
|
|
53
53
|
* @remarks
|
|
54
|
-
* Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
54
|
+
* Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count. Use it to confirm it still reflects the scope you intend to monitor.<br><br>This endpoint does not cost credits to execute.
|
|
55
55
|
*/
|
|
56
56
|
function collectionsGet(client, request, options) {
|
|
57
57
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Get a collection's events
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>This endpoint does not cost credits to execute.
|
|
15
|
+
* Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>In a SOC environment, use this endpoint to see which assets were added or removed and when, to catch new exposure or unexpected changes in a monitored scope.<br><br>This endpoint does not cost credits to execute.
|
|
16
16
|
*/
|
|
17
17
|
export declare function collectionsListEvents(client: SDKCore, request: operations.V3CollectionsListEventsRequest, options?: RequestOptions): APIPromise<Result<operations.V3CollectionsListEventsResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=collectionsListEvents.d.ts.map
|