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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC02MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg5fQ.uPppNVZQG27r0n8xokecmfuFqrD87RZ3kAoSRF2tDoc
Host: example.org
Cookie: 

Route

GET /v2/spaces/4c36eed4-4fde-405d-905f-1f62ce42d82b/routes

cURL

curl "https://api.[your-domain.com]/v2/spaces/4c36eed4-4fde-405d-905f-1f62ce42d82b/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC02MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg5fQ.uPppNVZQG27r0n8xokecmfuFqrD87RZ3kAoSRF2tDoc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fa90b4a5-1d59-4e4b-82af-90bfc53d0c7d
Content-Length: 740
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "7a24c56e-e4cc-4070-8849-4e7b7a7f61f6",
        "url": "/v2/routes/7a24c56e-e4cc-4070-8849-4e7b7a7f61f6",
        "created_at": "2015-02-13T22:34:49Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-1",
        "domain_guid": "8eaa935e-0344-453b-8d63-9ebf3408dae0",
        "space_guid": "4c36eed4-4fde-405d-905f-1f62ce42d82b",
        "domain_url": "/v2/domains/8eaa935e-0344-453b-8d63-9ebf3408dae0",
        "space_url": "/v2/spaces/4c36eed4-4fde-405d-905f-1f62ce42d82b",
        "apps_url": "/v2/routes/7a24c56e-e4cc-4070-8849-4e7b7a7f61f6/apps"
      }
    }
  ]
}