cribl 1.0.0

Python SDK for Cribl API

Cribl Python SDK

Authentication

Please fetch a Bearer token for the Cribl Cloud free tier here

SDK Installation

This is SDK is not yet published to PYPI so please clone repo and then run

pip install -e /path/to/clone/cribl-python

SDK Example Usage

import cribl
from cribl.models import shared

s = cribl.Cribl(
    security=shared.Security(
        bearer_auth="",
    ),
)


res = s.appscope_lib_entries.get()

if res.app_scope_lib_entries is not None:
    # handle response

Available Resources and Operations

appscope_lib_entries

• get - Get a list of AppscopeLibEntry objects

appscope_lib_entry

• create - Create AppscopeLibEntry
• delete - Delete AppscopeLibEntry
• get - Get AppscopeLibEntry by ID
• update - Update AppscopeLibEntry

auth_token

• login - Log in and obtain Auth token

authentication_settings

• get - Get authentication settings
• update - Update authentication settings

authorizations

• get - get the client's authorization policy

branches

• get - get the list of branches

bulletin_message

• create - Create BulletinMessage
• delete - Delete BulletinMessage
• get - Get BulletinMessage by ID

bulletin_messages

• get - Get a list of BulletinMessage objects

bytes

• get - Get some number of bytes from the file at the given path

cancel_running_group

• post - Cancel a running group upgrade

certificate

• create - Create Certificate
• delete - Delete Certificate
• get - Get Certificate by ID
• update - Update Certificate

certificates

• get - Get a list of Certificate objects

changed_files

• get - get the files changed

changelog_view_state

• update - Update changelog viewed state

changelogs

• get - Get changelog viewed state

client_roles

• get - get the client's roles

cluis

• get - Get CLUI search results

collector

• get - Get Collector by ID

collector_object

• get - Get a list of Collector objects

commit

• create - create a new commit containing the current configs the given log message describing the changes.

condition

• get - Get Condition by ID

conditions

• get - Get a list of Condition objects

config_group

• create - Create ConfigGroup
• delete - Delete ConfigGroup
• get - Get a specific ConfigGroup object
• update - Update ConfigGroup

configured_collectors

• get - Get list of configured collectors

container

• get - Get details for a single container on the edge host. Add stream=true to get a stream instead.

count_file

• get - get the count of files of changed

create_pipeline

• post - Create Pipeline

cribl_metadata

• get - Obtain metadata which Cribl Stream/Edge uses when acting as a Service Provider

cribl_system_settings

• get - Get Cribl system settings
• update - Update Cribl system settings

cribls_settings

• get - 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: Deprecated
• update - 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: Deprecated

current_config

• push - push the current configs to the remote repository.

data_sample

• post - Create DataSample

data_sample_id

• delete - Delete DataSample
• get - Get DataSample by ID
• update - Update DataSample

database_connection

• post - Create DatabaseConnectionConfig

database_connection_config_id

• delete - Delete DatabaseConnectionConfig
• get - Get DatabaseConnectionConfig by ID
• update - Update DatabaseConnectionConfig

dataset

• create - Create DatasetProviderType
• delete - Delete DatasetProviderType
• get - Get DatasetProviderType by ID
• update - Update DatasetProviderType

dataset_object

• create - Create Dataset
• delete - Delete Dataset
• get - Get Dataset by ID
• update - Update Dataset

dataset_objects

• get - Get a list of Dataset objects

datasets

• get - Get a list of DatasetProviderType objects

destination_queue

• delete - Delete destination persistent queue

diag_bundle

• delete - Remove diag bundle
• get - Returns a diag bundle as a tar.gz archive
• send - Send a diag bundle (tar.gz archive) to Cribl

diag_bundles

• get - Get list of existing diag bundles

distributed_deployment

• get - Get summary of Distributed deployment

edge_host_files

• get - Get details about a file on the edge host.

edge_listing

• get - Get a directory listing of the given path

event_breaker

• delete - Delete Event Breaker Ruleset
• post - Create Event Breaker Ruleset
• update - Update Event Breaker Ruleset

event_breaker_id

• get - Get Event Breaker Ruleset by ID

event_breaker_on_data

• post - Runs an event breaker rule on the specified data

events

• get - Get events generated by a specified source

execute_distributed_upgrade

• post - Execute distributed group upgrade

executor_id

• get - Get Executor by ID

executor_object

• get - Get a list of Executor objects

existing_diag_bundles

• get - Get list of existing diag bundles

feature

• get - Get feature by Id

features

• get - List all features

field_summaries

• get - List field summaries

fleet_mapping

• create - Create MappingRuleset

fleet_mappings

• get - Get a list of MappingRuleset objects

fleet_or_worker_group

• deploy - Deploy commits for a Fleet or Worker Group

function_id

• get - Get Function by ID

git_settings

• get - Get git settings
• update - Update git settings

give_cribl_version

• post - Upgrade Cribl to a given version

global_variable

• post - Create Global Variable

global_variable_id

• delete - Delete Global Variable
• get - Get Global Variable by ID
• update - Update Global Variable

grok_file

• create - Create GrokFile
• delete - Delete GrokFile
• get - Get GrokFile by ID
• update - Update GrokFile

grok_files

• get - Get a list of GrokFile objects

group_bundle

• get - Get effective bundle version for given Group

groups

• get - Get a list of ConfigGroup objects

health_info

• get - Provides health info for REST server

host_metadata_structure

• get - Get the host's metadata structure

idp_auth

• get - Get IDP used for an authorization code callback

idp_user_auth

• logout - Accepts a logout request from an IDP and logs out the user

internal_system_metrics

• post - Aggregate raw internal system metrics

javascript_expression

• post - Evaluate JavaScript expression

job

• cancel - Cancel a job by instance id
• delete - Remove job from job inspector by instance id
• get - Get job info by instance id
• pause_job - Pause a job by instance id
• prevent - prevent job from being deleted automatically
• resume - Resume a job by instance id
• run_job - Run or schedule a job

job_infos

• get - Get info on jobs

job_result

• get - Get results for a discover job by instance id

job_results

• get - Get results for a discover job by instance id

job_status

• get - Get job status

kms_config

• get - Get Cribl KMS config
• update - Update Cribl KMS config

kms_health

• get - Get Cribl KMS health

key_metadata_entities

• get - Get a list of KeyMetadataEntity objects

key_metadata_entity

• create - Create KeyMetadataEntity
• delete - Delete KeyMetadataEntity
• get - Get KeyMetadataEntity by ID
• update - Update KeyMetadataEntity

latest_pq

• get - Get status of latest clear PQ job for an output

license

• create - Create License
• delete - Delete License
• get - Get License by ID

license_usage_metrics

• get - Get license usage metrics, aggregated by day, up to last 90 days

licenses

• get - Get a list of License objects

list_auth_group

• get - List the external authentication system's groups

list_container_detail

• get - Get a detailed list of containers running on the edge host.

list_cribl_version

• get - Get a list of Cribl versions available for upgrade

list_data_sample

• get - Get a list of DataSample objects

list_database_connection

• get - Get a list of DatabaseConnection objects

list_event_breaker

• get - Get a list of Event Breaker Ruleset objects

list_global_variable

• get - Get a list of Global Variable objects

list_parser

• get - Get a list of Parser objects

list_process_running_detail

• get - Get a detailed list of processes running on the edge host

list_schema

• get - Get a list of Schema objects

live_data

• post - Capture live incoming data

log_file_content

• get - Get contents of the log file

log_file_contents

• get - Get contents of the log file

log_file_list

• get - list log files

log_files

• get - Get a list of log files

log_files_content

• get - Get contents of the log file

logand_textual

• get - get the log message and textual diff for given commit

logger_config

• delete - Delete LoggerConfig
• get - Get LoggerConfig by ID
• update - Update LoggerConfig

logger_configs

• get - Get a list of LoggerConfig objects

lookup

• create - Create LookupFile
• delete - Delete LookupFile
• get - Get LookupFile by ID
• update - Update LookupFile
• upload - Upload LookupFile

lookups

• get - Get a list of LookupFile objects

mapping_ruleset

• create - Create MappingRuleset
• delete - Delete MappingRuleset
• get - Get MappingRuleset by ID
• update - Update MappingRuleset

mapping_ruleset_id

• get - Get MappingRuleset by ID

mapping_rulesets

• delete - Delete MappingRuleset
• get - Get a list of MappingRuleset objects
• update - Update MappingRuleset

master_node_package

• post - Upgrade master node with the provided package

metrics

• post - Enumerate all internal system metrics
• query - Query raw internal system metrics

notification_target

• create - Create NotificationTarget
• delete - Delete NotificationTarget
• get - Get NotificationTarget by ID
• update - Update NotificationTarget

notification_targets

• get - Get a list of NotificationTarget objects

object_function

• get - Get a list of Function objects

output_id

• delete - Delete Output
• get - Get Output by ID
• update - Update Output

output_object

• create - Create Output

output_objects

• get - Get a list of Output objects

output_status

• get - Get a list of OutputStatus objects

output_status_id

• get - Get OutputStatus by ID

pack

• clone - Clone Pack
• export - Export Pack
• install - Install Pack
• uninstall - Uninstall Pack from the system
• upgrade - Upgrade Pack
• upload - Upload Pack

packs

• get - Get info on packs

parser_id

• delete - Delete Parser
• get - Get Parser by ID
• update - Update Parser

parser_object

• post - Create Parser

pipeline_id

• delete - Delete Pipeline
• get - Get Pipeline by ID
• update - Update Pipeline

pipeline_object

• get - Get a list of Pipeline objects

policy_rule

• create - Create PolicyRule
• delete - Delete PolicyRule
• get - Get PolicyRule by ID
• update - Update PolicyRule

policy_rules

• get - Get a list of PolicyRule objects

previous_cribl_package

• get - Get the previously downloaded Cribl package

process_running_detail

• get - Get details of a process running on the edge host

processes

• get - Get a list of processes under management

profiler

• create - Create ProfilerItem
• delete - Delete ProfilerItem
• get - Get ProfilerItem by ID
• update - Update ProfilerItem

profilers

• get - Get a list of ProfilerItem objects

query_snippet

• apply - Applies a query snippet on a set of input events for preview

redirect_info

• get - Obtain redirect information

redirect_user_auth

• logout - Redirect user to IDP with logout request

regex_lib_entry

• delete - Delete RegexLibEntry
• post - Create RegexLibEntry
• update - Update RegexLibEntry

regex_lib_entry_id

• get - Get RegexLibEntry by ID

regex_lib_entry_object

• get - Get a list of RegexLibEntry objects

reload_cribl_settings

• post - Reload Cribl settings from the filesystem

remote_repo

• sync - syncs with remote repo via POST requests

request_auth

• get - Accepts an authentication request from an IDP and authenticates the user
• post - API call that the IDP should use for an authentication request

request_user_auth

• logout - API call that the IDP should use for a logout request

rest_secret

• create - Create RestSecret
• delete - Delete RestSecret
• get - Get RestSecret by ID
• update - Update RestSecret

rest_secrets

• get - Get a list of RestSecret objects

restart_cribl_settings

• post - Restart Cribl server

role

• create - Create Role
• delete - Delete Role
• get - Get Role by ID
• update - Update Role

roles

• get - Get a list of Role objects

route_list_id

• get - List all routes by id

route_lists

• get - List all routes

route_object

• update - Add, delete or update the routes with the required content.

sample_content

• get - Get sample content by ID

sample_events

• post - Sends sample events through a pipeline and returns the results

sample_output

• post - Send sample data to an output to validate configuration or test connectivity

saved_job

• delete - Delete SavedJob
• get - Get SavedJob by ID
• update - Update SavedJob

saved_jobs

• create - Create SavedJob
• get - Get a list of SavedJob objects

saved_queries

• create - Create SavedQuery
• delete - Delete SavedQuery
• get - Get a list of SavedQuery objects
• update - Update SavedQuery

saved_query

• get - Get SavedQuery by ID

schema

• create - Create Schema
• delete - Delete Schema
• get - Get Schema by ID
• post - Create Schema
• update - Update Schema

schema_id

• delete - Delete Schema
• get - Get Schema by ID
• update - Update Schema

schemas

• get - Get a list of Schema objects

script

• create - Create Script
• delete - Delete Script
• get - Get Script by ID
• update - Update Script

scripts

• get - Get a list of Script objects

search

• dispatch_search - Dispatch search id to worker nodes filtered by worker node filter using RPC

search_doc

• get - Get Search documentation

search_job

• create - Create SearchJob
• delete - Delete SearchJob
• get - Get SearchJob by ID
• update - Update SearchJob

search_job_metrics

• get - Get search job metrics

search_jobs

• get - Get a list of SearchJob objects

search_limits

• get - Get search limits

search_logs

• get - Get search logs

search_timeline

• get - Get search timeline

specified_output

• get - Get samples data for the specified output. Used to get sample data for the test action.

stage_distributed_package

• post - Stage distributed group upgrade

system_info

• get - Get basic system information

task_error

• get - Get Task errors for a job by id

task_errors

• get - Get Task errors for a job by id

test_database_connection

• post - Test a database connection given a type and connectionString

textual_diff

• get - get the textual diff for given commit

trust_policies

• get - Get a list of TrustPolicy objects

ui_state

• get - Get UI state by key
• update - Update UI state by key

user

• create_user - Create User

user_auth

• logout - Log current user out

user_id

• delete - Delete User
• get - Get User by ID

user_object

• get - Get a list of User objects
• update - Update User except for their roles

user_properties

• update - Update User properties – admin use only

versioning

• get - Get info about versioning availability

worker_edge_nodes

• get - get worker and edge nodes
• restarts - restarts worker nodes

worker_edge_nodes_count

• get - get worker and edge nodes count

working_tree

• get - get the the working tree status

Maturity

This 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.

Contributions

While 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 by Speakeasy