Routes API

Check a HTTP Route exists

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

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/6558b5b0-99f9-498d-9827-6c230e50ef76/host/host-12?path=/apps/v1/path

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
path: /apps/v1/path

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4OH0.XGP5Zde_Rmhje9hFHFw08MxKUv8fuxqtMcF5pogx_rs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/routes/reserved/domain/6558b5b0-99f9-498d-9827-6c230e50ef76/host/host-12?path=/apps/v1/path" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4OH0.XGP5Zde_Rmhje9hFHFw08MxKUv8fuxqtMcF5pogx_rs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 2ddfd3e7-2b4c-46b9-b1eb-694e5c25eb24
X-Content-Type-Options: nosniff