npm - @censys/platform-sdk - Versions diffs - 0.4.3 → 0.5.0 - Mend

@censys/platform-sdk 0.4.3 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (177) hide show

package/FUNCTIONS.md CHANGED Viewed

@@ -36,7 +36,6 @@ async function run() {
         "host.ip",
       ],
       pageSize: 1,
-      pageToken: "<next_page_token>",
       query: "host.services: (protocol=SSH and not port: 22)",
     },
   });

package/README.md CHANGED Viewed

@@ -96,7 +96,6 @@ async function run() {
         "host.ip",
       ],
       pageSize: 1,
-      pageToken: "<next_page_token>",
       query: "host.services: (protocol=SSH and not port: 22)",
     },
   });
@@ -130,17 +129,24 @@ run();
 * [getCertificates](docs/sdks/globaldata/README.md#getcertificates) - Get multiple certificates
 * [getCertificate](docs/sdks/globaldata/README.md#getcertificate) - Get a certificate
+* [getHostObservationsWithCertificate](docs/sdks/globaldata/README.md#gethostobservationswithcertificate) - Get Host Observations With Certificate
 * [getHosts](docs/sdks/globaldata/README.md#gethosts) - Get multiple hosts
 * [getHost](docs/sdks/globaldata/README.md#gethost) - Get a host
 * [getHostTimeline](docs/sdks/globaldata/README.md#gethosttimeline) - Get host event history
 * [getWebProperties](docs/sdks/globaldata/README.md#getwebproperties) - Get multiple web properties
 * [getWebProperty](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property
+* [createTrackedScan](docs/sdks/globaldata/README.md#createtrackedscan) - Create a tracked rescan
+* [getTrackedScan](docs/sdks/globaldata/README.md#gettrackedscan) - Get tracked scan details
 * [aggregate](docs/sdks/globaldata/README.md#aggregate) - Aggregate results for a search query
 * [search](docs/sdks/globaldata/README.md#search) - Run a search query
+* [getTrackedScanThreatHunting](docs/sdks/globaldata/README.md#gettrackedscanthreathunting) - Get tracked scan details
 ### [threatHunting](docs/sdks/threathunting/README.md)
+* [getTrackedScan](docs/sdks/threathunting/README.md#gettrackedscan) - Get tracked scan details
+* [createTrackedScan](docs/sdks/threathunting/README.md#createtrackedscan) - Create a tracked discovery scan
+* [getTrackedScanThreatHunting](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get tracked scan details
 * [valueCounts](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
 </details>
@@ -170,14 +176,21 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`collectionsSearch`](docs/sdks/collections/README.md#search) - Run a search query within a collection
 - [`collectionsUpdate`](docs/sdks/collections/README.md#update) - Update a collection
 - [`globalDataAggregate`](docs/sdks/globaldata/README.md#aggregate) - Aggregate results for a search query
+- [`globalDataCreateTrackedScan`](docs/sdks/globaldata/README.md#createtrackedscan) - Create a tracked rescan
 - [`globalDataGetCertificate`](docs/sdks/globaldata/README.md#getcertificate) - Get a certificate
 - [`globalDataGetCertificates`](docs/sdks/globaldata/README.md#getcertificates) - Get multiple certificates
 - [`globalDataGetHost`](docs/sdks/globaldata/README.md#gethost) - Get a host
+- [`globalDataGetHostObservationsWithCertificate`](docs/sdks/globaldata/README.md#gethostobservationswithcertificate) - Get Host Observations With Certificate
 - [`globalDataGetHosts`](docs/sdks/globaldata/README.md#gethosts) - Get multiple hosts
 - [`globalDataGetHostTimeline`](docs/sdks/globaldata/README.md#gethosttimeline) - Get host event history
+- [`globalDataGetTrackedScan`](docs/sdks/globaldata/README.md#gettrackedscan) - Get tracked scan details
+- [`globalDataGetTrackedScan`](docs/sdks/threathunting/README.md#gettrackedscan) - Get tracked scan details
+- [`globalDataGetTrackedScanThreatHunting`](docs/sdks/globaldata/README.md#gettrackedscanthreathunting) - Get tracked scan details
+- [`globalDataGetTrackedScanThreatHunting`](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get tracked scan details
 - [`globalDataGetWebProperties`](docs/sdks/globaldata/README.md#getwebproperties) - Get multiple web properties
 - [`globalDataGetWebProperty`](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property
 - [`globalDataSearch`](docs/sdks/globaldata/README.md#search) - Run a search query
+- [`threatHuntingCreateTrackedScan`](docs/sdks/threathunting/README.md#createtrackedscan) - Create a tracked discovery scan
 - [`threatHuntingValueCounts`](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
 </details>
@@ -353,7 +366,7 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`SDKBaseError`](./src/models/errors/sdkbaseerror.ts): The base class for HTTP error responses.
-  * [`ErrorModel`](./src/models/errors/errormodel.ts): Request does not contain a valid Authorization token.
+  * [`ErrorModel`](./src/models/errors/errormodel.ts): Request does not contain a valid Authorization token. *
 <details><summary>Less common errors (6)</summary>
@@ -371,6 +384,8 @@ run();
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 </details>
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 <!-- Start Server Selection [server] -->

package/docs/sdks/collections/README.md CHANGED Viewed

@@ -22,6 +22,7 @@ List all collections for an organization. Retrieved information includes collect
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-crud-list" method="get" path="/v3/collections" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -99,6 +100,7 @@ Create a new collection.
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-crud-create" method="post" path="/v3/collections" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -182,6 +184,7 @@ Delete a collection.
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-crud-delete" method="delete" path="/v3/collections/{collection_uid}" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -257,6 +260,7 @@ Retrieve information about a collection. Retrieved information includes its name
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-crud-get" method="get" path="/v3/collections/{collection_uid}" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -332,6 +336,7 @@ Update a collection's name, description, and/or query.
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-crud-update" method="put" path="/v3/collections/{collection_uid}" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -417,6 +422,7 @@ Retrieve the event history for a collection. This includes the addition or remov
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-list-events" method="get" path="/v3/collections/{collection_uid}/events" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -500,6 +506,7 @@ Aggregate results for a Platform search query that targets a collection's assets
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-search-aggregate" method="post" path="/v3/collections/{collection_uid}/search/aggregate" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -512,9 +519,9 @@ async function run() {
   const result = await sdk.collections.aggregate({
     collectionUid: "11111111-2222-3333-4444-555555555555",
     searchAggregateInputBody: {
-      field: "web.endpoints.http.html_title",
+      field: "host.services.port",
       numberOfBuckets: 100,
-      query: "web: *",
+      query: "host.services.protocol=SSH",
     },
   });
@@ -543,9 +550,9 @@ async function run() {
   const res = await collectionsAggregate(sdk, {
     collectionUid: "11111111-2222-3333-4444-555555555555",
     searchAggregateInputBody: {
-      field: "web.endpoints.http.html_title",
+      field: "host.services.port",
       numberOfBuckets: 100,
-      query: "web: *",
+      query: "host.services.protocol=SSH",
     },
   });
   if (res.ok) {
@@ -585,6 +592,7 @@ Run a search query across a collection's assets. Reference the [documentation on
 ### Example Usage
+<!-- UsageSnippet language="typescript" operationID="v3-collections-search-query" method="post" path="/v3/collections/{collection_uid}/search/query" -->
 ```typescript
 import { SDK } from "@censys/platform-sdk";
@@ -601,7 +609,6 @@ async function run() {
         "host.ip",
       ],
       pageSize: 1,
-      pageToken: "<next_page_token>",
       query: "host.services: (protocol=SSH and not port: 22)",
     },
   });
@@ -635,7 +642,6 @@ async function run() {
         "host.ip",
       ],
       pageSize: 1,
-      pageToken: "<next_page_token>",
       query: "host.services: (protocol=SSH and not port: 22)",
     },
   });