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/56c6bdfd-7c40-4ef6-b003-11fcb2067f48/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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxNiIsImVtYWlsIjoiZW1haWwtMjg0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NjB9.1uj7b_uXmHf4eEPKFTOsFtjK5iRdsetqSx9knOpCfEQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/56c6bdfd-7c40-4ef6-b003-11fcb2067f48/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxNiIsImVtYWlsIjoiZW1haWwtMjg0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NjB9.1uj7b_uXmHf4eEPKFTOsFtjK5iRdsetqSx9knOpCfEQ" \
	-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": "14e0216c-21ef-4eb7-a213-e6fe358d7dd1",
        "url": "/v2/routes/14e0216c-21ef-4eb7-a213-e6fe358d7dd1",
        "created_at": "2015-09-30T23:31:00Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-19",
        "path": "",
        "domain_guid": "fe9b3492-50dc-4f78-946d-45820b5facf8",
        "space_guid": "f9327175-5258-46c4-966c-50453bd5ef99",
        "service_instance_guid": "56c6bdfd-7c40-4ef6-b003-11fcb2067f48",
        "domain_url": "/v2/domains/fe9b3492-50dc-4f78-946d-45820b5facf8",
        "space_url": "/v2/spaces/f9327175-5258-46c4-966c-50453bd5ef99",
        "service_instance_url": "/v2/service_instances/56c6bdfd-7c40-4ef6-b003-11fcb2067f48",
        "apps_url": "/v2/routes/14e0216c-21ef-4eb7-a213-e6fe358d7dd1/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f4008836-df41-45ac-889a-71155e598c1a
Content-Length: 928
X-Content-Type-Options: nosniff