> ## 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.

# Get a virtual data plane

> Retrieve a single virtual data plane by id. It is identified by the `virtual_dataplane_id`
path parameter alone; the `x-hh-dataplane-id` header does not participate.

The returned `name` is the display name. The globally unique slug assigned at creation is
an internal detail and is not part of this contract. `cluster_id` is the physical cluster
hosting this virtual data plane, and it is the value to send when creating another one
beside it.

Reads work on every deployment, including those where HoneyHive assigns virtual data
planes automatically and the write endpoints are unavailable.




## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml get /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}:
    get:
      tags:
        - Virtual Dataplanes
      summary: Get a virtual data plane
      description: >
        Retrieve a single virtual data plane by id. It is identified by the
        `virtual_dataplane_id`

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


        The returned `name` is the display name. The globally unique slug
        assigned at creation is

        an internal detail and is not part of this contract. `cluster_id` is the
        physical cluster

        hosting this virtual data plane, and it is the value to send when
        creating another one

        beside it.


        Reads work on every deployment, including those where HoneyHive assigns
        virtual data

        planes automatically and the write endpoints are unavailable.
      operationId: getVirtualDataplane
      parameters:
        - in: path
          name: virtual_dataplane_id
          required: true
          schema:
            type: string
          description: The unique identifier of the virtual data plane to retrieve
      responses:
        '200':
          description: Virtual data plane retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualDataplaneResponse'
        '404':
          description: Virtual data plane not found
components:
  schemas:
    GetVirtualDataplaneResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/VirtualDataplaneItem'
      required:
        - success
        - data
      additionalProperties: false
      description: A single virtual dataplane
    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)
- [Delete a virtual data plane](/v2/control-plane-api-reference-autogen/virtual-dataplanes/delete-a-virtual-data-plane.md)