/

/Pipeline API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v1

latestOpenAPI 3.1.02026-07-26189891.1 MB

Account

Get account details

Get list of settings applied to an account

get/pipeline/account

Response

Default Response

All 189 operations

get Get account details
patch Update account details
put Update pipeline processing status
get List all threshold alerts
post Add usage alert
post Create component alert
put Update component alert
delete Delete component alert
get Fetch component alert
get List component alerts
get Retrieves an existing usage threshold alert
put Update threshold alert
delete Remove usage threshold alert
patch Partially update an existing threshold alert
get Get Archive Configuration
put Update Archive Configuration
post Create Archive Configuration
delete Delete Archive Configuration
get List Boards
post Create Board
get Get Board
delete Delete Board
get List Categories
post Create New Category
get List Preset Alerts
post Create Preset Alert
get List Views
post Create View
get Get Preset Alert
put Update Alert
delete Delete Alert
get Get Category
put Update Category
delete Delete Category
get Get View
put Update View
delete Delete View
get Fetch classifier information
get Fetch usage metrics
get Get Field Summary for an analysis
get Get Field Summary values for a field in an analysis
get /pipeline/{pipeline_id}/transform/{pipeline_transform_id}/classifier/analysis
get /pipeline/transform/classifier/analysis
patch Update analysis options
post Add task result
post Fetch logs from Edge
get Get client config
post Post client config
post Get usage metrics
get List all heartbeats
get Poll tasks
delete Remove heartbeat
get List all accounts
post Attach a child organization to an enterprise
get Retrieve a specific entperise key
delete Delete an Enterprise ServiceKey
get Get details of a child organization
put Update Child Organization Contract
delete Detach a child org from Enterprise
get List all enterprise keys
post Generate a new Key for the Enterprise
get List Exclusion Rules
post Create Exclusion Rule
get Get Exclusion Rule
delete Delete Exclusion Rule
patch Update Exclusion Rule
post Use AI to automatically parse log text into JSON
post Use AI to generate Regular Expressions
get Export log lines
get Export log lines
get List Groups
post Create Group
get Get Group
delete Delete Group
patch Update Group
get List all state variables
post Create state variable
patch Partially update state variable
get Fetch state variable
put Update state variable
get Get Index Rate Alert
put Update Index Rate Alert
post Send Log Lines
get Retrieve a list of all the keys
post Create a new key
get Retrieve a specific key
put Update one or more fields of a key resource
delete Delete a specific key
post Log Volume Reduction
get Lists all members
post Creates a new member
get Retrieve a member
put Update a member
delete Delete a member
get Fetch account usage metics
get Fetch log cluster samples
get Fetch log usage metrics
get Fetch pipeline health metrics
get Get event metrics for a pipeline
get Get Parsing Template
delete Delete Parsing Template
get List Parsing Templates
post Trigger pipeline export
post Add prebuilt pipeline to account
get List all pipelines
post Create pipeline
get Fetch pipeline confg
put Update pipeline
delete Deletes a pipeline
get Fetch audit events
get Fetch pipeline revision
post Initialize a pipeline with provided components. All sources, transforms, and sinks are linked.
post Initialize a pipeline with provided components. The links for all components have to be determined by the caller.
get List all pipeline revisions
get List available pipeline nodes
post Publish pipeline
post Revert pipeline to version
get Summarize pipeline health for one or more pipelines
post Add a sink to a pipeline
post Add source
post Add transform
put /pipeline/{pipeline_id}/transform-group/{pipeline_transform_group_id}
delete /pipeline/{pipeline_id}/transform-group/{pipeline_transform_group_id}
get Fetch sink
put Update sink
delete Delete sink
get Fetch transform
put Update transform
delete Remove transform
post /pipeline/{pipeline_id}/transform-group
get Retrieve source
put Update source
delete Remove source
get /transform-group/{transform_group_id}
put /transform-group/{transform_group_id}
delete /transform-group/{transform_group_id}
get /transform-group/{transform_group_id}/transform/{transform_group_transform_id}
put /transform-group/{transform_group_id}/transform/{transform_group_transform_id}
delete /transform-group/{transform_group_id}/transform/{transform_group_transform_id}
get /transform-group
post /transform-group
get /transform-group/{transform_group_id}/revision/{transform_group_revision_lookup}
get /transform-group/{transform_group_id}/revision
post /transform-group/{transform_group_id}/publish
post /transform-group/{transform_group_id}/transform
post /transform-group/from-pipeline
get List data samples
post Create data sample
get Fetch data sample
put Update data sample
delete Delete data sample
post /transform-group/{transform_group_id}/simulate
get Retrieve grok pattern
post Simulate grok pattern
post Simulate regex pattern
post Simulate timestamp pattern
post Start pipeline tap
post Start simulation of pipeline
get List all screens
post Creates a new screen
get Retrieve a screen
delete Delete a screen
put Add signing key
post Create access key
get List all gateway routes
post Create gateway route
delete Delete access key
get Retrieve gateway route
put Update gateway route
delete Delete gateway route
patch Update gateway route property
delete Delete signing key
post Confirm Ingestion Suspension
get Get Ingestion Status
post Initiate Ingestion Suspension
post Resume Ingestion
get Get Usage By App
get Get Usage by Host
get Get Usage by Tag
get List Usage By App
get List Usage by Host
get List Usage by Tag
get Get Usage By App
get Get Usage by Host
get Get Usage by Tag
get List Usage By App
get List Usage by Host
get List Usage by Tag
get Retrieve account usage totals