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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMjEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjd9.Tsi81KNDnhsKpFU4TC7swYxK3qp3LDo35m3WUJOubBM
Host: example.org
Cookie: 

Route

GET /v2/spaces/ac0ad37f-c2b3-45c0-92ea-5f31da0c963d/routes

cURL

curl "https://api.[your-domain.com]/v2/spaces/ac0ad37f-c2b3-45c0-92ea-5f31da0c963d/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMjEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjd9.Tsi81KNDnhsKpFU4TC7swYxK3qp3LDo35m3WUJOubBM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e334995d-26c5-4939-b509-e12390daaaff
Content-Length: 746
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "0bb55898-fc6e-4bcb-a917-d13647ebf789",
        "url": "/v2/routes/0bb55898-fc6e-4bcb-a917-d13647ebf789",
        "created_at": "2014-11-24T19:32:47+00:00",
        "updated_at": null
      },
      "entity": {
        "host": "host-12",
        "domain_guid": "feec092f-5275-4989-b0b7-fc2deb1da939",
        "space_guid": "ac0ad37f-c2b3-45c0-92ea-5f31da0c963d",
        "domain_url": "/v2/domains/feec092f-5275-4989-b0b7-fc2deb1da939",
        "space_url": "/v2/spaces/ac0ad37f-c2b3-45c0-92ea-5f31da0c963d",
        "apps_url": "/v2/routes/0bb55898-fc6e-4bcb-a917-d13647ebf789/apps"
      }
    }
  ]
}