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/974b0da9-f410-4b62-8fda-1e511939d680?port=61000

Parameters

Name Description Valid Values Example Values
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 "?" Note: not supported for internal routes.
  • /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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMyIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4OH0.jZ0d8pXttu712m238-BgomqLEO4LkURZ99zkPKYceTk
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/routes/reserved/domain/974b0da9-f410-4b62-8fda-1e511939d680?port=61000" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMyIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4OH0.jZ0d8pXttu712m238-BgomqLEO4LkURZ99zkPKYceTk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: cb7924b9-8667-4be1-843f-1f27cc22f800
X-Content-Type-Options: nosniff