Home
Version 3
Spaces API

Spaces API

List all Routes for the Space

GET /v2/spaces/:guid/routes

Fields

Name Description Default Valid Values Example Values

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
  • 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1IiwiZW1haWwiOiJlbWFpbC0yOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE5OTg5OTYyfQ.JBzfriyz9oVCVrVxLBw2PnACA85FKgPWZ02ZGRjrYwc
Host: example.org
Cookie: 

Route

GET /v2/spaces/ff91cd66-2417-41c0-b285-cc3b47e04627/routes

cURL

curl "https://api.[your-domain.com]/v2/spaces/ff91cd66-2417-41c0-b285-cc3b47e04627/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1IiwiZW1haWwiOiJlbWFpbC0yOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE5OTg5OTYyfQ.JBzfriyz9oVCVrVxLBw2PnACA85FKgPWZ02ZGRjrYwc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4312722f-ac2f-4034-a886-64e847de5e03
Content-Length: 745
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "a3a78d77-e9d0-4fdc-a29b-80b1de93a38b",
        "url": "/v2/routes/a3a78d77-e9d0-4fdc-a29b-80b1de93a38b",
        "created_at": "2014-12-24T01:39:22+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-2",
        "domain_guid": "70b9fec2-4272-4b0a-8eae-6de49bae7fe7",
        "space_guid": "ff91cd66-2417-41c0-b285-cc3b47e04627",
        "domain_url": "/v2/domains/70b9fec2-4272-4b0a-8eae-6de49bae7fe7",
        "space_url": "/v2/spaces/ff91cd66-2417-41c0-b285-cc3b47e04627",
        "apps_url": "/v2/routes/a3a78d77-e9d0-4fdc-a29b-80b1de93a38b/apps"
      }
    }
  ]
}