Delete

/data-engine

Initiate async deletion of Data Engine and all associated resources. Returns immediately with 202 status.

Body parameters

object

force

boolean

Force removal even if errors occur

Defaulttrue

Responses

202

Data Engine deletion initiated (async)

Expand All

object

Unified status for Data Engine setup and deletion operations

setup

object (DataEngineSetupStatus)

Status of the Data Engine setup process

status

string

The current status of the Data Engine setup process

Valid values[ "not_started", "in_progress", "completed", "error" ]

started_at

string (date-time)

When the setup process was started

completed_at

string (date-time)

When the setup process completed successfully

message

string

Current status message or error details

parameters

object (SetupDataEngineRequest)

Request body for setting up Data Engine

vip_pools

Array of integer

VIP Pools to use for the telemetries collector

integer

kafka_broker

object (Broker)

type

string

Valid values[ "External", "Internal" ]

url

string Deprecated

Deprecated. The broker URL is now resolved from VMS by broker name. This field is ignored for VMS-registered brokers and only used as a legacy fallback for brokers not yet registered in VMS. It will be removed in a future release.

Examplehttps://kafka.example.com:6969

name

string

Broker name for external or Bucket (View) name for internal.

Max length40

Examplemy-kafka-broker

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the broker is accessible. Set to false if the broker is not reachable from the Data Engine (e.g., external brokers behind firewalls).

Defaulttrue

default_topic_name

string

The name of the default topic

dead_letter_topic_name

string

The name of the dead letter topic

kafka_ca_certificate

string | null

Optional CA certificate for Kafka broker (Base64 encoded). Must be provided if the Kafka broker is using TLS.

deletion

object (DataEngineDeletionStatus)

status

string

The current status of the data engine deletion process

Valid values[ "idle", "in_progress", "error" ]

started_at

string (date-time)

When the deletion process was started

message

string

Status message or error details

deprecated_api_used

boolean

True if the request came from a deprecated endpoint

Defaultfalse

400

Bad Request

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

401

Unauthorized

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

409

Conflict

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

500

Internal Server Error

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

Delete Data Engine (Async)