Verify domain

Restart verification for a custom domain.

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

Call this after you correct the DNS records of a domain that shows failed, or to give a pending domain a new 24-hour verification period. The domain goes back to pending and the 24-hour period starts again.

The endpoint returns when Unkey accepts the retry. Poll domains.getDomain for the result.

A domain that is already verified returns a 412.

Required Permissions

Your root key must have one of the following permissions:

environment.*.verify_domain (to verify domains in any environment)
environment.<environment_id>.verify_domain (to verify domains in a specific environment)

POST

domains.verifyDomain

Go (SDK)

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v3"
	"github.com/unkeyed/sdks/api/go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Domains.VerifyDomain(ctx, components.V2DomainsVerifyDomainRequestBody{
        Domain: "dom_1234abcd",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2DomainsVerifyDomainResponseBody != nil {
        // handle response
    }
}

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

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

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

  console.log(result);
}

run();

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

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.verifyDomain', 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.verifyDomain",
  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;
}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/domains.verifyDomain")
  .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.verifyDomain")

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": "The domain 'api.acme.com' is already verified. No action is needed.",
    "status": 412,
    "title": "Precondition Failed",
    "type": "precondition-failed"
  },
  "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 name or by its ID. Send the fully qualified domain name, such as 'api.acme.com', without a scheme, port, or path, or send the domain ID that domains.createDomain returns. You can send an internationalized name in Unicode or in Punycode form. Both forms address the same domain.

Required string length: 4 - 253

Example:

"api.acme.com"

Response

Verification retry accepted. The workflow runs in the background.

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.

⌘I

Go (SDK)

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v3"
	"github.com/unkeyed/sdks/api/go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Domains.VerifyDomain(ctx, components.V2DomainsVerifyDomainRequestBody{
        Domain: "dom_1234abcd",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2DomainsVerifyDomainResponseBody != nil {
        // handle response
    }
}

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

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

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

  console.log(result);
}

run();

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

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.verifyDomain', 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.verifyDomain",
  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;
}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/domains.verifyDomain")
  .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.verifyDomain")

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": "The domain 'api.acme.com' is already verified. No action is needed.",
    "status": 412,
    "title": "Precondition Failed",
    "type": "precondition-failed"
  },
  "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"
  }
}

Projects

Apps

Environments

Deployments

Domains

Gateway

GitHub

Analytics

Verify domain

Authorizations

Body

Response