Home
Version 3
Spaces API

Spaces API

List all Routes for the Space

GET /v2/spaces/:guid/routes

Request

Route

GET /v2/spaces/daea4f16-9629-4547-bc1d-d7de72337f7f/routes

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: host, domain_guid, organization_guid, path
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5MyIsImVtYWlsIjoiZW1haWwtMzAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NjZ9.XpEDFQpcFnHhTvdbePfrrbvBiYgJ6DKPhS-fyG5MQHc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/daea4f16-9629-4547-bc1d-d7de72337f7f/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5MyIsImVtYWlsIjoiZW1haWwtMzAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NjZ9.XpEDFQpcFnHhTvdbePfrrbvBiYgJ6DKPhS-fyG5MQHc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ca23cd27-eba9-48ed-9b2f-9aab9eeb9457",
        "url": "/v2/routes/ca23cd27-eba9-48ed-9b2f-9aab9eeb9457",
        "created_at": "2015-06-16T23:41:06Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-25",
        "path": "",
        "domain_guid": "faec001b-4fb5-4f0a-ad58-e6693d1dbc90",
        "space_guid": "daea4f16-9629-4547-bc1d-d7de72337f7f",
        "domain_url": "/v2/domains/faec001b-4fb5-4f0a-ad58-e6693d1dbc90",
        "space_url": "/v2/spaces/daea4f16-9629-4547-bc1d-d7de72337f7f",
        "apps_url": "/v2/routes/ca23cd27-eba9-48ed-9b2f-9aab9eeb9457/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b1285217-3132-49c1-a069-ee1d56a4e9cf
Content-Length: 761
X-Content-Type-Options: nosniff