Skip to content
RouteSeam

Get a domain

GET
/api/v1/domains/{id}
curl --request GET \
  --url https://app.routeseam.com/api/v1/domains/1 \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
domain
required
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
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",
    "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": {}
}

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": {}
}