Home
Version 3
Service Instances API

Service Instances API

List all Routes for the Service Instance

GET /v2/service_instances/:guid/routes

Request

Route

GET /v2/service_instances/ee686001-6348-43b9-8fd2-6cef12e78a00/routes

Parameters

Name Description Valid Values Example Values
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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyIiwiZW1haWwiOiJlbWFpbC0yMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU4NTk5NDIyfQ.Mf8oUoG8nEQPJuJQGlGa4CJa9y2P6HulYksMFxmCVUE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/ee686001-6348-43b9-8fd2-6cef12e78a00/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyIiwiZW1haWwiOiJlbWFpbC0yMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU4NTk5NDIyfQ.Mf8oUoG8nEQPJuJQGlGa4CJa9y2P6HulYksMFxmCVUE" \
	-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": "c8d8ee57-8fb0-4989-9ae7-ae7f9e605fff",
        "url": "/v2/routes/c8d8ee57-8fb0-4989-9ae7-ae7f9e605fff",
        "created_at": "2016-03-14T22:30:22Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-5",
        "path": "",
        "domain_guid": "fc254454-f3e6-4f35-9895-0a7dbeb8c904",
        "space_guid": "3f77049f-466d-4a49-9583-f86c6d03a9fd",
        "service_instance_guid": "ee686001-6348-43b9-8fd2-6cef12e78a00",
        "port": 0,
        "domain_url": "/v2/domains/fc254454-f3e6-4f35-9895-0a7dbeb8c904",
        "space_url": "/v2/spaces/3f77049f-466d-4a49-9583-f86c6d03a9fd",
        "service_instance_url": "/v2/service_instances/ee686001-6348-43b9-8fd2-6cef12e78a00",
        "apps_url": "/v2/routes/c8d8ee57-8fb0-4989-9ae7-ae7f9e605fff/apps",
        "route_mappings_url": "/v2/routes/c8d8ee57-8fb0-4989-9ae7-ae7f9e605fff/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1042
X-Content-Type-Options: nosniff