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/3dbe1f33-8cd3-4b1a-b387-3e539cbbbabe/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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC01M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ0NzgyOTIzfQ.nKLbkcGdyJzrXFnGV8OvI2OT1B9kCYW56QPcfZzwahY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/3dbe1f33-8cd3-4b1a-b387-3e539cbbbabe/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC01M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ0NzgyOTIzfQ.nKLbkcGdyJzrXFnGV8OvI2OT1B9kCYW56QPcfZzwahY" \
	-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": "39f23172-c4f8-47f8-9b71-c35b0d6d6286",
        "url": "/v2/routes/39f23172-c4f8-47f8-9b71-c35b0d6d6286",
        "created_at": "2015-10-07T00:35:23Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-3",
        "path": "",
        "domain_guid": "876f4fc5-11e8-4bc8-8b33-9b584653577f",
        "space_guid": "c4a96db0-3b2d-4c1a-88ce-548b2ff41d03",
        "service_instance_guid": "3dbe1f33-8cd3-4b1a-b387-3e539cbbbabe",
        "domain_url": "/v2/domains/876f4fc5-11e8-4bc8-8b33-9b584653577f",
        "space_url": "/v2/spaces/c4a96db0-3b2d-4c1a-88ce-548b2ff41d03",
        "service_instance_url": "/v2/service_instances/3dbe1f33-8cd3-4b1a-b387-3e539cbbbabe",
        "apps_url": "/v2/routes/39f23172-c4f8-47f8-9b71-c35b0d6d6286/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f5bc652a-81fc-4738-bb60-f3d1b694e758
Content-Length: 927
X-Content-Type-Options: nosniff