List custom resolver hostnames

curl --request GET \
  --url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames', 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://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "hostname": "<string>",
    "is_qr_ready": true,
    "setup": {
      "challenge": {
        "type": "<string>",
        "name": "<string>",
        "value": "<string>",
        "purpose": "<string>"
      },
      "serving": {
        "type": "<string>",
        "name": "<string>",
        "value": "<string>",
        "purpose": "<string>"
      },
      "qr_density_warning": true
    },
    "verified_at": "<string>",
    "last_checked_at": "<string>",
    "last_error": "",
    "tls_last_error": "",
    "tls_retry_after": "<string>",
    "tls_expires_at": "<string>"
  }
]

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

GET

resolver

api

organizations

{organization_id}

custom-hostnames

List custom resolver hostnames

curl --request GET \
  --url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames', 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://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://www.closient.com/resolver/api/v1/organizations/{organization_id}/custom-hostnames")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "hostname": "<string>",
    "is_qr_ready": true,
    "setup": {
      "challenge": {
        "type": "<string>",
        "name": "<string>",
        "value": "<string>",
        "purpose": "<string>"
      },
      "serving": {
        "type": "<string>",
        "name": "<string>",
        "value": "<string>",
        "purpose": "<string>"
      },
      "qr_density_warning": true
    },
    "verified_at": "<string>",
    "last_checked_at": "<string>",
    "last_error": "",
    "tls_last_error": "",
    "tls_retry_after": "<string>",
    "tls_expires_at": "<string>"
  }
]

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "error_code": "<string>",
  "timestamp": "<string>",
  "retryable": false,
  "retry_after": 123,
  "owner_action_required": true,
  "details": "<unknown>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

organization_id

string<shortuuid>

required

Organization UUID.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

hostname

string

required

The customer-owned hostname, normalized lowercase.

status

enum<string>

required

Ownership-verification state.

Available options:

PENDING,

VERIFIED,

DISABLED

tls_status

enum<string>

required

Edge-certificate state (read-only; driven by the cert pipeline).

Available options:

NOT_REQUESTED,

PENDING,

ACTIVE,

FAILED

is_qr_ready

boolean

required

True when this hostname is VERIFIED and its edge cert is ACTIVE — QRs may print against it.

setup

CustomHostnameSetupOut · object

required

DNS records to publish for this hostname.

Show child attributes

Example:

{
  "challenge": {
    "name": "_closient-challenge.id.theirco.com",
    "purpose": "ownership_verification",
    "type": "CNAME",
    "value": "9f86d081884c.verify.gtin.one"
  },
  "qr_density_warning": false,
  "serving": {
    "name": "id.theirco.com",
    "purpose": "resolver_routing",
    "type": "CNAME",
    "value": "gtin.one"
  }
}

verified_at

string | null

ISO-8601 timestamp of the last successful verification, or null.

last_checked_at

string | null

ISO-8601 timestamp of the last verification attempt, or null.

last_error

string

default:""

Reason the last verification attempt failed (empty on success).

tls_last_error

string

default:""

Reason the last certificate issuance or renewal check failed (empty on success).

tls_retry_after

string | null

ISO-8601 time before which certificate issuance will not be retried, or null when not in cooldown.

tls_expires_at

string | null

ISO-8601 expiry of the certificate seen at the last successful probe, or null.

Overview

Account

Products

Brands

Locations

Retailers

Search

GS1 Digital Link

EPCIS 2.0

Integrations

Billing

Scanner

Compliance

Certifications

Sustainability

Notifications

Dashboard

Analytics

Agent

Substances

BYOS

Content

Signals

List custom resolver hostnames

Authorizations

Path Parameters

Response