### CreateOutputSystemByPackPqControlsSumoLogic Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolssumologic.md Import and initialize the CreateOutputSystemByPackPqControlsSumoLogic model. This is a basic setup for creating an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsSumoLogic } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsSumoLogic = {}; ``` -------------------------------- ### TypeScript Example for HTTP GET Discovery Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationloginsecrethealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and configure the HealthCheckAuthenticationLoginSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model in TypeScript. Ensure the 'cribl-control-plane' SDK is installed. ```typescript import { HealthCheckAuthenticationLoginSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationLoginSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "list", discoverUrl: "https://selfish-bog.net", }; ``` -------------------------------- ### Example Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackoutputgrafanacloudpqcontrols1.md Demonstrates how to import and initialize the CreateOutputSystemByPackOutputGrafanaCloudPqControls1 model. ```APIDOC ## Example Usage ```typescript import { CreateOutputSystemByPackOutputGrafanaCloudPqControls1 } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackOutputGrafanaCloudPqControls1 = {}; ``` ## Fields | Field | Type | Required | Description | | ----------- | ----------- | ----------- | ----------- | ``` -------------------------------- ### Get Version Diff Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/sdks/commits/README.md This snippet demonstrates how to retrieve the differences between two commits using the `getVersionDiff` operation. It includes setup for the CriblControlPlane client and an example of calling the diff method with parameters like commit hash, filename, and line limit. ```APIDOC ## GET /version/diff ### Description Retrieves the differences between two commits for a given file, with an optional line limit. ### Method GET ### Endpoint /version/diff ### Parameters #### Query Parameters - **commit** (string) - Required - The commit hash to compare against. - **filename** (string) - Required - The name of the file to diff. - **diffLineLimit** (number) - Optional - The maximum number of lines to include in the diff. ### Request Example ```typescript import { CriblControlPlane } from "cribl-control-plane"; const criblControlPlane = new CriblControlPlane({ serverURL: "https://api.example.com", security: { bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "", }, }); async function run() { const result = await criblControlPlane.versions.commits.diff({ commit: "", filename: "example.file", diffLineLimit: 6362, }); console.log(result); } run(); ``` ### Response #### Success Response (200) - **value** (object) - The diff result. #### Response Example ```json { "value": { /* diff details */ } } ``` ``` -------------------------------- ### Example Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackoutputgrafanacloudpqcontrols2.md Demonstrates how to import and initialize the CreateOutputSystemByPackOutputGrafanaCloudPqControls2 model. ```APIDOC ## Example Usage ```typescript import { CreateOutputSystemByPackOutputGrafanaCloudPqControls2 } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackOutputGrafanaCloudPqControls2 = {}; ``` ## Fields | Field | Type | Required | Description | | ----------- | ----------- | ----------- | ----------- | ``` -------------------------------- ### TypeScript Example: RestCollectMethodPostRestPaginationTypeResponseHeaderLink Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restcollectmethodpostrestpaginationtyperesponseheaderlink.md Demonstrates how to import and instantiate RestCollectMethodPostRestPaginationTypeResponseHeaderLink with example values. Ensure the 'cribl-control-plane/models' module is installed. ```typescript import { RestCollectMethodPostRestPaginationTypeResponseHeaderLink } from "cribl-control-plane/models"; let value: RestCollectMethodPostRestPaginationTypeResponseHeaderLink = { type: "response_header_link", nextRelationAttribute: "", maxPages: 5687.87, }; ``` -------------------------------- ### Example Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsazureeventhub.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsAzureEventhub model. ```APIDOC ## Example Usage ```typescript import { CreateOutputSystemByPackPqControlsAzureEventhub } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsAzureEventhub = {}; ``` ## Fields | Field | Type | Required | Description | | ----------- | ----------- | ----------- | ----------- | ``` -------------------------------- ### Example Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsgooglechronicle.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsGoogleChronicle model. ```APIDOC ## Example Usage This snippet shows how to import and use the `CreateOutputSystemByPackPqControlsGoogleChronicle` model. ### Import ```typescript import { CreateOutputSystemByPackPqControlsGoogleChronicle } from "cribl-control-plane/models/operations"; ``` ### Initialization ```typescript let value: CreateOutputSystemByPackPqControlsGoogleChronicle = {}; ``` ### Fields The following table outlines the fields available for this model: | Field | Type | Required | Description | | ----------- | ----------- | ----------- | ----------- | ``` -------------------------------- ### FunctionDnsLookup Model Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/functiondnslookup.md This example demonstrates how to import and instantiate the FunctionDnsLookup model in TypeScript. Ensure the 'cribl-control-plane' package is installed. ```typescript import { FunctionDnsLookup } from "cribl-control-plane/models"; let value: FunctionDnsLookup = { __filename: "example.file", group: "", id: "dns_lookup", loadTime: 8310.14, modTime: 1603.98, name: "", uischema: {}, version: "", }; ``` -------------------------------- ### Basic Secret Health Check HTTP GET Discovery Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationbasicsecrethealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and use the HealthCheckAuthenticationBasicSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model for an HTTP GET discovery method. Ensure the 'cribl-control-plane' package is installed. ```typescript import { HealthCheckAuthenticationBasicSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationBasicSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "list", discoverUrl: "https://remorseful-stump.biz", }; ``` -------------------------------- ### Import and Initialize CreateOutputSystemByPackPqControlsGooglePubsub Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsgooglepubsub.md Demonstrates how to import the necessary class and initialize an empty configuration object for creating a Google Pub/Sub output system. ```typescript import { CreateOutputSystemByPackPqControlsGooglePubsub } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsGooglePubsub = {}; ``` -------------------------------- ### HealthCheckCollectMethodPostWithBodyHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckcollectmethodpostwithbodyhealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and use the HealthCheckCollectMethodPostWithBodyHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model with discoverMethod set to 'get'. ```typescript import { HealthCheckCollectMethodPostWithBodyHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckCollectMethodPostWithBodyHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "none", discoverUrl: "https://nifty-story.net/", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsWavefront Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolswavefront.md Import and initialize the CreateOutputSystemByPackPqControlsWavefront model. This is a basic setup for creating an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsWavefront } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsWavefront = {}; ``` -------------------------------- ### HealthCheckCollectMethodGetHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckcollectmethodgethealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and define a HealthCheckCollectMethodGetHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet object with discoverMethod set to 'get'. ```typescript import { HealthCheckCollectMethodGetHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet } from "cribl-control-plane/models"; let value: HealthCheckCollectMethodGetHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "none", discoverUrl: "https://judicious-individual.net/", }; ``` -------------------------------- ### CreateOutputSystemByPackPqControlsWavefront Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolswavefront.md Example of how to import and initialize the CreateOutputSystemByPackPqControlsWavefront model. ```APIDOC ## CreateOutputSystemByPackPqControlsWavefront ### Description This operation is used to create an output system configured with PackPqControlsWavefront. ### Method POST ### Endpoint `/system/output` ### Request Body - **fields** (object) - Required - The configuration fields for the output system. - **name** (string) - Required - The name of the output system. - **type** (string) - Required - The type of the output system, which must be `wavefront`. - **config** (object) - Required - The configuration object for the Wavefront output. - **pqControls** (object) - Optional - Parameters for PQ controls. - **enabled** (boolean) - Optional - Whether PQ controls are enabled. - **maxSize** (number) - Optional - The maximum size for PQ controls. - **maxWait** (number) - Optional - The maximum wait time for PQ controls. - **wavefront** (object) - Optional - Wavefront specific configuration. - **url** (string) - Required - The Wavefront API URL. - **token** (string) - Required - The Wavefront API token. - **source** (string) - Optional - The source identifier for metrics. - **metricPrefix** (string) - Optional - A prefix for all metrics sent to Wavefront. ### Request Example ```json { "name": "my-wavefront-output", "type": "wavefront", "config": { "pqControls": { "enabled": true, "maxSize": 1024, "maxWait": 5000 }, "wavefront": { "url": "https://your-wavefront-instance.wavefront.com", "token": "your-api-token", "source": "cribl-source", "metricPrefix": "cribl." } } } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier of the created output system. - **name** (string) - The name of the output system. - **type** (string) - The type of the output system. - **config** (object) - The configuration of the output system. #### Response Example ```json { "id": "output-12345", "name": "my-wavefront-output", "type": "wavefront", "config": { "pqControls": { "enabled": true, "maxSize": 1024, "maxWait": 5000 }, "wavefront": { "url": "https://your-wavefront-instance.wavefront.com", "source": "cribl-source", "metricPrefix": "cribl." } } } ``` ``` -------------------------------- ### HealthCheckAuthenticationOauthSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationoauthsecrethealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to import and instantiate the HealthCheckAuthenticationOauthSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model with a GET discover method. ```typescript import { HealthCheckAuthenticationOauthSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationOauthSecretHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "none", discoverUrl: "https://noted-co-producer.net/", }; ``` -------------------------------- ### HealthCheckAuthenticationOauthHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationoauthhealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to import and instantiate the HealthCheckAuthenticationOauthHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model with discoverMethod set to 'get'. ```typescript import { HealthCheckAuthenticationOauthHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationOauthHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "json", discoverUrl: "https://standard-derby.biz", }; ``` -------------------------------- ### CreateOutputOutputFilesystem Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputoutputfilesystem.md Demonstrates how to import and instantiate the CreateOutputOutputFilesystem model with required fields. ```typescript import { CreateOutputOutputFilesystem } from "cribl-control-plane/models/operations"; let value: CreateOutputOutputFilesystem = { id: "", type: "filesystem", destPath: "", }; ``` -------------------------------- ### HealthCheckAuthenticationNoneHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationnonehealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to import and instantiate the HealthCheckAuthenticationNoneHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model with discoverMethod set to 'get'. ```typescript import { HealthCheckAuthenticationNoneHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationNoneHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "json", discoverUrl: "https://descriptive-puppet.name", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsCriblSearchEngine Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolscriblsearchengine.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsCriblSearchEngine model. This is typically the first step before configuring or using the output system. ```typescript import { CreateOutputSystemByPackPqControlsCriblSearchEngine } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsCriblSearchEngine = {}; ``` -------------------------------- ### HealthCheckAuthenticationLoginHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationloginhealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to import and instantiate the HealthCheckAuthenticationLoginHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model with discoverMethod set to 'get'. ```typescript import { HealthCheckAuthenticationLoginHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationLoginHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "list", discoverUrl: "https://flashy-unique.org", }; ``` -------------------------------- ### CreateOutputPqControlsMsk Usage Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputpqcontrolsmsk.md Demonstrates how to import and initialize the CreateOutputPqControlsMsk model. This is a basic setup for defining output configurations. ```typescript import { CreateOutputPqControlsMsk } from "cribl-control-plane/models/operations"; let value: CreateOutputPqControlsMsk = {}; ``` -------------------------------- ### OutputResponseOutputFilesystem Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/outputresponseoutputfilesystem.md Demonstrates how to import and instantiate the OutputResponseOutputFilesystem model with a filesystem type and destination path. ```typescript import { OutputResponseOutputFilesystem } from "cribl-control-plane/models"; let value: OutputResponseOutputFilesystem = { type: "filesystem", destPath: "", }; ``` -------------------------------- ### HealthCheckAuthenticationBasicHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/healthcheckauthenticationbasichealthcheckdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to import and instantiate the HealthCheckAuthenticationBasicHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet model with discoverMethod set to 'get'. ```typescript import { HealthCheckAuthenticationBasicHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet, } from "cribl-control-plane/models"; let value: HealthCheckAuthenticationBasicHealthCheckDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "http", discoverUrl: "https://realistic-allegation.org/", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsLocalSearchStorage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolslocalsearchstorage.md Import and initialize the CreateOutputSystemByPackPqControlsLocalSearchStorage model. This is a basic setup for creating an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsLocalSearchStorage } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsLocalSearchStorage = {}; ``` -------------------------------- ### Instantiate RestAuthenticationBasicRestDiscoveryDiscoverTypeHttpDiscoverMethodPost Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restauthenticationbasicrestdiscoverydiscovertypehttpdiscovermethodpost.md Example of how to create an instance of RestAuthenticationBasicRestDiscoveryDiscoverTypeHttpDiscoverMethodPost. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestAuthenticationBasicRestDiscoveryDiscoverTypeHttpDiscoverMethodPost } from "cribl-control-plane/models"; let value: RestAuthenticationBasicRestDiscoveryDiscoverTypeHttpDiscoverMethodPost = { discoverMethod: "post", discoverType: "http", discoverUrl: "https://frank-yeast.name", }; ``` -------------------------------- ### Basic Secret REST Discovery HTTP GET Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restauthenticationbasicsecretrestdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and use the RestAuthenticationBasicSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodGet model. This is useful for setting up basic secret-based REST discovery with an HTTP GET method. ```typescript import { RestAuthenticationBasicSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodGet } from "cribl-control-plane/models"; let value: RestAuthenticationBasicSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "list", discoverUrl: "https://legal-linseed.biz", }; ``` -------------------------------- ### Initialize CreateOutputPqControlsCriblSearchEngine Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputpqcontrolscriblsearchengine.md Demonstrates how to import and initialize an empty CreateOutputPqControlsCriblSearchEngine object. This is a starting point for creating a new search engine configuration. ```typescript import { CreateOutputPqControlsCriblSearchEngine } from "cribl-control-plane/models/operations"; let value: CreateOutputPqControlsCriblSearchEngine = {}; ``` -------------------------------- ### Install Pack from GitHub Release URL (SDK Method) Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/sdks/packs/README.md Install a pack from a specific GitHub release URL using the `criblControlPlane.packs.install` method. This example shows how to set `allowCustomFunctions` to false. ```typescript import { CriblControlPlane } from "cribl-control-plane"; const criblControlPlane = new CriblControlPlane({ serverURL: "https://api.example.com", security: { bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "", }, }); async function run() { const result = await criblControlPlane.packs.install({ source: "https://github.com/criblpacks/cribl-palo-alto-networks/releases/download/1.1.4/cribl-palo-alto-networks-a3e5a19d-1.1.4.crbl", allowCustomFunctions: false, }); console.log(result); } run(); ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsSyslog Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolssyslog.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsSyslog type. This is a basic setup for defining an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsSyslog } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsSyslog = {}; ``` -------------------------------- ### CreateOutputSystemByPackPqControlsSyslog Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolssyslog.md Example of how to import and initialize the CreateOutputSystemByPackPqControlsSyslog model. ```APIDOC ## CreateOutputSystemByPackPqControlsSyslog ### Description This model represents the configuration for creating an output system specifically for Pack PQ Controls Syslog. ### Fields | Field | Type | Required | Description | | ----------- | ----------- | ----------- | ----------- | ### Example Usage ```typescript import { CreateOutputSystemByPackPqControlsSyslog } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsSyslog = {}; ``` ``` -------------------------------- ### RestCollectMethodPostWithBodyRestDiscoveryDiscoverTypeHttpDiscoverMethodOther Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restcollectmethodpostwithbodyrestdiscoverydiscovertypehttpdiscovermethodother.md Example of how to instantiate and use the RestCollectMethodPostWithBodyRestDiscoveryDiscoverTypeHttpDiscoverMethodOther model. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestCollectMethodPostWithBodyRestDiscoveryDiscoverTypeHttpDiscoverMethodOther } from "cribl-control-plane/models"; let value: RestCollectMethodPostWithBodyRestDiscoveryDiscoverTypeHttpDiscoverMethodOther = { discoverMethod: "other", discoverVerb: "", discoverType: "list", discoverUrl: "https://crushing-swanling.org", }; ``` -------------------------------- ### Import and Initialize CreateOutputSystemByPackOutputWebhookPqControls1 Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackoutputwebhookpqcontrols1.md Demonstrates how to import and initialize the CreateOutputSystemByPackOutputWebhookPqControls1 model. This is a common starting point when configuring output systems. ```typescript import { CreateOutputSystemByPackOutputWebhookPqControls1 } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackOutputWebhookPqControls1 = {}; ``` -------------------------------- ### RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodPost Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restcollectmethodotherrestdiscoverydiscovertypehttpdiscovermethodpost.md Demonstrates how to instantiate and use the RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodPost model. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodPost } from "cribl-control-plane/models"; let value: RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodPost = { discoverMethod: "post", discoverType: "http", discoverUrl: "https://infatuated-hovel.org", }; ``` -------------------------------- ### RestAuthenticationOauthSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodPost Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restauthenticationoauthsecretrestdiscoverydiscovertypehttpdiscovermethodpost.md Example of how to instantiate and use the RestAuthenticationOauthSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodPost model. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestAuthenticationOauthSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodPost } from "cribl-control-plane/models"; let value: RestAuthenticationOauthSecretRestDiscoveryDiscoverTypeHttpDiscoverMethodPost = { discoverMethod: "post", discoverType: "list", discoverUrl: "https://animated-hammock.com", }; ``` -------------------------------- ### CreateOutputSystemByPackPqControlsSentinelOneAiSiem Usage Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolssentineloneaisiem.md Example of how to import and initialize the CreateOutputSystemByPackPqControlsSentinelOneAiSiem model. ```APIDOC ## CreateOutputSystemByPackPqControlsSentinelOneAiSiem ### Description This operation is used to create an output system configured for SentinelOne AI Siem, utilizing Pack PQ Controls. ### Fields | Field | Type | Required | Description | | ----------- | ----------- | ----------- | ----------- | ### Request Example ```typescript import { CreateOutputSystemByPackPqControlsSentinelOneAiSiem } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsSentinelOneAiSiem = {}; ``` ### Response (No specific response details provided in the source) ``` -------------------------------- ### RestAuthenticationLoginRestDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restauthenticationloginrestdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and use the RestAuthenticationLoginRestDiscoveryDiscoverTypeHttpDiscoverMethodGet model. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestAuthenticationLoginRestDiscoveryDiscoverTypeHttpDiscoverMethodGet } from "cribl-control-plane/models"; let value: RestAuthenticationLoginRestDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "json", discoverUrl: "https://queasy-vibration.biz/", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsXsiam Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsxsiam.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsXsiam model. This is typically used as a starting point for configuring output systems. ```typescript import { CreateOutputSystemByPackPqControlsXsiam } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsXsiam = {}; ``` -------------------------------- ### Create OutputResponseOutputWebhookWebhook1 Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/outputresponseoutputwebhookwebhook1.md Example of how to instantiate and configure an OutputResponseOutputWebhookWebhook1 object. Ensure the 'cribl-control-plane' package is installed. ```typescript import { OutputResponseOutputWebhookWebhook1 } from "cribl-control-plane/models"; let value: OutputResponseOutputWebhookWebhook1 = { type: "webhook", url: "https://kooky-unit.info", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsCriblTCP Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolscribltcp.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsCriblTCP type. This is typically the first step when defining a new output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsCriblTCP } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsCriblTCP = {}; ``` -------------------------------- ### OutputResponseOutputGoogleChronicle Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/outputresponseoutputgooglechronicle.md Demonstrates how to import and initialize an OutputResponseOutputGoogleChronicle object. Ensure the 'cribl-control-plane' package is installed. ```typescript import { OutputResponseOutputGoogleChronicle } from "cribl-control-plane/models"; let value: OutputResponseOutputGoogleChronicle = { type: "google_chronicle", logFormatType: "unstructured", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsHoneycomb Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolshoneycomb.md Import and initialize the CreateOutputSystemByPackPqControlsHoneycomb model. This is a basic setup for creating an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsHoneycomb } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsHoneycomb = {}; ``` -------------------------------- ### CreateOutputSystemByPackAdditionalProperty Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackadditionalproperty.md Demonstrates how to import and instantiate the CreateOutputSystemByPackAdditionalProperty model. Ensure you have the 'cribl-control-plane' SDK installed. ```typescript import { CreateOutputSystemByPackAdditionalProperty } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackAdditionalProperty = { key: "", value: "", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsSentinelOneAiSiem Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolssentineloneaisiem.md Import and initialize the CreateOutputSystemByPackPqControlsSentinelOneAiSiem type. This is a basic setup for defining an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsSentinelOneAiSiem } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsSentinelOneAiSiem = {}; ``` -------------------------------- ### CreateOutputSystemByPackPqControlsDataset Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsdataset.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsDataset model. This is typically used when constructing requests to create or update output systems. ```typescript import { CreateOutputSystemByPackPqControlsDataset } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsDataset = {}; ``` -------------------------------- ### InputResponseInputEventhub Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/inputresponseinputeventhub.md Demonstrates how to instantiate and use the InputResponseInputEventhub model. Ensure you have the 'cribl-control-plane' SDK installed. ```typescript import { InputResponseInputEventhub } from "cribl-control-plane/models"; let value: InputResponseInputEventhub = { type: "eventhub", brokers: [ "", "", ], topics: [ "", "", "", ], }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsDynatraceOtlp Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsdynatraceotlp.md Import and initialize the CreateOutputSystemByPackPqControlsDynatraceOtlp type. This is a basic setup for defining an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsDynatraceOtlp } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsDynatraceOtlp = {}; ``` -------------------------------- ### InputEventhubInput Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/inputeventhubinput.md Demonstrates how to instantiate and use the InputEventhubInput model. Ensure you have the 'cribl-control-plane' SDK installed. ```typescript import { InputEventhubInput } from "cribl-control-plane/models"; let value: InputEventhubInput = { type: "eventhub", brokers: [ "", "", ], topics: [ "", "", "", ], }; ``` -------------------------------- ### Instantiate FunctionLocalSearchRulesetRunner Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/functionlocalsearchrulesetrunner.md Example of how to instantiate a FunctionLocalSearchRulesetRunner object in TypeScript. Ensure the 'cribl-control-plane' package is installed. ```typescript import { FunctionLocalSearchRulesetRunner } from "cribl-control-plane/models"; let value: FunctionLocalSearchRulesetRunner = { __filename: "example.file", group: "", id: "local_search_ruleset_runner", loadTime: 9962.28, modTime: 3956.82, name: "", uischema: { "key": "", "key1": "", "key2": "", }, version: "", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsChronicle Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolschronicle.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsChronicle model. This is a basic setup for creating an output system configuration. ```typescript import { CreateOutputSystemByPackPqControlsChronicle } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsChronicle = {}; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsCriblHTTP Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolscriblhttp.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsCriblHTTP model. This is typically the first step when configuring an output system. ```typescript import { CreateOutputSystemByPackPqControlsCriblHTTP } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsCriblHTTP = {}; ``` -------------------------------- ### DatabaseCollectorConf Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/databasecollectorconf.md Demonstrates how to import and initialize a DatabaseCollectorConf object. Ensure you have the 'cribl-control-plane' SDK installed. ```typescript import { DatabaseCollectorConf } from "cribl-control-plane/models"; let value: DatabaseCollectorConf = { connectionId: "", query: "", }; ``` -------------------------------- ### RestCollectMethodPostRestDiscoveryDiscoverTypeHttpDiscoverMethodGet Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restcollectmethodpostrestdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and assign values to a RestCollectMethodPostRestDiscoveryDiscoverTypeHttpDiscoverMethodGet object. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestCollectMethodPostRestDiscoveryDiscoverTypeHttpDiscoverMethodGet } from "cribl-control-plane/models"; let value: RestCollectMethodPostRestDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "none", discoverUrl: "https://annual-sermon.name/", }; ``` -------------------------------- ### KeyValueMetadataConfOutputFilesystem Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/keyvaluemetadataconfoutputfilesystem.md Demonstrates how to import and instantiate the KeyValueMetadataConfOutputFilesystem model. ```typescript import { KeyValueMetadataConfOutputFilesystem } from "cribl-control-plane/models"; let value: KeyValueMetadataConfOutputFilesystem = { key: "", value: "", }; ``` -------------------------------- ### Example Usage of RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodGet Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restcollectmethodotherrestdiscoverydiscovertypehttpdiscovermethodget.md Demonstrates how to instantiate and use the RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodGet model. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodGet } from "cribl-control-plane/models"; let value: RestCollectMethodOtherRestDiscoveryDiscoverTypeHttpDiscoverMethodGet = { discoverMethod: "get", discoverType: "list", discoverUrl: "https://stingy-hyphenation.net", }; ``` -------------------------------- ### Initialize CreateOutputSystemByPackPqControlsServiceNow Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolsservicenow.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsServiceNow type. This is typically the first step before configuring specific output system parameters. ```typescript import { CreateOutputSystemByPackPqControlsServiceNow } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsServiceNow = {}; ``` -------------------------------- ### Example Usage of RestAuthenticationGoogleOauthRestDiscoveryDiscoverTypeHttpDiscoverMethodPostWithBody Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/restauthenticationgoogleoauthrestdiscoverydiscovertypehttpdiscovermethodpostwithbody.md Demonstrates how to import and instantiate the RestAuthenticationGoogleOauthRestDiscoveryDiscoverTypeHttpDiscoverMethodPostWithBody model. Ensure the 'cribl-control-plane' package is installed. ```typescript import { RestAuthenticationGoogleOauthRestDiscoveryDiscoverTypeHttpDiscoverMethodPostWithBody, } from "cribl-control-plane/models"; let value: RestAuthenticationGoogleOauthRestDiscoveryDiscoverTypeHttpDiscoverMethodPostWithBody = { discoverMethod: "post_with_body", discoverBody: "", discoverType: "http", discoverUrl: "https://uncommon-soup.org", }; ``` -------------------------------- ### Instantiate CreateOutputSystemByPackPqControlsKafka Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/operations/createoutputsystembypackpqcontrolskafka.md Demonstrates how to import and initialize the CreateOutputSystemByPackPqControlsKafka type. This is typically used as a starting point for configuring an output system. ```typescript import { CreateOutputSystemByPackPqControlsKafka } from "cribl-control-plane/models/operations"; let value: CreateOutputSystemByPackPqControlsKafka = {}; ``` -------------------------------- ### OutputResponseOutputCloudianS3 Usage Example Source: https://github.com/criblio/cribl-control-plane-sdk-typescript/blob/main/docs/models/outputresponseoutputcloudians3.md Demonstrates how to import and instantiate the OutputResponseOutputCloudianS3 model. Ensure you have the 'cribl-control-plane' package installed. ```typescript import { OutputResponseOutputCloudianS3 } from "cribl-control-plane/models"; let value: OutputResponseOutputCloudianS3 = { type: "cloudian_s3", endpoint: "", bucket: "", stagePath: "", }; ```