Home
Version 3
Spaces API

Spaces API

List all Routes for the Space

GET /v2/spaces/:guid/routes

Request

Route

GET /v2/spaces/cf871a48-7720-4d84-9617-ee727e223f45/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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NyIsImVtYWlsIjoiZW1haWwtMjA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NDV9.Z3P30StgG2-wWJtt3rhpsrUhayP_nzKm8ka25HENfYk
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces/cf871a48-7720-4d84-9617-ee727e223f45/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NyIsImVtYWlsIjoiZW1haWwtMjA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NDV9.Z3P30StgG2-wWJtt3rhpsrUhayP_nzKm8ka25HENfYk" \
	-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": "f8487b0d-101d-4683-9249-9c349b364859",
        "url": "/v2/routes/f8487b0d-101d-4683-9249-9c349b364859",
        "created_at": "2015-11-03T00:54:04Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-29",
        "path": "",
        "domain_guid": "4046cfa6-ee94-40a9-8134-9e34472c553e",
        "space_guid": "cf871a48-7720-4d84-9617-ee727e223f45",
        "service_instance_guid": null,
        "port": 0,
        "domain_url": "/v2/domains/4046cfa6-ee94-40a9-8134-9e34472c553e",
        "space_url": "/v2/spaces/cf871a48-7720-4d84-9617-ee727e223f45",
        "apps_url": "/v2/routes/f8487b0d-101d-4683-9249-9c349b364859/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1aa2dcae-884e-49a6-a127-85c3783d69e3
Content-Length: 819
X-Content-Type-Options: nosniff