Package: cribl
Cribl Python SDKAuthenticationPlease fetch a Bearer token for the Cribl Cloud free tierhereSDK InstallationThis is SDK is not yet published to PYPI so please clone repo and then runpipinstall-e/path/to/clone/cribl-pythonSDK Example Usageimportcriblfromcribl.modelsimportshareds=cribl.Cribl(security=shared.Security(bearer_auth="",),)res=s.appscope_lib_entries.get()ifres.app_scope_lib_entriesisnotNone:# handle responseAvailable Resources and Operationsappscope_lib_entriesget- Get a list of AppscopeLibEntry objectsappscope_lib_entrycreate- Create AppscopeLibEntrydelete- Delete AppscopeLibEntryget- Get AppscopeLibEntry by IDupdate- Update AppscopeLibEntryauth_tokenlogin- Log in and obtain Auth tokenauthentication_settingsget- Get authentication settingsupdate- Update authentication settingsauthorizationsget- get the client's authorization policybranchesget- get the list of branchesbulletin_messagecreate- Create BulletinMessagedelete- Delete BulletinMessageget- Get BulletinMessage by IDbulletin_messagesget- Get a list of BulletinMessage objectsbytesget- Get some number of bytes from the file at the given pathcancel_running_grouppost- Cancel a running group upgradecertificatecreate- Create Certificatedelete- Delete Certificateget- Get Certificate by IDupdate- Update Certificatecertificatesget- Get a list of Certificate objectschanged_filesget- get the files changedchangelog_view_stateupdate- Update changelog viewed statechangelogsget- Get changelog viewed stateclient_rolesget- get the client's rolescluisget- Get CLUI search resultscollectorget- Get Collector by IDcollector_objectget- Get a list of Collector objectscommitcreate- create a new commit containing the current configs the given log message describing the changes.conditionget- Get Condition by IDconditionsget- Get a list of Condition objectsconfig_groupcreate- Create ConfigGroupdelete- Delete ConfigGroupget- Get a specific ConfigGroup objectupdate- Update ConfigGroupconfigured_collectorsget- Get list of configured collectorscontainerget- Get details for a single container on the edge host. Add stream=true to get a stream instead.count_fileget- get the count of files of changedcreate_pipelinepost- Create Pipelinecribl_metadataget- Obtain metadata which Cribl Stream/Edge uses when acting as a Service Providercribl_system_settingsget- Get Cribl system settingsupdate- Update Cribl system settingscribls_settingsget- Get Cribl system settings. Deprecated: use specific endpoints /system/limits, /system/job-limits, /system/redis-cache-limits, /system/services-limits, /system/settings/git-settings, and /system/settings/conf respectively :warning:Deprecatedupdate- Update Cribl system settings. Deprecated: use specific endpoints /system/limits, /system/job-limits, /system/settings/git-settings, /system/settings/auth and /system/settings/conf respectively :warning:Deprecatedcurrent_configpush- push the current configs to the remote repository.data_samplepost- Create DataSampledata_sample_iddelete- Delete DataSampleget- Get DataSample by IDupdate- Update DataSampledatabase_connectionpost- Create DatabaseConnectionConfigdatabase_connection_config_iddelete- Delete DatabaseConnectionConfigget- Get DatabaseConnectionConfig by IDupdate- Update DatabaseConnectionConfigdatasetcreate- Create DatasetProviderTypedelete- Delete DatasetProviderTypeget- Get DatasetProviderType by IDupdate- Update DatasetProviderTypedataset_objectcreate- Create Datasetdelete- Delete Datasetget- Get Dataset by IDupdate- Update Datasetdataset_objectsget- Get a list of Dataset objectsdatasetsget- Get a list of DatasetProviderType objectsdestination_queuedelete- Delete destination persistent queuediag_bundledelete- Remove diag bundleget- Returns a diag bundle as a tar.gz archivesend- Send a diag bundle (tar.gz archive) to Cribldiag_bundlesget- Get list of existing diag bundlesdistributed_deploymentget- Get summary of Distributed deploymentedge_host_filesget- Get details about a file on the edge host.edge_listingget- Get a directory listing of the given pathevent_breakerdelete- Delete Event Breaker Rulesetpost- Create Event Breaker Rulesetupdate- Update Event Breaker Rulesetevent_breaker_idget- Get Event Breaker Ruleset by IDevent_breaker_on_datapost- Runs an event breaker rule on the specified dataeventsget- Get events generated by a specified sourceexecute_distributed_upgradepost- Execute distributed group upgradeexecutor_idget- Get Executor by IDexecutor_objectget- Get a list of Executor objectsexisting_diag_bundlesget- Get list of existing diag bundlesfeatureget- Get feature by Idfeaturesget- List all featuresfield_summariesget- List field summariesfleet_mappingcreate- Create MappingRulesetfleet_mappingsget- Get a list of MappingRuleset objectsfleet_or_worker_groupdeploy- Deploy commits for a Fleet or Worker Groupfunction_idget- Get Function by IDgit_settingsget- Get git settingsupdate- Update git settingsgive_cribl_versionpost- Upgrade Cribl to a given versionglobal_variablepost- Create Global Variableglobal_variable_iddelete- Delete Global Variableget- Get Global Variable by IDupdate- Update Global Variablegrok_filecreate- Create GrokFiledelete- Delete GrokFileget- Get GrokFile by IDupdate- Update GrokFilegrok_filesget- Get a list of GrokFile objectsgroup_bundleget- Get effective bundle version for given Groupgroupsget- Get a list of ConfigGroup objectshealth_infoget- Provides health info for REST serverhost_metadata_structureget- Get the host's metadata structureidp_authget- Get IDP used for an authorization code callbackidp_user_authlogout- Accepts a logout request from an IDP and logs out the userinternal_system_metricspost- Aggregate raw internal system metricsjavascript_expressionpost- Evaluate JavaScript expressionjobcancel- Cancel a job by instance iddelete- Remove job from job inspector by instance idget- Get job info by instance idpause_job- Pause a job by instance idprevent- prevent job from being deleted automaticallyresume- Resume a job by instance idrun_job- Run or schedule a jobjob_infosget- Get info on jobsjob_resultget- Get results for a discover job by instance idjob_resultsget- Get results for a discover job by instance idjob_statusget- Get job statuskms_configget- Get Cribl KMS configupdate- Update Cribl KMS configkms_healthget- Get Cribl KMS healthkey_metadata_entitiesget- Get a list of KeyMetadataEntity objectskey_metadata_entitycreate- Create KeyMetadataEntitydelete- Delete KeyMetadataEntityget- Get KeyMetadataEntity by IDupdate- Update KeyMetadataEntitylatest_pqget- Get status of latest clear PQ job for an outputlicensecreate- Create Licensedelete- Delete Licenseget- Get License by IDlicense_usage_metricsget- Get license usage metrics, aggregated by day, up to last 90 dayslicensesget- Get a list of License objectslist_auth_groupget- List the external authentication system's groupslist_container_detailget- Get a detailed list of containers running on the edge host.list_cribl_versionget- Get a list of Cribl versions available for upgradelist_data_sampleget- Get a list of DataSample objectslist_database_connectionget- Get a list of DatabaseConnection objectslist_event_breakerget- Get a list of Event Breaker Ruleset objectslist_global_variableget- Get a list of Global Variable objectslist_parserget- Get a list of Parser objectslist_process_running_detailget- Get a detailed list of processes running on the edge hostlist_schemaget- Get a list of Schema objectslive_datapost- Capture live incoming datalog_file_contentget- Get contents of the log filelog_file_contentsget- Get contents of the log filelog_file_listget- list log fileslog_filesget- Get a list of log fileslog_files_contentget- Get contents of the log filelogand_textualget- get the log message and textual diff for given commitlogger_configdelete- Delete LoggerConfigget- Get LoggerConfig by IDupdate- Update LoggerConfiglogger_configsget- Get a list of LoggerConfig objectslookupcreate- Create LookupFiledelete- Delete LookupFileget- Get LookupFile by IDupdate- Update LookupFileupload- Upload LookupFilelookupsget- Get a list of LookupFile objectsmapping_rulesetcreate- Create MappingRulesetdelete- Delete MappingRulesetget- Get MappingRuleset by IDupdate- Update MappingRulesetmapping_ruleset_idget- Get MappingRuleset by IDmapping_rulesetsdelete- Delete MappingRulesetget- Get a list of MappingRuleset objectsupdate- Update MappingRulesetmaster_node_packagepost- Upgrade master node with the provided packagemetricspost- Enumerate all internal system metricsquery- Query raw internal system metricsnotification_targetcreate- Create NotificationTargetdelete- Delete NotificationTargetget- Get NotificationTarget by IDupdate- Update NotificationTargetnotification_targetsget- Get a list of NotificationTarget objectsobject_functionget- Get a list of Function objectsoutput_iddelete- Delete Outputget- Get Output by IDupdate- Update Outputoutput_objectcreate- Create Outputoutput_objectsget- Get a list of Output objectsoutput_statusget- Get a list of OutputStatus objectsoutput_status_idget- Get OutputStatus by IDpackclone- Clone Packexport- Export Packinstall- Install Packuninstall- Uninstall Pack from the systemupgrade- Upgrade Packupload- Upload Packpacksget- Get info on packsparser_iddelete- Delete Parserget- Get Parser by IDupdate- Update Parserparser_objectpost- Create Parserpipeline_iddelete- Delete Pipelineget- Get Pipeline by IDupdate- Update Pipelinepipeline_objectget- Get a list of Pipeline objectspolicy_rulecreate- Create PolicyRuledelete- Delete PolicyRuleget- Get PolicyRule by IDupdate- Update PolicyRulepolicy_rulesget- Get a list of PolicyRule objectsprevious_cribl_packageget- Get the previously downloaded Cribl packageprocess_running_detailget- Get details of a process running on the edge hostprocessesget- Get a list of processes under managementprofilercreate- Create ProfilerItemdelete- Delete ProfilerItemget- Get ProfilerItem by IDupdate- Update ProfilerItemprofilersget- Get a list of ProfilerItem objectsquery_snippetapply- Applies a query snippet on a set of input events for previewredirect_infoget- Obtain redirect informationredirect_user_authlogout- Redirect user to IDP with logout requestregex_lib_entrydelete- Delete RegexLibEntrypost- Create RegexLibEntryupdate- Update RegexLibEntryregex_lib_entry_idget- Get RegexLibEntry by IDregex_lib_entry_objectget- Get a list of RegexLibEntry objectsreload_cribl_settingspost- Reload Cribl settings from the filesystemremote_reposync- syncs with remote repo via POST requestsrequest_authget- Accepts an authentication request from an IDP and authenticates the userpost- API call that the IDP should use for an authentication requestrequest_user_authlogout- API call that the IDP should use for a logout requestrest_secretcreate- Create RestSecretdelete- Delete RestSecretget- Get RestSecret by IDupdate- Update RestSecretrest_secretsget- Get a list of RestSecret objectsrestart_cribl_settingspost- Restart Cribl serverrolecreate- Create Roledelete- Delete Roleget- Get Role by IDupdate- Update Rolerolesget- Get a list of Role objectsroute_list_idget- List all routes by idroute_listsget- List all routesroute_objectupdate- Add, delete or update the routes with the required content.sample_contentget- Get sample content by IDsample_eventspost- Sends sample events through a pipeline and returns the resultssample_outputpost- Send sample data to an output to validate configuration or test connectivitysaved_jobdelete- Delete SavedJobget- Get SavedJob by IDupdate- Update SavedJobsaved_jobscreate- Create SavedJobget- Get a list of SavedJob objectssaved_queriescreate- Create SavedQuerydelete- Delete SavedQueryget- Get a list of SavedQuery objectsupdate- Update SavedQuerysaved_queryget- Get SavedQuery by IDschemacreate- Create Schemadelete- Delete Schemaget- Get Schema by IDpost- Create Schemaupdate- Update Schemaschema_iddelete- Delete Schemaget- Get Schema by IDupdate- Update Schemaschemasget- Get a list of Schema objectsscriptcreate- Create Scriptdelete- Delete Scriptget- Get Script by IDupdate- Update Scriptscriptsget- Get a list of Script objectssearchdispatch_search- Dispatch searchidto worker nodes filtered by worker node filter using RPCsearch_docget- Get Search documentationsearch_jobcreate- Create SearchJobdelete- Delete SearchJobget- Get SearchJob by IDupdate- Update SearchJobsearch_job_metricsget- Get search job metricssearch_jobsget- Get a list of SearchJob objectssearch_limitsget- Get search limitssearch_logsget- Get search logssearch_timelineget- Get search timelinespecified_outputget- Get samples data for the specified output. Used to get sample data for the test action.stage_distributed_packagepost- Stage distributed group upgradesystem_infoget- Get basic system informationtask_errorget- Get Task errors for a job by idtask_errorsget- Get Task errors for a job by idtest_database_connectionpost- Test a database connection given a type and connectionStringtextual_diffget- get the textual diff for given committrust_policiesget- Get a list of TrustPolicy objectsui_stateget- Get UI state by keyupdate- Update UI state by keyusercreate_user- Create Useruser_authlogout- Log current user outuser_iddelete- Delete Userget- Get User by IDuser_objectget- Get a list of User objectsupdate- Update User except for their rolesuser_propertiesupdate- Update User properties – admin use onlyversioningget- Get info about versioning availabilityworker_edge_nodesget- get worker and edge nodesrestarts- restarts worker nodesworker_edge_nodes_countget- get worker and edge nodes countworking_treeget- get the the working tree statusMaturityThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.ContributionsWhile we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!SDK Created bySpeakeasy