Feldera Pipeline Lifecycle API
The Pipeline Lifecycle API from Feldera — 20 operation(s) for pipeline lifecycle.
Feldera Pipeline Lifecycle API is one of 6 APIs that Feldera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Pipeline Lifecycle. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 20 operations across 20 paths, and defines 117 schemas. It is described by OpenAPI 3.0.3, at version 0.323.0.
Requests are made against the base URL https://try.feldera.com.
20 operations
20 paths
117 schemas
5 GET15 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Feldera Pipeline Lifecycle API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (JSON web token (JWT) or API key).
JSON web token (JWT) or API key— Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the /v0/api-keys endpoint.
Paths & Operations 20
Across 20 paths, the API surfaces 20 operations — 5 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.
Pipeline Lifecycle 20
POST
/v0/pipelines/{pipeline_name}/activate
Activate Standby Pipeline
POST
/v0/pipelines/{pipeline_name}/approve
Approve Bootstrap
POST
/v0/pipelines/{pipeline_name}/checkpoint
Checkpoint Now
POST
/v0/pipelines/{pipeline_name}/checkpoint/sync
Sync Checkpoints To S3
GET
/v0/pipelines/{pipeline_name}/checkpoint/sync_status
Get Checkpoint Sync Status
GET
/v0/pipelines/{pipeline_name}/checkpoint_status
Get Checkpoint Status
GET
/v0/pipelines/{pipeline_name}/checkpoints
Get the checkpoints for a pipeline
GET
/v0/pipelines/{pipeline_name}/checkpoints/remote
List checkpoints in remote object storage
POST
/v0/pipelines/{pipeline_name}/clear
Clear Storage
POST
/v0/pipelines/{pipeline_name}/commit_transaction
Commit Transaction
POST
/v0/pipelines/{pipeline_name}/dismiss_error
Dismiss Pipeline Deployment Error
POST
/v0/pipelines/{pipeline_name}/pause
Pause Pipeline
GET
/v0/pipelines/{pipeline_name}/query
Execute Ad-hoc SQL
POST
/v0/pipelines/{pipeline_name}/rebalance
Initiate rebalancing.
POST
/v0/pipelines/{pipeline_name}/resume
Resume Pipeline
POST
/v0/pipelines/{pipeline_name}/start
Start Pipeline
POST
/v0/pipelines/{pipeline_name}/start_compaction
Initiate compaction.
POST
/v0/pipelines/{pipeline_name}/start_transaction
Begin Transaction
POST
/v0/pipelines/{pipeline_name}/stop
Stop Pipeline
POST
/v0/pipelines/{pipeline_name}/update_runtime
Recompile Pipeline
Schemas 117
The contract defines 117 schemas that model the data the API accepts and returns. The most detailed are DevTweaks (26 properties), RuntimeConfig (24 properties), SyncConfig (22 properties), DeltaTableReaderConfig (16 properties). Each schema is shown below with its type and property counts.
FormatConfig
object
Data format specification used to parse raw data received from the endpoint or to encode data sent to the endpoint.
2 properties
1 required
FileInputConfig
object
Configuration for reading data from a file with FileInputTransport
3 properties
1 required
SyncConfig
object
22 properties
1 required
Version
integer
Version number.
SqlCompilationInfo
object
SQL compilation information.
2 properties
2 required
PipelineId
string
Pipeline identifier.
ProgramStatus
string
Program compilation status.
HttpInputConfig
object
Configuration for data input via HTTP. HTTP input adapters cannot be usefully configured as part of pipeline configuration. Instead, instantiate them through t…
1 property
1 required
CheckpointResponse
object
Response to a checkpoint request.
1 property
1 required
BootstrapPolicy
string
DatagenInputConfig
object
Configuration for generating random data for a table.
4 properties
SqlType
string
The available SQL column type names. Each value is the platform's wire encoding of the type (e.g. BIGINT, INTEGER, INTERVALDAY), not valid SQL type syntax.
DynamoDBWriteMode
string
DynamoDB write API used by the output connector.
StorageCompression
string
Storage compression algorithm.
S3InputConfig
object
Configuration for reading data from AWS S3.
10 properties
2 required
ObjectStorageConfig
object
1 property
1 required
Credentials
RuntimeStatusDetails
object
Details about the current runtime status. The fields in this struct should all be optional and set only by a runtime status when they are known. Otherwise, the…
3 properties
PropertyValue
object
3 properties
3 required
GlueCatalogConfig
object
AWS Glue catalog config.
8 properties
DatagenStrategy
string
Strategy used to generate values.
CheckpointMetadata
object
Holds meta-data about a checkpoint that was taken for persistent storage and recovery of a circuit's state.
6 properties
2 required
KafkaHeader
object
Kafka message header.
2 properties
1 required
ProgramError
object
Log, warning and error information about the program compilation.
3 properties
UrlInputConfig
object
Configuration for reading data from an HTTP or HTTPS URL with UrlInputTransport.
2 properties
1 required
IcebergIngestMode
string
Iceberg table read mode. Three options are available: snapshot - read a snapshot of the table and stop. follow - continuously ingest changes to the table, star…
TransportConfig
Transport-specific endpoint configuration passed to crate::OutputTransport::newendpoint and crate::InputTransport::newendpoint.
CombinedStatus
string
StorageStatus
string
Storage status. The storage status can only transition when the resources status is Stopped. text Cleared ───┐ ▲ │ /clear │ │ │ │ Clearing │ ▲ │ │ │ InUse ◄───┘
PipelineInfo
Pipeline information. It both includes fields which are user-provided and system-generated.
FileBackendConfig
object
Configuration for local file system access.
3 properties
ResourceConfig
object
8 properties
NatsInputConfig
object
5 properties
3 required
RuntimeConfig
object
Global pipeline configuration settings. This is the publicly exposed type for users to configure pipelines.
24 properties
CheckpointSyncFailure
object
Information about a failed checkpoint sync.
2 properties
2 required
CheckpointStatus
object
Checkpoint status returned by the /checkpointstatus endpoint.
2 properties
ConnectOptions
object
Options for connecting to a NATS server.
4 properties
1 required
StartTransactionResponse
object
Response to a /starttransaction request.
1 property
1 required
ProgramConfig
object
Program configuration.
4 properties
DeltaTableWriteMode
string
Delta table write mode. Determines how the Delta table connector handles an existing table at the target location.
ProgramSchema
object
A struct containing the tables (inputs) and views for a program. Parse from the JSON data-type of the DDL generated by the SQL compiler.
2 properties
2 required
DeliverPolicy
AdHocInputConfig
object
Configuration for inserting data with ad-hoc queries An ad-hoc input adapters cannot be usefully configured as part of pipeline configuration. Instead, use ad-…
1 property
1 required
PostgresReaderConfig
Postgres input connector configuration.
SqlCompilerMessage
object
A SQL compiler error. The SQL compiler returns a list of errors in the following JSON format if it's invoked with the -je option. ignore [ { "startlinenumber"…
8 properties
7 required
KafkaOutputConfig
object
Configuration for writing data to a Kafka topic with OutputTransport.
7 properties
1 required
ColumnType
object
A SQL column type description. Matches the Calcite JSON format.
8 properties
1 required
StorageStatusDetails
object
Details about pipeline storage, which are returned as part of the regular runtime status polling by the runner.
1 property
1 required
MergerType
string
Which merger to use.
IcebergCatalogType
string
FtConfig
object
Fault-tolerance configuration. The default [FtConfig] (via [FtConfig::default]) disables fault tolerance, which is the configuration that one gets if [RuntimeC…
2 properties
DeltaTableWriterConfig
object
Delta table output connector configuration.
7 properties
1 required
ConsumerConfig
object
11 properties
1 required
StorageOptions
object
Storage configuration for a pipeline.
5 properties
BufferCacheAllocationStrategy
string
Controls how caches are shared across a foreground/background worker pair.
PartialProgramInfo
object
Program information is the result of the SQL compilation.
4 properties
4 required
CheckpointSyncStatus
object
Checkpoint status returned by the /checkpoint/syncstatus endpoint.
3 properties
StartFromCheckpoint
RedisOutputConfig
object
Redis output connector configuration.
2 properties
1 required
UserAndPassword
object
2 properties
2 required
PostgresWriteMode
string
PostgreSQL write mode. Determines how the PostgreSQL output connector writes data to the target table.
Auth
object
5 properties
PostgresWriterConfig
Postgres output connector configuration.
KafkaHeaderValue
string
Kafka header value encoded as a UTF-8 string or a byte array.
PostprocessorConfig
object
Configuration for describing a postprocessor
2 properties
2 required
CombinedDesiredStatus
string
AdHocResultFormat
string
URL-encoded format argument to the /query endpoint.
DeltaTableReaderConfig
object
Delta table input connector configuration.
16 properties
2 required
RestCatalogConfig
object
Iceberg REST catalog config.
10 properties
StorageBackendConfig
Backend storage configuration.
RemoteCheckpoint
object
A checkpoint that exists in remote object storage.
1 property
1 required
DynamoDBWriterConfig
object
DynamoDB output connector configuration.
13 properties
2 required
ErrorResponse
object
Information returned by REST API endpoints on error.
3 properties
3 required
IcebergReaderConfig
Iceberg input connector configuration.
PipelineTemplateConfig
object
Configuration for supplying a custom pipeline StatefulSet template via a Kubernetes ConfigMap. Operators can provide a custom StatefulSet YAML that the Kuberne…
2 properties
1 required
ReplayPolicy
string
OutputBufferConfig
object
3 properties
Field
A SQL field. Matches the SQL compiler JSON format.
DevTweaks
object
Optional settings for tweaking Feldera internals. These settings reflect experiments that may come and go and change from version to version. Users should not…
26 properties
HttpOutputConfig
object
Configuration for data output via HTTP. HTTP output adapters cannot be usefully configured as part of pipeline configuration. Instead, instantiate them through…
1 property
RngFieldSettings
object
Configuration for generating random data for a field of a table.
9 properties
CompilationProfile
string
Enumeration of possible compilation profiles that can be passed to the Rust compiler as an argument via cargo build --profile <. A compilation profile affects…
ConnectorStats
object
Statistics across all connectors.
1 property
1 required
RustCompilationInfo
object
Rust compilation information.
3 properties
3 required
OutputEndpointConfig
Describes an output connector configuration
ClockConfig
object
3 properties
1 required
PubSubInputConfig
object
Google Pub/Sub input connector configuration.
10 properties
1 required
DeltaTableTransactionMode
string
Delta table transaction mode. Determines how the connector breaks up its input into transactions. none - the connector does not break up its input into transac…
HeaderFilter
A boolean filter over the headers of a Kafka message. The Kafka input connector uses this to drop messages whose headers do not satisfy a predicate. It is a tr…
PostgresCdcReaderConfig
Postgres CDC input connector configuration. Uses logical replication to capture ongoing changes from a Postgres database. Requires a pre-created publication an…
NexmarkInputConfig
object
Configuration for generating Nexmark input data. This connector must be used exactly three times in a pipeline if it is used at all, once for each [NexmarkTabl…
2 properties
1 required
PreprocessorConfig
object
Configuration for describing a preprocessor
3 properties
3 required
ConnectorConfig
S3TablesCatalogConfig
object
Amazon S3 Tables catalog config.
7 properties
CheckpointSyncResponse
object
Response to a sync checkpoint request.
1 property
1 required
ClientMetadata
object
Client-generated data stored alongside a pipeline. The fields are stored together as a single JSON object in the clientmetadata text column, so adding a field…
2 properties
CheckpointFailure
object
Information about a failed checkpoint.
3 properties
3 required
ResourcesStatus
string
Pipeline resources status. text /start (early start or provision check failed) ┌───┐ │ ▼ Stopped ◄────────── Stopping /start │ ▲ │ │ /stop?force=true │ │ OR: t…
FtModel
string
Fault tolerance model. The ordering is significant: we consider [Self::ExactlyOnce] to be a "higher level" of fault tolerance than [Self::AtLeastOnce].
SourcePosition
object
4 properties
4 required
InputEndpointConfig
Describes an input connector configuration
KafkaInputConfig
object
Configuration for reading data from Kafka topics with InputTransport.
15 properties
2 required
KafkaLogLevel
string
Kafka logging levels.
HeaderMatch
object
A leaf of a [HeaderFilter]: a regular expression tested against the value of a named Kafka header.
2 properties
2 required
KafkaStartFromConfig
Where to begin reading a Kafka topic.
BufferCacheStrategy
string
Selects which eviction strategy backs a cache instance.
ResourcesDesiredStatus
string
SqlIdentifier
object
An SQL identifier. This struct is used to represent SQL identifiers in a canonical form. We store table names or field names as identifiers in the schema.
2 properties
2 required
GenerationPlan
object
A random generation plan for a table that generates either a limited amount of rows or runs continuously.
4 properties
Relation
A SQL table or view. It has a name and a list of fields. Matches the Calcite JSON format.
NexmarkInputOptions
object
Configuration for generating Nexmark input data.
4 properties
RuntimeStatus
string
Runtime status of the pipeline. Of the statuses, only Unavailable is determined by the runner. All other statuses are determined by the pipeline and taken over…
RuntimeDesiredStatus
string
DeltaTableIngestMode
string
Delta table read mode. Three options are available: snapshot - read a snapshot of the table and stop. follow - continuously ingest changes to the table, starti…
NexmarkTable
string
Table in Nexmark.
FileOutputConfig
object
Configuration for writing data to a file with FileOutputTransport.
1 property
1 required
KafkaOutputFtConfig
object
Fault tolerance configuration for Kafka output connector.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Feldera 5
Other APIs Feldera publishes across the network.
Feldera Input Connectors API
Feldera Metrics & Debugging API
Feldera Output Connectors API
Feldera Pipeline CRUD API
Feldera Platform API
#Pipeline Lifecycle
Where this information came from
This is an independent, third-party profile of Feldera Pipeline Lifecycle API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.