Home
Version 3
Spaces API

Spaces API

List all Routes for the Space

GET /v2/spaces/:guid/routes

Request

Route

GET /v2/spaces/c9f2fb49-937e-471d-927a-0afc250fe7db/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, port
  • 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1IiwiZW1haWwiOiJlbWFpbC0yNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUxNDEzNjc2fQ.6cBQyjhIbsApGIA2O2UvCspplljm7lC4TUqbAbKP4No
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/c9f2fb49-937e-471d-927a-0afc250fe7db/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1IiwiZW1haWwiOiJlbWFpbC0yNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUxNDEzNjc2fQ.6cBQyjhIbsApGIA2O2UvCspplljm7lC4TUqbAbKP4No" \
	-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": "9529683e-c2d4-483b-a122-a81298cb7105",
        "url": "/v2/routes/9529683e-c2d4-483b-a122-a81298cb7105",
        "created_at": "2015-12-22T18:27:56Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-1",
        "path": "",
        "domain_guid": "a513608e-87d8-4b80-ac53-201ed559524f",
        "space_guid": "c9f2fb49-937e-471d-927a-0afc250fe7db",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/a513608e-87d8-4b80-ac53-201ed559524f",
        "space_url": "/v2/spaces/c9f2fb49-937e-471d-927a-0afc250fe7db",
        "apps_url": "/v2/routes/9529683e-c2d4-483b-a122-a81298cb7105/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 818
X-Content-Type-Options: nosniff