Home
Version 3
Spaces API

Spaces API

List all Routes for the Space

GET /v2/spaces/:guid/routes

Request

Route

GET /v2/spaces/c10d1a3a-9117-44cc-8521-9c2876e4579b/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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTEwMCIsImVtYWlsIjoiZW1haWwtNjhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzQ4MDg0NH0.wf4uRmE0KDONYU9QtreW4vdpGWJBCVg4MIAWDKiHYvs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/c10d1a3a-9117-44cc-8521-9c2876e4579b/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwMCIsImVtYWlsIjoiZW1haWwtNjhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNzQ4MDg0NH0.wf4uRmE0KDONYU9QtreW4vdpGWJBCVg4MIAWDKiHYvs" \
	-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": "e5f7b8da-9b44-43b9-a3e0-578f09213593",
        "url": "/v2/routes/e5f7b8da-9b44-43b9-a3e0-578f09213593",
        "created_at": "2015-03-20T18:27:24Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-2",
        "domain_guid": "5ef8afbb-9945-499f-8fd8-7556859ca385",
        "space_guid": "c10d1a3a-9117-44cc-8521-9c2876e4579b",
        "domain_url": "/v2/domains/5ef8afbb-9945-499f-8fd8-7556859ca385",
        "space_url": "/v2/spaces/c10d1a3a-9117-44cc-8521-9c2876e4579b",
        "apps_url": "/v2/routes/e5f7b8da-9b44-43b9-a3e0-578f09213593/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ae563aa5-7a95-4a81-a2b4-ddd57d0e4b91
Content-Length: 740
X-Content-Type-Options: nosniff