Does this server serve a domain?

GET

/api/v1/domains/check

curl --request GET \
  --url http://localhost:3000/api/v1/domains/check

200 for a verified domain, an organization’s or a portal’s, or a portal’s subdomain of PORTAL_DOMAIN, 404 otherwise. For a reverse proxy issuing TLS certificates on demand, e.g. Caddy’s on_demand_tls { ask }.

No key needed.

Parameters

Query Parameters

domain

string

A host name, e.g. press.example.com

Responses

200

Served

Media typeapplication/json

object

data

required

object

domain

required

string

served

required

boolean

Example

{
  "data": {
    "served": true
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}