{

"openapi": "3.0.3",

"info": {

"title": "Feldera API",

"description": "\nWith Feldera, users create data pipelines out of SQL programs.\nA SQL program comprises tables and views, and includes as well the definition of\ninput and output connectors for each respectively. A connector defines a data\nsource or data sink to feed input data into tables or receive output data\ncomputed by the views respectively.\n\n## Pipeline\n\nThe API is centered around the **pipeline**, which most importantly consists\nout of the SQL program, but also has accompanying metadata and configuration parameters\n(e.g., compilation profile, number of workers, etc.).\n\n* A pipeline is identified and referred to by its user-provided unique name.\n* The pipeline program is asynchronously compiled when the pipeline is first created or\n when its program is subsequently updated.\n* Pipeline deployment start is only able to proceed to provisioning once the program is successfully\n compiled.\n* A pipeline cannot be updated while it is deployed.\n\n## Concurrency\n\nEach pipeline has a version, which is incremented each time its core fields are updated.\nThe version is monotonically increasing. There is additionally a program version which covers\nonly the program-related core fields, and is used by the compiler to discern when to recompile.\n\n## Client request handling\n\n### Request outcome expectations\n\nThe outcome of a request is that it either fails (e.g., DNS lookup failed) without any response\n(no status code nor body), or it succeeds and gets back a response status code and body.\n\nIn case of a response, usually it is the Feldera endpoint that generated it:\n- If it is success (2xx), it will return whichever body belongs to the success response.\n- Otherwise, if it is an error (4xx, 5xx), it will return a Feldera error response JSON body\n which will have an application-level `error_code`.\n\nHowever, there are two notable exceptions when the response is not generated by the Feldera\nendpoint:\n- If the HTTP server, to which the endpoint belongs, encountered an issue, it might return\n 4xx (e.g., for an unknown endpoint) or 5xx error codes by itself (e.g., when it is initializing).\n- If the Feldera API server is behind a (reverse) proxy, the proxy can return error codes by itself,\n for example BAD GATEWAY (502) or GATEWAY TIMEOUT (504).\n\nAs such, it is not guaranteed that the (4xx, 5xx) will have a Feldera error response JSON body\nin these latter cases.\n\n### Error handling and retrying\n\nThe error type returned by the client should distinguish between the error responses generated\nby Feldera endpoints themselves (which have a Feldera error response body) and those that are\ngenerated by other sources.\n\nIn order for a client operation (e.g., `pipeline.resume()`) to be robust (i.e., not fail due to\na single HTTP request not succeeding) the client should use a retry mechanism if the operation\nis idempotent. The retry mechanism must however have a time limit, after which it times out.\nThis guarantees that the client operation is eventually responsive, which enables the script\nit is a part of to not hang indefinitely on Feldera operations and instead be able to decide\nby itself whether and how to proceed. If no response is returned, the mechanism should generally\nretry. When a response is returned, the decision whether to retry can generally depend on the status\ncode: especially the status codes 408, 502, 503 and 504 should be considered as transient errors.\nFiner grained retry decisions should be made by taking into account the application-level\n`error_code` if the response body was indeed a Feldera error response body.\n\n## Feldera client errors (4xx)\n\n_Client behavior:_ clients should generally return with an error when they get back a 4xx status\ncode, as it usually means the request will likely not succeed even if it is sent again. Certain\nrequests might make use of a timed retry mechanism when the client error is transient without\nrequiring any user intervention to overcome, for instance a transaction already being in progress\nleading to a temporary CONFLICT (409) error.\n\n- **BAD REQUEST (400)**: invalid user request (general).\n - _Example:_ the new pipeline name `example1@~` contains invalid characters.\n\n- **UNAUTHORIZED (401)**: the user is not authorized to issue the request.\n - _Example:_ an invalid API key is provided.\n\n- **NOT FOUND (404)**: a resource required to exist in order to process the request was not found.\n - _Example:_ a pipeline named `example` does not exist when trying to update it.\n\n- **CONFLICT (409)**: there is a conflict between the request and a relevant resource.\n - _Example:_ a pipeline named `example` already exists.\n - _Example:_ another transaction is already in process.\n\n## Feldera server errors (5xx)\n\n- **INTERNAL SERVER ERROR (500)**: the server is unexpectedly unable to process the request\n (general).\n - _Example:_ unable to reach the database.\n - _Client behavior:_ immediately return with an error.\n\n- **NOT IMPLEMENTED (501)**: the server does not implement functionality required to process the\n request.\n - _Example:_ making a request to an enterprise-only endpoint in the OSS edition.\n - _Client behavior:_ immediately return with an error.\n\n- **SERVICE UNAVAILABLE (503)**: the server is not (yet) able to process the request.\n - _Example:_ pausing a pipeline which is still provisioning.\n - _Client behavior:_ depending on the type of request, client may use a timed retry mechanism.\n\n## Feldera error response body\n\nWhen the Feldera API returns an HTTP error status code (4xx, 5xx), the body will contain the\nfollowing JSON object:\n\n```json\n{\n \"message\": \"Human-readable explanation.\",\n \"error_code\": \"CodeSpecifyingError\",\n \"details\": {\n\n }\n}\n```\n\nIt contains the following fields:\n- **message (string)**: human-readable explanation of the error that occurred and potentially\n hinting what can be done about it.\n- **error_code (string)**: application-level code about the error that occurred, written in CamelCase.\n For example: `UnknownPipelineName`, `DuplicateName`, `PauseWhileNotProvisioned`, ... .\n- **details (object)**: JSON object corresponding to the `error_code` with fields that provide\n details relevant to it. For example: if a name is unknown, a field with the unknown name in\n question.\n",

"contact": {

"name": "Feldera Team",

"email": "dev@feldera.com"

},

"license": {

"name": "MIT OR Apache-2.0"

},

"version": "0.262.0"

},

"paths": {

"/config/authentication": {

"get": {

"tags": [

"Platform"

],

"summary": "Get Auth Config",

"description": "Retrieve the authentication provider configuration.",

"operationId": "get_config_authentication",

"responses": {

"200": {

"description": "The response body contains Authentication Provider configuration, or is empty if no auth is configured.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/AuthProvider"

}

}

}

},

"500": {

"description": "Request failed.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

}

}

},

"/v0/api_keys": {

"get": {

"tags": [

"Platform"

],

"summary": "List API Keys",

"description": "Retrieve a list of your API keys.",

"operationId": "list_api_keys",

"responses": {

"200": {

"description": "API keys retrieved successfully",

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/ApiKeyDescr"

}

}

}

}

},

"500": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

},

"post": {

"tags": [

"Platform"

],

"summary": "Create API Key",

"description": "Create a new API key with the specified name. The generated API key\nwill be returned in the response and cannot be retrieved again later.",

"operationId": "post_api_key",

"requestBody": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/NewApiKeyRequest"

}

}

},

"required": true

},

"responses": {

"201": {

"description": "API key created successfully",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/NewApiKeyResponse"

}

}

}

},

"409": {

"description": "API key with that name already exists",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

},

"example": {

"message": "An entity with this name already exists",

"error_code": "DuplicateName",

"details": null

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/api_keys/{api_key_name}": {

"get": {

"tags": [

"Platform"

],

"summary": "Get API Key",

"description": "Retrieve the metadata of a specific API key by its name.",

"operationId": "get_api_key",

"parameters": [

{

"name": "api_key_name",

"in": "path",

"description": "Unique API key name",

"required": true,

"schema": {

"type": "string"

}

}

],

"responses": {

"200": {

"description": "API key retrieved successfully",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ApiKeyDescr"

}

}

}

},

"404": {

"description": "API key with that name does not exist",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

},

"example": {

"message": "Unknown API key 'non-existent-api-key'",

"error_code": "UnknownApiKey",

"details": {

"name": "non-existent-api-key"

}

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

},

"delete": {

"tags": [

"Platform"

],

"summary": "Delete API Key",

"description": "Remove an API key by its name.",

"operationId": "delete_api_key",

"parameters": [

{

"name": "api_key_name",

"in": "path",

"description": "Unique API key name",

"required": true,

"schema": {

"type": "string"

}

}

],

"responses": {

"200": {

"description": "API key deleted successfully"

},

"404": {

"description": "API key with that name does not exist",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

},

"example": {

"message": "Unknown API key 'non-existent-api-key'",

"error_code": "UnknownApiKey",

"details": {

"name": "non-existent-api-key"

}

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/cluster/events": {

"get": {

"tags": [

"Platform"

],

"summary": "List Cluster Events",

"description": "Retrieve a list of retained cluster monitor events ordered from most recent to least recent.\n\nThe returned events only have limited details, the full details can be retrieved using\nthe `GET /v0/cluster/events/<event-id>` endpoint.\n\nCluster monitor events are collected at a periodic interval (every 10s), however only\nevery 10 minutes or if the overall health changes, does it get inserted into the database\n(and thus, served by this endpoint). At most 1000 events are retained (newest first),\nand events older than 72h are deleted. The latest event, if it already exists, is never\ncleaned up.",

"operationId": "list_cluster_events",

"responses": {

"200": {

"description": "",

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/ClusterMonitorEventSelectedInfo"

}

}

}

}

},

"500": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"501": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/cluster/events/{event_id}": {

"get": {

"tags": [

"Platform"

],

"summary": "Get Cluster Event",

"description": "Get specific cluster monitor event.\n\nThe identifiers of the events can be retrieved via `GET /v0/cluster/events`.\nAt most 1000 events are retained (newest first), and events older than 72h are deleted.\nThe latest event, if it already exists, is never cleaned up.\nThis endpoint can return a 404 for an event that no longer exists due to clean-up.",

"operationId": "get_cluster_event",

"parameters": [

{

"name": "event_id",

"in": "path",

"description": "Cluster monitor event identifier or `latest`",

"required": true,

"schema": {

"type": "string"

}

},

{

"name": "selector",

"in": "query",

"description": "The `selector` parameter limits which fields are returned.\nLimiting which fields is particularly handy for instance when frequently\nmonitoring over low bandwidth connections while being only interested\nin status.",

"required": false,

"schema": {

"$ref": "#/components/schemas/ClusterMonitorEventFieldSelector"

}

}

],

"responses": {

"200": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ClusterMonitorEventSelectedInfo"

}

}

}

},

"404": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"500": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"501": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/cluster_healthz": {

"get": {

"tags": [

"Platform"

],

"summary": "Check Cluster Health",

"description": "Determine the latest cluster health via the latest cluster monitor event.",

"operationId": "get_cluster_health",

"responses": {

"200": {

"description": "All services healthy",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/HealthStatus"

}

}

}

},

"503": {

"description": "One or more services unhealthy",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/HealthStatus"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/config": {

"get": {

"tags": [

"Platform"

],

"summary": "Get Platform Config",

"description": "Retrieve configuration of the Feldera Platform.",

"operationId": "get_config",

"responses": {

"200": {

"description": "The response body contains basic configuration information about this host.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/Configuration"

}

}

}

},

"500": {

"description": "Request failed.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/config/demos": {

"get": {

"tags": [

"Platform"

],

"summary": "List Demos",

"description": "Retrieve the list of demos available in the WebConsole.",

"operationId": "get_config_demos",

"responses": {

"200": {

"description": "List of demos",

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Demo"

}

}

}

}

},

"500": {

"description": "Failed to read demos from the demos directories",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/config/session": {

"get": {

"tags": [

"Platform"

],

"summary": "Get Session",

"description": "Retrieve login session information for your current user session.",

"operationId": "get_config_session",

"responses": {

"200": {

"description": "The response body contains current session information including tenant details.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/SessionInfo"

}

}

}

},

"500": {

"description": "Request failed.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/metrics": {

"get": {

"tags": [

"Metrics & Debugging"

],

"summary": "List All Metrics",

"description": "Retrieve the metrics of all running pipelines belonging to this tenant.\n\nThe metrics are collected by making individual HTTP requests to `/metrics`\nendpoint of each pipeline, of which only successful responses are included\nin the returned list.",

"operationId": "get_metrics",

"responses": {

"200": {

"description": "Metrics of all running pipelines belonging to this tenant in Prometheus format",

"content": {

"text/plain": {

"schema": {

"type": "string",

"format": "binary"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/pipelines": {

"get": {

"tags": [

"Pipeline CRUD"

],

"summary": "List Pipelines",

"description": "Retrieve the list of pipelines.\nConfigure which fields are included using the `selector` query parameter.",

"operationId": "list_pipelines",

"parameters": [

{

"name": "selector",

"in": "query",

"description": "The `selector` parameter limits which fields are returned for a pipeline.\nLimiting which fields is particularly handy for instance when frequently\nmonitoring over low bandwidth connections while being only interested\nin pipeline status.",

"required": false,

"schema": {

"$ref": "#/components/schemas/PipelineFieldSelector"

}

}

],

"responses": {

"200": {

"description": "List of pipelines retrieved successfully",

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/PipelineSelectedInfo"

}

},

"example": [

{

"id": "67e55044-10b1-426f-9247-bb680e5fe0c8",

"name": "example1",

"description": "Description of the pipeline example1",

"created_at": "1970-01-01T00:00:00Z",

"version": 4,

"platform_version": "v0",

"runtime_config": {

"workers": 16,

"hosts": 1,

"storage": {

"backend": {

"name": "default"

},

"min_storage_bytes": null,

"min_step_storage_bytes": null,

"compression": "default",

"cache_mib": null

},

"fault_tolerance": {

"model": "none",

"checkpoint_interval_secs": 60

},

"cpu_profiler": true,

"tracing": false,

"tracing_endpoint_jaeger": "",

"min_batch_size_records": 0,

"max_buffering_delay_usecs": 0,

"resources": {

"cpu_cores_min": null,

"cpu_cores_max": null,

"memory_mb_min": null,

"memory_mb_max": null,

"storage_mb_max": null,

"storage_class": null,

"service_account_name": null,

"namespace": null

},

"clock_resolution_usecs": 1000000,

"pin_cpus": [],

"provisioning_timeout_secs": null,

"max_parallel_connector_init": null,

"init_containers": null,

"checkpoint_during_suspend": true,

"http_workers": null,

"io_workers": null,

"env": {},

"dev_tweaks": {},

"logging": null,

"pipeline_template_configmap": null

},

"program_code": "CREATE TABLE table1 ( col1 INT );",

"udf_rust": "",

"udf_toml": "",

"program_config": {

"profile": "optimized",

"cache": true,

"runtime_version": null

},

"program_version": 2,

"program_status": "Pending",

"program_status_since": "1970-01-01T00:00:00Z",

"program_error": {

"sql_compilation": null,

"rust_compilation": null,

"system_error": null

},

"program_info": null,

"deployment_error": null,

"refresh_version": 4,

"storage_status": "Cleared",

"deployment_id": null,

"deployment_initial": null,

"deployment_status": "Stopped",

"deployment_status_since": "1970-01-01T00:00:00Z",

"deployment_desired_status": "Stopped",

"deployment_desired_status_since": "1970-01-01T00:00:00Z",

"deployment_resources_status": "Stopped",

"deployment_resources_status_details": null,

"deployment_resources_status_since": "1970-01-01T00:00:00Z",

"deployment_resources_desired_status": "Stopped",

"deployment_resources_desired_status_since": "1970-01-01T00:00:00Z",

"deployment_runtime_status": null,

"deployment_runtime_status_details": null,

"deployment_runtime_status_since": null,

"deployment_runtime_desired_status": null,

"deployment_runtime_desired_status_since": null

},

{

"id": "67e55044-10b1-426f-9247-bb680e5fe0c9",

"name": "example2",

"description": "Description of the pipeline example2",

"created_at": "1970-01-01T00:00:00Z",

"version": 1,

"platform_version": "v0",

"runtime_config": {

"workers": 10,

"hosts": 1,

"storage": {

"backend": {

"name": "default"

},

"min_storage_bytes": null,

"min_step_storage_bytes": null,

"compression": "default",

"cache_mib": null

},

"fault_tolerance": {

"model": "none",

"checkpoint_interval_secs": 60

},

"cpu_profiler": false,

"tracing": false,

"tracing_endpoint_jaeger": "",

"min_batch_size_records": 100000,

"max_buffering_delay_usecs": 0,

"resources": {

"cpu_cores_min": null,

"cpu_cores_max": null,

"memory_mb_min": 1000,

"memory_mb_max": null,

"storage_mb_max": 10000,

"storage_class": null,

"service_account_name": null,

"namespace": null

},

"clock_resolution_usecs": 100000,

"pin_cpus": [],

"provisioning_timeout_secs": 1200,

"max_parallel_connector_init": 10,

"init_containers": null,

"checkpoint_during_suspend": false,

"http_workers": null,

"io_workers": null,

"env": {},

"dev_tweaks": {},

"logging": null,

"pipeline_template_configmap": null

},

"program_code": "CREATE TABLE table2 ( col2 VARCHAR );",

"udf_rust": "",

"udf_toml": "",

"program_config": {

"profile": "unoptimized",

"cache": true,

"runtime_version": null

},

"program_version": 1,

"program_status": "Pending",

"program_status_since": "1970-01-01T00:00:00Z",

"program_error": {

"sql_compilation": null,

"rust_compilation": null,

"system_error": null

},

"program_info": null,

"deployment_error": null,

"refresh_version": 1,

"storage_status": "Cleared",

"deployment_id": null,

"deployment_initial": null,

"deployment_status": "Stopped",

"deployment_status_since": "1970-01-01T00:00:00Z",

"deployment_desired_status": "Stopped",

"deployment_desired_status_since": "1970-01-01T00:00:00Z",

"deployment_resources_status": "Stopped",

"deployment_resources_status_details": null,

"deployment_resources_status_since": "1970-01-01T00:00:00Z",

"deployment_resources_desired_status": "Stopped",

"deployment_resources_desired_status_since": "1970-01-01T00:00:00Z",

"deployment_runtime_status": null,

"deployment_runtime_status_details": null,

"deployment_runtime_status_since": null,

"deployment_runtime_desired_status": null,

"deployment_runtime_desired_status_since": null

}

]

}

}

},

"500": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

},

"post": {

"tags": [

"Pipeline CRUD"

],

"summary": "Create Pipeline",

"description": "Create a new pipeline with the provided configuration.",

"operationId": "post_pipeline",

"requestBody": {

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/PostPutPipeline"

},

"example": {

"name": "example1",

"description": "Description of the pipeline example1",

"runtime_config": {

"workers": 16,

"hosts": 1,

"storage": {

"backend": {

"name": "default"

},

"min_storage_bytes": null,

"min_step_storage_bytes": null,

"compression": "default",

"cache_mib": null

},

"fault_tolerance": {

"model": "none",

"checkpoint_interval_secs": 60

},

"cpu_profiler": true,

"tracing": false,

"tracing_endpoint_jaeger": "",

"min_batch_size_records": 0,

"max_buffering_delay_usecs": 0,

"resources": {

"cpu_cores_min": null,

"cpu_cores_max": null,

"memory_mb_min": null,

"memory_mb_max": null,

"storage_mb_max": null,

"storage_class": null,

"service_account_name": null,

"namespace": null

},

"clock_resolution_usecs": 1000000,

"pin_cpus": [],

"provisioning_timeout_secs": null,

"max_parallel_connector_init": null,

"init_containers": null,

"checkpoint_during_suspend": true,

"http_workers": null,

"io_workers": null,

"env": {},

"dev_tweaks": {},

"logging": null,

"pipeline_template_configmap": null

},

"program_code": "CREATE TABLE table1 ( col1 INT );",

"udf_rust": null,

"udf_toml": null,

"program_config": {

"profile": "optimized",

"cache": true,

"runtime_version": null

}

}

}

},

"required": true

},

"responses": {

"201": {

"description": "Pipeline successfully created",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/PipelineInfo"

},

"example": {

"id": "67e55044-10b1-426f-9247-bb680e5fe0c8",

"name": "example1",

"description": "Description of the pipeline example1",

"created_at": "1970-01-01T00:00:00Z",

"version": 4,

"platform_version": "v0",

"runtime_config": {

"workers": 16,

"hosts": 1,

"storage": {

"backend": {

"name": "default"

},

"min_storage_bytes": null,

"min_step_storage_bytes": null,

"compression": "default",

"cache_mib": null

},

"fault_tolerance": {

"model": "none",

"checkpoint_interval_secs": 60

},

"cpu_profiler": true,

"tracing": false,

"tracing_endpoint_jaeger": "",

"min_batch_size_records": 0,

"max_buffering_delay_usecs": 0,

"resources": {

"cpu_cores_min": null,

"cpu_cores_max": null,

"memory_mb_min": null,

"memory_mb_max": null,

"storage_mb_max": null,

"storage_class": null,

"service_account_name": null,

"namespace": null

},

"clock_resolution_usecs": 1000000,

"pin_cpus": [],

"provisioning_timeout_secs": null,

"max_parallel_connector_init": null,

"init_containers": null,

"checkpoint_during_suspend": true,

"http_workers": null,

"io_workers": null,

"env": {},

"dev_tweaks": {},

"logging": null,

"pipeline_template_configmap": null

},

"program_code": "CREATE TABLE table1 ( col1 INT );",

"udf_rust": "",

"udf_toml": "",

"program_config": {

"profile": "optimized",

"cache": true,

"runtime_version": null

},

"program_version": 2,

"program_status": "Pending",

"program_status_since": "1970-01-01T00:00:00Z",

"program_error": {

"sql_compilation": null,

"rust_compilation": null,

"system_error": null

},

"program_info": null,

"deployment_error": null,

"refresh_version": 4,

"storage_status": "Cleared",

"deployment_id": null,

"deployment_initial": null,

"deployment_status": "Stopped",

"deployment_status_since": "1970-01-01T00:00:00Z",

"deployment_desired_status": "Stopped",

"deployment_desired_status_since": "1970-01-01T00:00:00Z",

"deployment_resources_status": "Stopped",

"deployment_resources_status_details": null,

"deployment_resources_status_since": "1970-01-01T00:00:00Z",

"deployment_resources_desired_status": "Stopped",

"deployment_resources_desired_status_since": "1970-01-01T00:00:00Z",

"deployment_runtime_status": null,

"deployment_runtime_status_details": null,

"deployment_runtime_status_since": null,

"deployment_runtime_desired_status": null,

"deployment_runtime_desired_status_since": null

}

}

}

},

"400": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

},

"examples": {

"Name does not match pattern": {

"value": {

"message": "Name 'name-with-invalid-char-#' contains characters which are not lowercase (a-z), uppercase (A-Z), numbers (0-9), underscores (_) or hyphens (-)",

"error_code": "NameDoesNotMatchPattern",

"details": {

"name": "name-with-invalid-char-#"

}

}

}

}

}

}

},

"409": {

"description": "Cannot create pipeline as the name already exists",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

},

"example": {

"message": "An entity with this name already exists",

"error_code": "DuplicateName",

"details": null

}

}

}

},

"500": {

"description": "",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

},

"security": [

{

"JSON web token (JWT) or API key": []

}

]

}

},

"/v0/pipelines/{pipeline_name}": {