Delete a virtual data plane

curl --request DELETE \
  --url https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "cluster_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Virtual Dataplanes

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 404 there.

DELETE

virtual_dataplanes

{virtual_dataplane_id}

Delete a virtual data plane

curl --request DELETE \
  --url https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cp.us.honeyhive.ai/v1/virtual_dataplanes/{virtual_dataplane_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "cluster_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

A fine-grained control-plane API key (values begin with hh_fgcp_). Project API keys used with the Data Plane API will not work here. Create one in the HoneyHive app under an organization's or workspace's Settings → API Keys.

Path Parameters

virtual_dataplane_id

string

required

The unique identifier of the virtual data plane to delete

Query Parameters

dangerously_delete_child_scopes

boolean

default:false

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.

Response

Virtual data plane deleted successfully

The deleted (archived) virtual dataplane. Descendants archived by the cascade are not listed.

success

boolean

required

data

object

required

Virtual dataplane object

Show child attributes