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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOSIsImVtYWlsIjoiZW1haWwtMTY3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDd9.J66JJp_QoybTvaBpZ7yZXGWadZBnOjvN6RzG10ciWwE
Host: example.org
Cookie: 

Route

GET /v2/spaces/b8389020-f491-47bc-b731-c395cc942abe/routes

cURL

curl "https://api.[your-domain.com]/v2/spaces/b8389020-f491-47bc-b731-c395cc942abe/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOSIsImVtYWlsIjoiZW1haWwtMTY3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDd9.J66JJp_QoybTvaBpZ7yZXGWadZBnOjvN6RzG10ciWwE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8d579f77-0174-4621-b55f-49dbe5c362f0
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": "fa53ee3a-0639-4a60-ada6-afb858706d4e",
        "url": "/v2/routes/fa53ee3a-0639-4a60-ada6-afb858706d4e",
        "created_at": "2014-11-13T23:38:27+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-3",
        "domain_guid": "2b467aa1-44ed-42a2-a759-dc89f4b18a2e",
        "space_guid": "b8389020-f491-47bc-b731-c395cc942abe",
        "domain_url": "/v2/domains/2b467aa1-44ed-42a2-a759-dc89f4b18a2e",
        "space_url": "/v2/spaces/b8389020-f491-47bc-b731-c395cc942abe",
        "apps_url": "/v2/routes/fa53ee3a-0639-4a60-ada6-afb858706d4e/apps"
      }
    }
  ]
}