Skip to content
RouteSeam

Queue a DNS and ownership recheck

POST
/api/v1/domains/{id}/verify
curl --request POST \
  --url https://app.routeseam.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/verify \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

202

Section titled “202”

Queued; poll GET domain for status

Media typeapplication/json
object
domain
object
id
required
integer
hostname
required
string
status
required
string
Allowed values: pending_dns dns_verified tls_provisioning active dns_failed tls_failed suspended disabled
include_www
required
boolean
mode

Present for private-beta proxy domains

string
Allowed values: proxy
origin

Present for proxy domains

string format: uri
preserve_host
boolean
beta_enabled
boolean
ownership_verified_at
string | null format: date-time
dns_records

Proxy A and unique TXT records; keep both after activation.

Array<object>
object
type
string
Allowed values: A TXT
name
string
value
string
dns_verified_at
required
string | null format: date-time
tls_status
required

E.g. issued / failed

string | null
created_at
required
string format: date-time
dns

Present while status is not active — the record to add

object
type
string
Allowed value: A
name
string
Allowed value: @
value

ROUTESEAM_IP

string
Example
{
  "domain": {
    "status": "pending_dns",
    "mode": "proxy",
    "dns_records": [
      {
        "type": "A"
      }
    ],
    "dns": {
      "type": "A",
      "name": "@"
    }
  }
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Example
{
  "error": "Invalid API key",
  "errors": [],
  "validation_errors": {}
}

403

Section titled “403”

API access has not been enabled; org suspended; or owner email unverified

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "error": "example",
  "errors": [
    "example"
  ],
  "validation_errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

404

Section titled “404”

Not found (cross-tenant ids are indistinguishable from missing ones)

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Example
{
  "error": "Not found",
  "errors": [],
  "validation_errors": {}
}

429

Section titled “429”

Over 300 requests/minute for this key

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Example
{
  "error": "Rate limit exceeded",
  "errors": [],
  "validation_errors": {}
}