Skip to content
RouteSeam

Update the redirect (republishes edge config)

PATCH
/api/v1/domains/{domain_id}/route
curl --request PATCH \
  --url https://app.routeseam.com/api/v1/domains/1/route \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --data '{ "destination_url": "https://example.com", "status_code": 301, "preserve_path": true, "preserve_query": true, "enabled": true }'

destination_url is rejected with 422 when following it through RouteSeam domains returns to this domain within ten hops — self-loops, two-hop loops, longer chains, and www. forms of a domain that has include_www set. A non-standard port is not a loop, since the edge serves only 80 and 443. The check reads how domains are configured, not what is live, so a pending or disabled route still counts. The error message names only your own hostname.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
domain_id
required
integer

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
>= 1 properties
destination_url
string format: uri
status_code
integer
Allowed values: 301 302 307 308
preserve_path
boolean
preserve_query
boolean
enabled
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
route
required
object
id
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

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

422

Section titled “422”

Validation failed (validation_errors keyed by attribute)

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"
    ]
  }
}

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