@censys/platform-sdk 0.12.12 → 0.12.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/docs/sdks/adversaryinvestigation/README.md +8 -8
  2. package/docs/sdks/collections/README.md +5 -5
  3. package/docs/sdks/globaldata/README.md +19 -19
  4. package/docs/sdks/tagsandcomments/README.md +1 -1
  5. package/docs/sdks/threathunting/README.md +9 -9
  6. package/funcs/collectionsAggregate.d.ts +1 -1
  7. package/funcs/collectionsAggregate.js +1 -1
  8. package/funcs/collectionsCreate.d.ts +1 -1
  9. package/funcs/collectionsCreate.js +1 -1
  10. package/funcs/collectionsGet.d.ts +1 -1
  11. package/funcs/collectionsGet.js +1 -1
  12. package/funcs/collectionsListEvents.d.ts +1 -1
  13. package/funcs/collectionsListEvents.js +1 -1
  14. package/funcs/collectionsSearch.d.ts +1 -1
  15. package/funcs/collectionsSearch.js +1 -1
  16. package/funcs/globalDataAggregate.d.ts +1 -1
  17. package/funcs/globalDataAggregate.js +1 -1
  18. package/funcs/globalDataCreateTrackedScan.d.ts +1 -1
  19. package/funcs/globalDataCreateTrackedScan.js +1 -1
  20. package/funcs/globalDataGetCertificate.d.ts +1 -1
  21. package/funcs/globalDataGetCertificate.js +1 -1
  22. package/funcs/globalDataGetCertificateRaw.d.ts +1 -1
  23. package/funcs/globalDataGetCertificateRaw.js +1 -1
  24. package/funcs/globalDataGetCertificates.d.ts +1 -1
  25. package/funcs/globalDataGetCertificates.js +1 -1
  26. package/funcs/globalDataGetCertificatesRaw.d.ts +1 -1
  27. package/funcs/globalDataGetCertificatesRaw.js +1 -1
  28. package/funcs/globalDataGetHost.d.ts +1 -1
  29. package/funcs/globalDataGetHost.js +1 -1
  30. package/funcs/globalDataGetHostEnrichment.d.ts +1 -1
  31. package/funcs/globalDataGetHostEnrichment.js +1 -1
  32. package/funcs/globalDataGetHostTimeline.d.ts +1 -1
  33. package/funcs/globalDataGetHostTimeline.js +1 -1
  34. package/funcs/globalDataGetHosts.d.ts +1 -1
  35. package/funcs/globalDataGetHosts.js +1 -1
  36. package/funcs/globalDataGetTrackedScan.d.ts +1 -1
  37. package/funcs/globalDataGetTrackedScan.js +1 -1
  38. package/funcs/globalDataGetWebProperties.d.ts +1 -1
  39. package/funcs/globalDataGetWebProperties.js +1 -1
  40. package/funcs/globalDataGetWebProperty.d.ts +1 -1
  41. package/funcs/globalDataGetWebProperty.js +1 -1
  42. package/funcs/globalDataListDnsIpResolutionBounds.d.ts +1 -1
  43. package/funcs/globalDataListDnsIpResolutionBounds.js +1 -1
  44. package/funcs/globalDataListDnsIpResolutionRanges.d.ts +1 -1
  45. package/funcs/globalDataListDnsIpResolutionRanges.js +1 -1
  46. package/funcs/globalDataListDnsNameResolutionBounds.d.ts +1 -1
  47. package/funcs/globalDataListDnsNameResolutionBounds.js +1 -1
  48. package/funcs/globalDataListDnsNameResolutionRanges.d.ts +1 -1
  49. package/funcs/globalDataListDnsNameResolutionRanges.js +1 -1
  50. package/funcs/globalDataListServicesOnHost.d.ts +1 -1
  51. package/funcs/globalDataListServicesOnHost.js +1 -1
  52. package/funcs/globalDataSearch.d.ts +1 -1
  53. package/funcs/globalDataSearch.js +1 -1
  54. package/funcs/tagsAndCommentsUpdateTag.d.ts +1 -1
  55. package/funcs/tagsAndCommentsUpdateTag.js +1 -1
  56. package/funcs/threatHuntingCreateCenseyeJob.d.ts +1 -1
  57. package/funcs/threatHuntingCreateCenseyeJob.js +1 -1
  58. package/funcs/threatHuntingCreateInvestigationFileUpload.d.ts +1 -1
  59. package/funcs/threatHuntingCreateInvestigationFileUpload.js +1 -1
  60. package/funcs/threatHuntingCreateInvestigationJob.d.ts +1 -1
  61. package/funcs/threatHuntingCreateInvestigationJob.js +1 -1
  62. package/funcs/threatHuntingCreateTrackedScan.d.ts +1 -1
  63. package/funcs/threatHuntingCreateTrackedScan.js +1 -1
  64. package/funcs/threatHuntingGetCenseyeJobResults.d.ts +1 -1
  65. package/funcs/threatHuntingGetCenseyeJobResults.js +1 -1
  66. package/funcs/threatHuntingGetHostObservationsWithCertificate.d.ts +1 -1
  67. package/funcs/threatHuntingGetHostObservationsWithCertificate.js +1 -1
  68. package/funcs/threatHuntingGetTrackedScanThreatHunting.d.ts +1 -1
  69. package/funcs/threatHuntingGetTrackedScanThreatHunting.js +1 -1
  70. package/funcs/threatHuntingListThreats.d.ts +1 -1
  71. package/funcs/threatHuntingListThreats.js +1 -1
  72. package/funcs/threatHuntingValueCounts.d.ts +1 -1
  73. package/funcs/threatHuntingValueCounts.js +1 -1
  74. package/jsr.json +1 -1
  75. package/lib/config.d.ts +4 -4
  76. package/lib/config.js +4 -4
  77. package/models/components/http.d.ts +6 -0
  78. package/models/components/http.d.ts.map +1 -1
  79. package/models/components/http.js +4 -0
  80. package/models/components/http.js.map +1 -1
  81. package/models/components/httpcopyright.d.ts +17 -0
  82. package/models/components/httpcopyright.d.ts.map +1 -0
  83. package/models/components/httpcopyright.js +51 -0
  84. package/models/components/httpcopyright.js.map +1 -0
  85. package/models/components/index.d.ts +1 -0
  86. package/models/components/index.d.ts.map +1 -1
  87. package/models/components/index.js +1 -0
  88. package/models/components/index.js.map +1 -1
  89. package/package.json +1 -1
  90. package/sdk/adversaryinvestigation.d.ts +8 -8
  91. package/sdk/adversaryinvestigation.js +8 -8
  92. package/sdk/collections.d.ts +5 -5
  93. package/sdk/collections.js +5 -5
  94. package/sdk/globaldata.d.ts +19 -19
  95. package/sdk/globaldata.js +19 -19
  96. package/sdk/tagsandcomments.d.ts +1 -1
  97. package/sdk/tagsandcomments.js +1 -1
  98. package/sdk/threathunting.d.ts +9 -9
  99. package/sdk/threathunting.js +9 -9
  100. package/src/funcs/collectionsAggregate.ts +1 -1
  101. package/src/funcs/collectionsCreate.ts +1 -1
  102. package/src/funcs/collectionsGet.ts +1 -1
  103. package/src/funcs/collectionsListEvents.ts +1 -1
  104. package/src/funcs/collectionsSearch.ts +1 -1
  105. package/src/funcs/globalDataAggregate.ts +1 -1
  106. package/src/funcs/globalDataCreateTrackedScan.ts +1 -1
  107. package/src/funcs/globalDataGetCertificate.ts +1 -1
  108. package/src/funcs/globalDataGetCertificateRaw.ts +1 -1
  109. package/src/funcs/globalDataGetCertificates.ts +1 -1
  110. package/src/funcs/globalDataGetCertificatesRaw.ts +1 -1
  111. package/src/funcs/globalDataGetHost.ts +1 -1
  112. package/src/funcs/globalDataGetHostEnrichment.ts +1 -1
  113. package/src/funcs/globalDataGetHostTimeline.ts +1 -1
  114. package/src/funcs/globalDataGetHosts.ts +1 -1
  115. package/src/funcs/globalDataGetTrackedScan.ts +1 -1
  116. package/src/funcs/globalDataGetWebProperties.ts +1 -1
  117. package/src/funcs/globalDataGetWebProperty.ts +1 -1
  118. package/src/funcs/globalDataListDnsIpResolutionBounds.ts +1 -1
  119. package/src/funcs/globalDataListDnsIpResolutionRanges.ts +1 -1
  120. package/src/funcs/globalDataListDnsNameResolutionBounds.ts +1 -1
  121. package/src/funcs/globalDataListDnsNameResolutionRanges.ts +1 -1
  122. package/src/funcs/globalDataListServicesOnHost.ts +1 -1
  123. package/src/funcs/globalDataSearch.ts +1 -1
  124. package/src/funcs/tagsAndCommentsUpdateTag.ts +1 -1
  125. package/src/funcs/threatHuntingCreateCenseyeJob.ts +1 -1
  126. package/src/funcs/threatHuntingCreateInvestigationFileUpload.ts +1 -1
  127. package/src/funcs/threatHuntingCreateInvestigationJob.ts +1 -1
  128. package/src/funcs/threatHuntingCreateTrackedScan.ts +1 -1
  129. package/src/funcs/threatHuntingGetCenseyeJobResults.ts +1 -1
  130. package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +1 -1
  131. package/src/funcs/threatHuntingGetTrackedScanThreatHunting.ts +1 -1
  132. package/src/funcs/threatHuntingListThreats.ts +1 -1
  133. package/src/funcs/threatHuntingValueCounts.ts +1 -1
  134. package/src/lib/config.ts +4 -4
  135. package/src/models/components/http.ts +9 -0
  136. package/src/models/components/httpcopyright.ts +39 -0
  137. package/src/models/components/index.ts +1 -0
  138. package/src/sdk/adversaryinvestigation.ts +8 -8
  139. package/src/sdk/collections.ts +5 -5
  140. package/src/sdk/globaldata.ts +19 -19
  141. package/src/sdk/tagsandcomments.ts +1 -1
  142. package/src/sdk/threathunting.ts +9 -9
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Get a certificate
13
13
  *
14
14
  * @remarks
15
- * Retrieve information about a single certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetCertificate(client: SDKCore, request: operations.V3GlobaldataAssetCertificateRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetCertificateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetCertificate.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get a certificate
52
52
  *
53
53
  * @remarks
54
- * Retrieve information about a single certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetCertificate(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 certificate in PEM format
13
13
  *
14
14
  * @remarks
15
- * Retrieve the raw PEM-encoded format of a certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetCertificateRaw(client: SDKCore, request: operations.V3GlobaldataAssetCertificateRawRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetCertificateRawResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetCertificateRaw.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get a certificate in PEM format
52
52
  *
53
53
  * @remarks
54
- * Retrieve the raw PEM-encoded format of a certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetCertificateRaw(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
  * Retrieve multiple certificates
13
13
  *
14
14
  * @remarks
15
- * Retrieve information about multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetCertificates(client: SDKCore, request: operations.V3GlobaldataAssetCertificateListPostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetCertificateListPostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetCertificates.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Retrieve multiple certificates
52
52
  *
53
53
  * @remarks
54
- * Retrieve information about multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetCertificates(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
  * Retrieve multiple certificates in PEM format
13
13
  *
14
14
  * @remarks
15
- * 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 in the Censys dataset.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetCertificatesRaw(client: SDKCore, request: operations.V3GlobaldataAssetCertificateListRawPostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetCertificateListRawPostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetCertificatesRaw.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Retrieve multiple certificates in PEM format
52
52
  *
53
53
  * @remarks
54
- * 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 in the Censys dataset.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetCertificatesRaw(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 host
13
13
  *
14
14
  * @remarks
15
- * Retrieve information about a single host. A host ID is its IP address.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetHost(client: SDKCore, request: operations.V3GlobaldataAssetHostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetHostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetHost.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get a host
52
52
  *
53
53
  * @remarks
54
- * Retrieve information about a single host. A host ID is its IP address.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetHost(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 host enrichment
13
13
  *
14
14
  * @remarks
15
- * 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).
15
+ * 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).
16
16
  */
17
17
  export declare function globalDataGetHostEnrichment(client: SDKCore, request: operations.V3GlobaldataAssetHostEnrichmentRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetHostEnrichmentResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetHostEnrichment.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get host enrichment
52
52
  *
53
53
  * @remarks
54
- * 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).
54
+ * 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).
55
55
  */
56
56
  function globalDataGetHostEnrichment(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 host event history
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetHostTimeline(client: SDKCore, request: operations.V3GlobaldataAssetHostTimelineRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetHostTimelineResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetHostTimeline.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get host event history
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetHostTimeline(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
  * Retrieve multiple hosts
13
13
  *
14
14
  * @remarks
15
- * Retrieve information about multiple hosts. You can retrieve up to 100 hosts per call. A host ID is its IP address.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetHosts(client: SDKCore, request: operations.V3GlobaldataAssetHostListPostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetHostListPostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetHosts.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Retrieve multiple hosts
52
52
  *
53
53
  * @remarks
54
- * Retrieve information about multiple hosts. You can retrieve up to 100 hosts per call. A host ID is its IP address.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetHosts(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 scan status
13
13
  *
14
14
  * @remarks
15
- * 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 Enterprise customers. This endpoint does not cost any credits to execute.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetTrackedScan(client: SDKCore, request: operations.V3GlobaldataScansGetRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataScansGetResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetTrackedScan.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get scan status
52
52
  *
53
53
  * @remarks
54
- * 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 Enterprise customers. This endpoint does not cost any credits to execute.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetTrackedScan(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
  * Retrieve multiple web properties
13
13
  *
14
14
  * @remarks
15
- * 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`.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetWebProperties(client: SDKCore, request: operations.V3GlobaldataAssetWebpropertyListPostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetWebpropertyListPostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetWebProperties.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Retrieve multiple web properties
52
52
  *
53
53
  * @remarks
54
- * 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`.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetWebProperties(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 web property
13
13
  *
14
14
  * @remarks
15
- * 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`.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataGetWebProperty(client: SDKCore, request: operations.V3GlobaldataAssetWebpropertyRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataAssetWebpropertyResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataGetWebProperty.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get a web property
52
52
  *
53
53
  * @remarks
54
- * 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`.
54
+ * 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.
55
55
  */
56
56
  function globalDataGetWebProperty(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 DNS names that resolved to an IP (aggregated bounds)
13
13
  *
14
14
  * @remarks
15
- * 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).
15
+ * 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).
16
16
  */
17
17
  export declare function globalDataListDnsIpResolutionBounds(client: SDKCore, request: operations.V3GlobaldataDnsIpResolutionBoundRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataDnsIpResolutionBoundResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListDnsIpResolutionBounds.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get DNS names that resolved to an IP (aggregated bounds)
52
52
  *
53
53
  * @remarks
54
- * 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).
54
+ * 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).
55
55
  */
56
56
  function globalDataListDnsIpResolutionBounds(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 DNS names that resolved to an IP (ranges)
13
13
  *
14
14
  * @remarks
15
- * 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).
15
+ * 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).
16
16
  */
17
17
  export declare function globalDataListDnsIpResolutionRanges(client: SDKCore, request: operations.V3GlobaldataDnsIpResolutionRangesRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataDnsIpResolutionRangesResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListDnsIpResolutionRanges.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get DNS names that resolved to an IP (ranges)
52
52
  *
53
53
  * @remarks
54
- * 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).
54
+ * 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).
55
55
  */
56
56
  function globalDataListDnsIpResolutionRanges(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 DNS resolution records for a name (aggregated bounds)
13
13
  *
14
14
  * @remarks
15
- * 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).
15
+ * 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).
16
16
  */
17
17
  export declare function globalDataListDnsNameResolutionBounds(client: SDKCore, request: operations.V3GlobaldataDnsNameResolutionBoundRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataDnsNameResolutionBoundResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListDnsNameResolutionBounds.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get DNS resolution records for a name (aggregated bounds)
52
52
  *
53
53
  * @remarks
54
- * 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).
54
+ * 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).
55
55
  */
56
56
  function globalDataListDnsNameResolutionBounds(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 DNS resolution records for a name (ranges)
13
13
  *
14
14
  * @remarks
15
- * 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).
15
+ * 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).
16
16
  */
17
17
  export declare function globalDataListDnsNameResolutionRanges(client: SDKCore, request: operations.V3GlobaldataDnsNameResolutionRangesRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataDnsNameResolutionRangesResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListDnsNameResolutionRanges.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get DNS resolution records for a name (ranges)
52
52
  *
53
53
  * @remarks
54
- * 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).
54
+ * 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).
55
55
  */
56
56
  function globalDataListDnsNameResolutionRanges(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 service history for a host
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataListServicesOnHost(client: SDKCore, request: operations.V3GlobaldataServiceOnHostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataServiceOnHostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListServicesOnHost.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get service history for a host
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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.
55
55
  */
56
56
  function globalDataListServicesOnHost(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
  * Run a search query
13
13
  *
14
14
  * @remarks
15
- * 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. Host services that match your search criteria will be returned in a `matched_services` object.
15
+ * 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.
16
16
  */
17
17
  export declare function globalDataSearch(client: SDKCore, request: operations.V3GlobaldataSearchQueryRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataSearchQueryResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataSearch.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Run a search query
52
52
  *
53
53
  * @remarks
54
- * 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. Host services that match your search criteria will be returned in a `matched_services` object.
54
+ * 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.
55
55
  */
56
56
  function globalDataSearch(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
  * Update a tag
13
13
  *
14
14
  * @remarks
15
- * 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.<br><br>This endpoint does not cost any credits to execute.
15
+ * 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.
16
16
  */
17
17
  export declare function tagsAndCommentsUpdateTag(client: SDKCore, request: operations.V3TagsUpdateTagRequest, options?: RequestOptions): APIPromise<Result<operations.V3TagsUpdateTagResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=tagsAndCommentsUpdateTag.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Update a tag
52
52
  *
53
53
  * @remarks
54
- * 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.<br><br>This endpoint does not cost any credits to execute.
54
+ * 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.
55
55
  */
56
56
  function tagsAndCommentsUpdateTag(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
  * CensEye: Create a pivot analysis job
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function threatHuntingCreateCenseyeJob(client: SDKCore, request: operations.V3ThreathuntingCenseyeJobsCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingCenseyeJobsCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateCenseyeJob.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * CensEye: Create a pivot analysis job
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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.
55
55
  */
56
56
  function threatHuntingCreateCenseyeJob(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
  * Investigations: Create file upload
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function threatHuntingCreateInvestigationFileUpload(client: SDKCore, request: operations.V3ThreathuntingInvestigationsFilesCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingInvestigationsFilesCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateInvestigationFileUpload.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Investigations: Create file upload
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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.
55
55
  */
56
56
  function threatHuntingCreateInvestigationFileUpload(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
  * Investigations: Create job
13
13
  *
14
14
  * @remarks
15
- * 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. 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.
15
+ * 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.
16
16
  */
17
17
  export declare function threatHuntingCreateInvestigationJob(client: SDKCore, request: operations.V3ThreathuntingInvestigationsJobsCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingInvestigationsJobsCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateInvestigationJob.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Investigations: Create job
52
52
  *
53
53
  * @remarks
54
- * 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. 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.
54
+ * 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.
55
55
  */
56
56
  function threatHuntingCreateInvestigationJob(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
  * Live Discovery: Initiate a new scan
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function threatHuntingCreateTrackedScan(client: SDKCore, request: operations.V3ThreathuntingScansDiscoveryRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingScansDiscoveryResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateTrackedScan.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Live Discovery: Initiate a new scan
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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.
55
55
  */
56
56
  function threatHuntingCreateTrackedScan(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
  * CensEye: Get job results
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function threatHuntingGetCenseyeJobResults(client: SDKCore, request: operations.V3ThreathuntingCenseyeJobResultsRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingCenseyeJobResultsResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingGetCenseyeJobResults.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * CensEye: Get job results
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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.
55
55
  */
56
56
  function threatHuntingGetCenseyeJobResults(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));