Retrieve DNS configuration

curl --request GET \
  --url https://biq.li/api/v1/domain/{domain}/dns-config \
  --header 'Authorization: Bearer <token>'

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

fetch('https://biq.li/api/v1/domain/{domain}/dns-config', 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://biq.li/api/v1/domain/{domain}/dns-config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://biq.li/api/v1/domain/{domain}/dns-config"

	req, _ := http.NewRequest("GET", 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://biq.li/api/v1/domain/{domain}/dns-config")

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

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

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

{
  "domain": {
    "id": "<string>",
    "host": "go.example.com",
    "url": "<string>",
    "status": "pending_dns",
    "dns_status": "pending",
    "ssl_status": "pending",
    "dns_verified": true,
    "active": true,
    "is_subdomain": true,
    "links_count": 1,
    "claim_expires_at": "2023-11-07T05:31:56Z",
    "dns_last_checked_at": "2023-11-07T05:31:56Z",
    "dns_verified_at": "2023-11-07T05:31:56Z",
    "ssl_last_checked_at": "2023-11-07T05:31:56Z",
    "use_default_redirect": true,
    "default_redirect_url": "<string>",
    "use_not_found_redirect": true,
    "not_found_redirect_url": "<string>",
    "use_expired_redirect": true,
    "expired_redirect_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "dns_config": {
    "host": "<string>",
    "is_subdomain": true,
    "records": [
      {
        "type": "A",
        "name": "<string>",
        "value": "<string>",
        "ttl": "auto"
      }
    ]
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

GET

domain

{domain}

dns-config

Retrieve DNS configuration

curl --request GET \
  --url https://biq.li/api/v1/domain/{domain}/dns-config \
  --header 'Authorization: Bearer <token>'

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

fetch('https://biq.li/api/v1/domain/{domain}/dns-config', 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://biq.li/api/v1/domain/{domain}/dns-config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://biq.li/api/v1/domain/{domain}/dns-config"

	req, _ := http.NewRequest("GET", 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://biq.li/api/v1/domain/{domain}/dns-config")

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

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

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

{
  "domain": {
    "id": "<string>",
    "host": "go.example.com",
    "url": "<string>",
    "status": "pending_dns",
    "dns_status": "pending",
    "ssl_status": "pending",
    "dns_verified": true,
    "active": true,
    "is_subdomain": true,
    "links_count": 1,
    "claim_expires_at": "2023-11-07T05:31:56Z",
    "dns_last_checked_at": "2023-11-07T05:31:56Z",
    "dns_verified_at": "2023-11-07T05:31:56Z",
    "ssl_last_checked_at": "2023-11-07T05:31:56Z",
    "use_default_redirect": true,
    "default_redirect_url": "<string>",
    "use_not_found_redirect": true,
    "not_found_redirect_url": "<string>",
    "use_expired_redirect": true,
    "expired_redirect_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "dns_config": {
    "host": "<string>",
    "is_subdomain": true,
    "records": [
      {
        "type": "A",
        "name": "<string>",
        "value": "<string>",
        "ttl": "auto"
      }
    ]
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Retrieve the exact records needed to connect a domain. Requires Custom domains: Read (custom_domains.view).

curl --request GET \
  --url https://biq.li/api/v1/domain/biq_dom_01M18D4A8QRJY5G6K3N2W7X9TZ/dns-config \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json'

Response

{
  "domain": {
    "id": "biq_dom_01M18D4A8QRJY5G6K3N2W7X9TZ",
    "host": "go.example.com",
    "status": "pending_dns",
    "dns_status": "pending",
    "ssl_status": "pending",
    "dns_verified": false,
    "active": false
  },
  "dns_config": {
    "host": "go.example.com",
    "is_subdomain": true,
    "records": [
      {"type":"CNAME","name":"go","value":"biq.li","ttl":"auto"},
      {"type":"TXT","name":"_verify.example.com","value":"domain-verify=...","ttl":"auto"}
    ]
  },
  "status": "success"
}

The actual domain object contains every field documented by Retrieve a domain; it is abbreviated above. Publish both records exactly as returned. name is the DNS-provider host/name field, value is its target/content, and ttl: auto means to use Auto or the provider default. Some providers automatically append the apex domain; follow their display convention without duplicating it.

Apex domains receive an A routing record with name @.
Subdomains receive a CNAME routing record.
Every claim receives a TXT ownership record.

The TXT value is intentionally returned because it must be public in DNS. The endpoint does not expose DNS lookup logs or internal SSL and cleanup errors. Values may be deployment-specific, so fetch this endpoint instead of hardcoding Biqli’s IP address or hostname.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization

string

header

required

A workspace API key beginning with biqli_.

Path Parameters

domain

string

required

Public custom-domain ID. Numeric IDs and hosts are not accepted.

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$

Response

DNS configuration returned successfully.

domain

object

required

Show child attributes

dns_config

object

required

Show child attributes

status

string

required

Allowed value: "success"

GETTING STARTED

BIQLI LINKS API

Retrieve DNS configuration

Response

Shared API behavior

Authorizations

Path Parameters

Response

​Response

​Shared API behavior

Authorizations

Path Parameters

Response

Response

Shared API behavior