Delete domain

Delete a custom domain from your workspace.

Address the domain by its id or by its name. Names are unique per workspace, so api.acme.com is enough.

Unkey stops serving the domain. Later requests fail with a certificate error. The DNS records at your provider stay in place.

Required Permissions

Your root key must have one of the following permissions:

environment.*.delete_domain (to delete domains in any environment)
environment.<environment_id>.delete_domain (to delete domains in a specific environment)

POST

domains.deleteDomain

Typescript (SDK)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.domains.deleteDomain({
    domain: "dom_1234abcd",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/domains.deleteDomain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "dom_1234abcd"
}
'

import requests

url = "https://api.unkey.com/v2/domains.deleteDomain"

payload = { "domain": "dom_1234abcd" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'dom_1234abcd'})
};

fetch('https://api.unkey.com/v2/domains.deleteDomain', 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.unkey.com/v2/domains.deleteDomain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'dom_1234abcd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.unkey.com/v2/domains.deleteDomain"

	payload := strings.NewReader("{\n  \"domain\": \"dom_1234abcd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/domains.deleteDomain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"dom_1234abcd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/domains.deleteDomain")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"dom_1234abcd\"\n}"

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

{
  "data": {},
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The domain identifier must be between 4 and 253 characters.",
    "errors": [
      {
        "fix": "Pass a domain name such as 'api.acme.com' or an id such as 'dom_1234abcd'",
        "location": "body.domain",
        "message": "minLength must be at least 4 characters"
      }
    ],
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The provided root key is invalid.",
    "status": 401,
    "title": "Unauthorized",
    "type": "unauthorized"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The provided root key is disabled.",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The requested domain does not exist.",
    "status": 404,
    "title": "Not Found",
    "type": "not-found"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "You have exceeded the rate limit for this operation. Retry after the window resets.",
    "status": 429,
    "title": "Too Many Requests",
    "type": "rate-limited"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "An unexpected error occurred. Contact support@unkey.com with the requestId.",
    "status": 500,
    "title": "Internal Server Error",
    "type": "internal-server-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

Authorizations

Authorization

string

header

required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

domain

string

required

Identifies a domain by its Unkey ID or by its name. Pass a 'dom_'-prefixed ID, or a fully qualified domain name such as 'api.acme.com' without a scheme, port, or path. You can give an internationalized name in Unicode or Punycode form. Both forms address the same domain.

Domain names are unique per workspace, so the name alone addresses the domain. You do not need to supply a project, app, or environment.

Required string length: 4 - 253

Example:

"api.acme.com"

Response

Successfully deleted the domain.

meta

object

required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data

object

required

Empty response object by design. A successful response indicates this operation was successfully executed.

Last modified on August 24, 2026

⌘I

Typescript (SDK)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.domains.deleteDomain({
    domain: "dom_1234abcd",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/domains.deleteDomain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "dom_1234abcd"
}
'

import requests

url = "https://api.unkey.com/v2/domains.deleteDomain"

payload = { "domain": "dom_1234abcd" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'dom_1234abcd'})
};

fetch('https://api.unkey.com/v2/domains.deleteDomain', 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.unkey.com/v2/domains.deleteDomain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'dom_1234abcd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.unkey.com/v2/domains.deleteDomain"

	payload := strings.NewReader("{\n  \"domain\": \"dom_1234abcd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/domains.deleteDomain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"dom_1234abcd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/domains.deleteDomain")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"dom_1234abcd\"\n}"

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

{
  "data": {},
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The domain identifier must be between 4 and 253 characters.",
    "errors": [
      {
        "fix": "Pass a domain name such as 'api.acme.com' or an id such as 'dom_1234abcd'",
        "location": "body.domain",
        "message": "minLength must be at least 4 characters"
      }
    ],
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The provided root key is invalid.",
    "status": 401,
    "title": "Unauthorized",
    "type": "unauthorized"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The provided root key is disabled.",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The requested domain does not exist.",
    "status": 404,
    "title": "Not Found",
    "type": "not-found"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "You have exceeded the rate limit for this operation. Retry after the window resets.",
    "status": 429,
    "title": "Too Many Requests",
    "type": "rate-limited"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "An unexpected error occurred. Contact support@unkey.com with the requestId.",
    "status": 500,
    "title": "Internal Server Error",
    "type": "internal-server-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}