Get the domain's catch-all redirect

GET

/api/v1/domains/{domain_id}/route

const url = 'https://app.routeseam.com/api/v1/domains/1/route';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

ApiKeyAuth

Parameters

Path Parameters

domain_id

required

integer

Responses

200

application/json

object

route

required

object

required

integer

destination_url

required

string format: uri

status_code

required

integer

Allowed values: 301 302 307 308

preserve_path

required

boolean

preserve_query

required

boolean

enabled

required

boolean

Example

{
  "route": {
    "status_code": 301
  }
}

401

Missing or invalid API key

application/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

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

application/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

Over 300 requests/minute for this key

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