Home
Version 3
Routes API

Routes API

Check a Route exists

GET /v2/routes/reserved/domain/:domain_guid?host=:host&path=:path&port=:port

This endpoint returns a status code of 204 if the route exists, and 404 if it does not.

Request

Route

GET /v2/routes/reserved/domain/4cdce602-6235-4462-92e7-e4c7f21b4ddf?port=61000

Parameters

Name Description Valid Values Example Values
domain_guid The guid of a domain
host The host portion of the route. Required for shared-domains.
path The path for a route as raw text. 1) Paths must be between 2 and 128 characters 2) Paths must start with a forward slash "/" 3) Paths must not contain a "?"
  • /apps/v1/path
  • /apps/v2/path
port The port of the route. Supported for domains of TCP router groups only.
  • 60027
  • 1234
port: 61000

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MiIsImVtYWlsIjoiZW1haWwtMTQwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MDJ9._cuYXNw13FUgqsl1SFfgibgDD-d0KagHygZTnI4D628
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/reserved/domain/4cdce602-6235-4462-92e7-e4c7f21b4ddf?port=61000" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MiIsImVtYWlsIjoiZW1haWwtMTQwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MDJ9._cuYXNw13FUgqsl1SFfgibgDD-d0KagHygZTnI4D628" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: ca24141d-b9b1-43a4-8c95-2d035c4aeca3
X-Content-Type-Options: nosniff