> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete a virtual data plane

> Delete a virtual data plane. It is soft-deleted (archived) and no longer appears in reads;
the response returns the archived virtual data plane. It is identified by the
`virtual_dataplane_id` path parameter alone; the `x-hh-dataplane-id` header does not
participate.

**Deleting a virtual data plane also archives every workspace inside it and every project
inside those workspaces**, so the events, datasets, and evaluations in them are no longer
reachable. Because that reaches two levels below the resource named in the URL, a virtual
data plane with active workspaces is rejected with a 409 unless the request sets
`dangerously_delete_child_scopes=true`. Workspaces that were already archived do not count.

The response describes only the virtual data plane. It does not enumerate what the cascade
archived, so read that first if you need the list.

This endpoint is unavailable where HoneyHive assigns virtual data planes automatically,
and returns a 403 there.




## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml delete /v1/virtual_dataplanes/{virtual_dataplane_id}
openapi: 3.1.0
info:
  title: HoneyHive Control Plane API
  description: >
    Manage HoneyHive control-plane resources: workspaces, projects and alerts.


    Authentication requires a fine-grained control-plane API key (values

    start with `hh_fgcp_`), sent as `Authorization: Bearer <api-key>`.

    Project API keys used with the Data Plane API will not work here. Create

    a key in the HoneyHive app under an organization's or workspace's

    **Settings → API Keys**, or see

    [Authorization](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript#authorization)

    for details.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.9.0
servers:
  - url: https://api.cp.us.honeyhive.ai
security:
  - BearerAuth: []
tags:
  - name: Alerts
    description: >
      Define and manage alerts. Alerts evaluate event metrics on a schedule and
      trigger notifications when configured thresholds are crossed.
  - name: Projects
    description: >
      Create and manage projects within a workspace. A project is the container
      for the events, datasets, evaluations, and alerts logged against it.
  - name: Virtual Dataplanes
    description: >
      Create and manage virtual data planes. A virtual data plane is a logical
      tenant boundary inside an organization, hosted on a physical cluster;
      several virtual data planes commonly share one cluster. Workspaces live
      inside a virtual data plane.
  - name: Workspaces
    description: >
      Read and manage workspaces. A workspace groups the projects belonging to
      one team or environment, and owns the API keys and AI provider secrets its
      projects share.
paths:
  /v1/virtual_dataplanes/{virtual_dataplane_id}:
    delete:
      tags:
        - Virtual Dataplanes
      summary: Delete a virtual data plane
      description: >
        Delete a virtual data plane. It is soft-deleted (archived) and no longer
        appears in reads;

        the response returns the archived virtual data plane. It is identified
        by the

        `virtual_dataplane_id` path parameter alone; the `x-hh-dataplane-id`
        header does not

        participate.


        **Deleting a virtual data plane also archives every workspace inside it
        and every project

        inside those workspaces**, so the events, datasets, and evaluations in
        them are no longer

        reachable. Because that reaches two levels below the resource named in
        the URL, a virtual

        data plane with active workspaces is rejected with a 409 unless the
        request sets

        `dangerously_delete_child_scopes=true`. Workspaces that were already
        archived do not count.


        The response describes only the virtual data plane. It does not
        enumerate what the cascade

        archived, so read that first if you need the list.


        This endpoint is unavailable where HoneyHive assigns virtual data planes
        automatically,

        and returns a 403 there.
      operationId: deleteVirtualDataplane
      parameters:
        - in: path
          name: virtual_dataplane_id
          required: true
          schema:
            type: string
          description: The unique identifier of the virtual data plane to delete
        - in: query
          name: dangerously_delete_child_scopes
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Archive the virtual data plane even when it still has active
            workspaces, archiving

            those workspaces and their projects too. Without it, such a request
            fails with a 409

            and no changes are made.
      responses:
        '200':
          description: Virtual data plane deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteVirtualDataplaneResponse'
        '400':
          description: '`dangerously_delete_child_scopes` is not `true` or `false`'
        '403':
          description: >-
            The caller may not delete this virtual data plane, or this
            deployment assigns virtual data planes automatically
        '404':
          description: Virtual data plane not found
        '409':
          description: >-
            The virtual data plane still has active workspaces and
            `dangerously_delete_child_scopes` was not set
components:
  schemas:
    DeleteVirtualDataplaneResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/VirtualDataplaneItem'
      required:
        - success
        - data
      additionalProperties: false
      description: >-
        The deleted (archived) virtual dataplane. Descendants archived by the
        cascade are not listed.
    VirtualDataplaneItem:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: Virtual dataplane display name
        cluster_id:
          type: string
          description: Identifier of the physical cluster hosting this dataplane
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
      required:
        - id
        - name
        - cluster_id
        - created_at
        - updated_at
      additionalProperties: false
      description: Virtual dataplane object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [Virtual Dataplanes](/v2/cli-reference/ref/virtual-dataplanes.md)
- [Virtual Dataplanes Methods](/v2/control-plane-sdk-reference/typescript/ref/virtual-dataplanes/index.md)
- [Get a virtual data plane](/v2/control-plane-api-reference-autogen/virtual-dataplanes/get-a-virtual-data-plane.md)
