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/db416d0e-cc01-4390-94ac-ae99280683c4/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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NCIsImVtYWlsIjoiZW1haWwtMjYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDh9.vtAR2_itMnAezl1PS80S5OiocvoFxHQa_DbCkMtlt-g
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/db416d0e-cc01-4390-94ac-ae99280683c4/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2NCIsImVtYWlsIjoiZW1haWwtMjYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDh9.vtAR2_itMnAezl1PS80S5OiocvoFxHQa_DbCkMtlt-g" \
	-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": "51f515f2-f75f-4bf4-84b8-45d981cda466",
        "url": "/v2/routes/51f515f2-f75f-4bf4-84b8-45d981cda466",
        "created_at": "2015-09-11T18:39:08Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-21",
        "path": "",
        "domain_guid": "4f3caca2-308f-483b-a3d1-c6e1084e4bbc",
        "space_guid": "f273cf8d-9a01-43ca-b89f-bfc40ef5ba8a",
        "service_instance_guid": "db416d0e-cc01-4390-94ac-ae99280683c4",
        "domain_url": "/v2/domains/4f3caca2-308f-483b-a3d1-c6e1084e4bbc",
        "space_url": "/v2/spaces/f273cf8d-9a01-43ca-b89f-bfc40ef5ba8a",
        "service_instance_url": "/v2/service_instances/db416d0e-cc01-4390-94ac-ae99280683c4",
        "apps_url": "/v2/routes/51f515f2-f75f-4bf4-84b8-45d981cda466/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 81444a01-a084-4e6f-b08c-158cd9b40ce4
Content-Length: 928
X-Content-Type-Options: nosniff