Skip to content

Deletes a volume

Description

Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

Usage

finspace_delete_kx_volume(environmentId, volumeName, clientToken)

Arguments

  • environmentId

    [required] A unique identifier for the kdb environment, whose clusters can attach to the volume.

  • volumeName

    [required] The name of the volume that you want to delete.

  • clientToken

    A token that ensures idempotency. This token expires in 10 minutes.

Value

An empty list.

Request syntax

svc$delete_kx_volume(
  environmentId = "string",
  volumeName = "string",
  clientToken = "string"
)