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/a91ecd32-c622-4e8d-ab40-a6151d2564f2/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

Body

Name Description Default Valid Values Example Values
guid The guid of the Service Instance.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTgwIiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzODM3MjU2fQ.kzhAq8Y6ZJWOdVTATTuttPRkXwoQ9rxwP1UUVe5_ByE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/a91ecd32-c622-4e8d-ab40-a6151d2564f2/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTgwIiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzODM3MjU2fQ.kzhAq8Y6ZJWOdVTATTuttPRkXwoQ9rxwP1UUVe5_ByE" \
	-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": "c5dc2675-9b65-4814-bd9b-b36254767a5b",
        "url": "/v2/routes/c5dc2675-9b65-4814-bd9b-b36254767a5b",
        "created_at": "2016-01-19T19:40:56Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-1",
        "path": "",
        "domain_guid": "f4d85686-94f7-40dc-86e7-102b2d7ff1fb",
        "space_guid": "9d97e7b5-78b5-4270-8461-0fac20661f3e",
        "service_instance_guid": "a91ecd32-c622-4e8d-ab40-a6151d2564f2",
        "port": 0,
        "domain_url": "/v2/domains/f4d85686-94f7-40dc-86e7-102b2d7ff1fb",
        "space_url": "/v2/spaces/9d97e7b5-78b5-4270-8461-0fac20661f3e",
        "service_instance_url": "/v2/service_instances/a91ecd32-c622-4e8d-ab40-a6151d2564f2",
        "apps_url": "/v2/routes/c5dc2675-9b65-4814-bd9b-b36254767a5b/apps"
      }
    }
  ]
}

Headers

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