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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOCIsImVtYWlsIjoiZW1haWwtMjQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODR9.Mu_mMJh5tEctuBfx1aH5wK-DVI9BkKQUetBLNd0uIiI
Host: example.org
Cookie: 

Route

GET /v2/spaces/58b4c283-bfd8-4c61-ba02-c00b395b7cf8/routes

cURL

curl "https://api.[your-domain.com]/v2/spaces/58b4c283-bfd8-4c61-ba02-c00b395b7cf8/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOCIsImVtYWlsIjoiZW1haWwtMjQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODR9.Mu_mMJh5tEctuBfx1aH5wK-DVI9BkKQUetBLNd0uIiI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ca72e332-48eb-4266-b8f7-3aeb848871dc
Content-Length: 741
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "e9ed4993-fc90-400c-98da-d5a0c0c9178f",
        "url": "/v2/routes/e9ed4993-fc90-400c-98da-d5a0c0c9178f",
        "created_at": "2015-01-27T19:14:44Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-20",
        "domain_guid": "78c6d5b5-8b37-434f-9795-70321b03d268",
        "space_guid": "58b4c283-bfd8-4c61-ba02-c00b395b7cf8",
        "domain_url": "/v2/domains/78c6d5b5-8b37-434f-9795-70321b03d268",
        "space_url": "/v2/spaces/58b4c283-bfd8-4c61-ba02-c00b395b7cf8",
        "apps_url": "/v2/routes/e9ed4993-fc90-400c-98da-d5a0c0c9178f/apps"
      }
    }
  ]
}