Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Delta Pipeline API

The Pipeline API from Edge Delta — 4 operation(s) for pipeline.

Edge Delta Pipeline API is one of 19 APIs that Edge Delta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pipeline. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 126 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://api.edgedelta.com.

4 operations 4 paths 126 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.edgedelta.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Edge Delta Pipeline API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ED-API-Token (ApiKeyAuth).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Pipeline 4
POST
/v1/orgs/{org_id}/pipelines/base
Creates a Pipeline with base configuration according to environment and fleet subtype
2 params → 200
POST
/v1/orgs/{org_id}/pipelines/{conf_id}/deploy/{version}
Deploys the pipeline configuration. Version is the timestamp of the Pipeline history. Pipeline history should be called to get the version.
3 params → 200
GET
/v1/orgs/{org_id}/pipelines/{conf_id}/history
Returns the history of a Pipeline configuration. Timestamp of the Pipeline history is used as version when deploying the Pipeline.
3 params → 200
POST
/v1/orgs/{org_id}/pipelines/{conf_id}/save
Saves the pipeline configuration
4 params → 200

Schemas 126

The contract defines 126 schemas that model the data the API accepts and returns. The most detailed are configv3.Node (412 properties), configv3.SequenceProcessor (75 properties), core.HostedAgentEnv (23 properties), configv3.EDSetting (22 properties). Each schema is shown below with its type and property counts.

core.FleetType
string
core.ConfigHistoryStatus
string
configv3.Authorization
object
2 properties
configv3.MetricConfig
object
9 properties
configv3.ResourceFields
object
4 properties
configv3.ResilienceConfig
object
1 property
configv3.CustomLabels
object
3 properties
configv3.Link
object
3 properties
core.HostedEnvState
string
core.BaseConfCreateRequest
object
5 properties 2 required
core.ConfPurpose
string
configv3.Key
object
1 property
configv3.OID
object
3 properties
core.CloudProviderType
string
configv3.ExtractMetricSum
object
3 properties
core.HostedAgentEnv
object
23 properties
configv3.LiveTailSettings
object
8 properties
configv3.FieldMapping
object
3 properties
configv3.FieldMappings
object
4 properties
configv3.InputDiscovery
object
2 properties
configv3.LookupField
object
4 properties
pipeline.GetVisualPipelineResponse
object
16 properties
nodetype.NodeCategory
string
configv3.Node
object
412 properties 2 required
nodetype.NodeSubcategory
string
core.ConfCreateResponse
object
21 properties
core.TemplateType
string
configv3.RoutePath
object
3 properties
configv3.SyslogMultiline
object
3 properties
configv3.SASL
object
4 properties
configv3.DroppedColumn
object
3 properties
nodetype.NodeType
string
configv3.KuduConnectionConfig
object
4 properties
configv3.OTTLContextFilter
object
2 properties
configv3.ValueAdjustmentRule
object
3 properties
core.PipelinePrimaryState
string
configv3.SamplingCaches
object
3 properties
configv3.OtelTLS
object
4 properties
configv3.SplunkHECAuthentication
object
2 properties
configv3.InputRateLimit
object
1 property
configv3.SamplingCache
object
1 property
configv3.AggregateMetricRule
object
7 properties
configv3.K8sEventRBACRule
object
3 properties
types.DataFormat
string
configv3.Parameter
object
2 properties
core.ItemSchema
string
configv3.PersistentQueue
object
5 properties
nodetype.NodeVisibility
string
configv3.Secret
object
2 properties
pipeline.VisualizerNode
object
20 properties
configv3.EDSetting
object
22 properties
configv3.MetricColumnOptions
object
1 property
pipeline.Pipeline
object
8 properties
configv3.Attribute
object
2 properties
configv3.MetadataMapping
object
7 properties
configv3.KuduColumn
object
6 properties
configv3.KuduBatchConfig
object
3 properties
core.ConfigHistory
object
7 properties
configv3.InheritHeaders
object
3 properties
pipeline.NodeTemplatesStatus
object
4 properties
core.PipelineSubStatus
string
pipeline.PathOutput
object
4 properties
configv3.CircuitBreakerConfig
object
7 properties
configv3.PersistingCursorSettings
object
3 properties
configv3.ParameterExpression
object
2 properties
core.ConfigVersion
string
configv3.ExtractMetricGauge
object
1 property
core.TLS
object
9 properties
configv3.SourceFieldOverride
object
2 properties
configv3.AggregateMetricAggregationOptions
object
2 properties
core.HostedEnvPurpose
string
configv3.TransformField
object
4 properties
core.DeployStep
object
2 properties
pipeline.SaveRequest
object
3 properties
configv3.HeaderExpression
object
2 properties
configv3.EDLogs
object
7 properties
configv3.ReadSettings
object
4 properties
configv3.KuduSecurityConfig
object
3 properties
configv3.HTTPWorkflowStep
object
18 properties
core.FleetStatus
string
core.PipelineSubStateCategory
string
configv3.DimGroup
object
15 properties
configv3.TLS
object
10 properties
configv3.EndpointResolution
string
configv3.CustomTag
object
2 properties
configv3.CaptureGroupMask
object
4 properties
core.PipelineSubState
object
3 properties
configv3.K8sEventRBACConfig
object
1 property
core.FleetSubtype
string
configv3.HTTPWorkflowIterator
object
4 properties
core.PipelineStateSummary
object
3 properties
core.EnvironmentType
string
configv3.HTTPPaginationConfig
object
10 properties
configv3.SplunkHECStaticAuth
object
5 properties
configv3.ParallelismSettings
object
3 properties
configv3.SamplingPolicy
object
18 properties
configv3.InputRateLimitPolicy
object
6 properties
configv3.KerberosConfig
object
5 properties
configv3.GlobalHealthConfig
object
6 properties
flog.Format
string
configv3.AWSConfig
object
5 properties
configv3.SequenceProcessor
object
75 properties
configv3.BodyMapping
object
2 properties
core.ConfMetadata
object
3 properties
configv3.SyslogAsync
object
3 properties
configv3.ExtractMetricRule
object
6 properties
configv3.HTTPWorkflowWebhook
object
13 properties
pipeline.NodeDataType
string
configv3.WeightedDestination
object
2 properties
core.ConfCompoundNodesMetadata
object
3 properties
configv3.AuthenticationConf
object
4 properties
core.HostedEnvStatus
string
configv3.AuthorizationClientCredentials
object
6 properties
configv3.InputSourceMetadata
object
2 properties
configv3.ClickHouseColumn
object
5 properties
configv3.Header
object
2 properties
configv3.TargetAllocation
string
configv3.MemoryBuffer
object
1 property
configv3.HTTPWorkflowRedisCache
object
18 properties
configv3.ConnectorMetadata
object
4 properties
configv3.LoadReporting
object
4 properties
configv3.K8sCustomResourceConfig
object
3 properties
configv3.ConnectorEventEntry
object
4 properties
configv3.OTTLContextFilterContext
object
3 properties
datasize.Size
integer
configv3.PathPrefix
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-delta-pipeline-api-openapi.yml Raw ↑

Other APIs Edge Delta publishes across the network.

Edge Delta Access API
Edge Delta Add Source API
Edge Delta Agent Configs API
Edge Delta AI API
Edge Delta Event Search API
Edge Delta Get Dashboard API
Edge Delta Get Dashboards API
Edge Delta Get Metrics API
Edge Delta Group Members API
Edge Delta Groups API
Edge Delta Integrations API
Edge Delta Log Search API