Home
Version 3
Spaces API

Spaces API

List all Routes for the Space

GET /v2/spaces/:guid/routes

Request

Route

GET /v2/spaces/f1a8f1e7-141c-4aa9-9cf8-b16dc72ede64/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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTExMiIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MTM3NDYyN30.OCaEGAEIgBQpv6zpeuPW4Iro98224SXV0PX1GbpxUgc
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces/f1a8f1e7-141c-4aa9-9cf8-b16dc72ede64/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMiIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MTM3NDYyN30.OCaEGAEIgBQpv6zpeuPW4Iro98224SXV0PX1GbpxUgc" \
	-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": "8e516dee-8ad9-4487-be32-87f224ca7616",
        "url": "/v2/routes/8e516dee-8ad9-4487-be32-87f224ca7616",
        "created_at": "2016-04-16T01:23:47Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-6",
        "path": "",
        "domain_guid": "71318222-a234-46b1-bb78-2437614d41ab",
        "space_guid": "f1a8f1e7-141c-4aa9-9cf8-b16dc72ede64",
        "service_instance_guid": null,
        "port": null,
        "domain_url": "/v2/domains/71318222-a234-46b1-bb78-2437614d41ab",
        "space_url": "/v2/spaces/f1a8f1e7-141c-4aa9-9cf8-b16dc72ede64",
        "apps_url": "/v2/routes/8e516dee-8ad9-4487-be32-87f224ca7616/apps",
        "route_mappings_url": "/v2/routes/8e516dee-8ad9-4487-be32-87f224ca7616/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: be391df8-ea7f-4d8b-9a04-02e5a23ead72
Content-Length: 917
X-Content-Type-Options: nosniff