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/26fae4d0-df82-42f3-ac67-da5873e3a277/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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NSIsImVtYWlsIjoiZW1haWwtMTEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTB9.Jq7TR96C6Fu-dolLa7sGF1qW3t3jbEH8kLCgo7Wf6cM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/26fae4d0-df82-42f3-ac67-da5873e3a277/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NSIsImVtYWlsIjoiZW1haWwtMTEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTB9.Jq7TR96C6Fu-dolLa7sGF1qW3t3jbEH8kLCgo7Wf6cM" \
	-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": "674b6eac-4a22-4a9d-bee2-b61299a57bf4",
        "url": "/v2/routes/674b6eac-4a22-4a9d-bee2-b61299a57bf4",
        "created_at": "2016-06-08T16:41:30Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-17",
        "path": "",
        "domain_guid": "8580604f-60e0-4903-a73f-f2e5e6660a68",
        "space_guid": "276011c4-0550-4a01-82d5-7e9c95feb9ae",
        "service_instance_guid": "26fae4d0-df82-42f3-ac67-da5873e3a277",
        "port": null,
        "domain_url": "/v2/private_domains/8580604f-60e0-4903-a73f-f2e5e6660a68",
        "space_url": "/v2/spaces/276011c4-0550-4a01-82d5-7e9c95feb9ae",
        "service_instance_url": "/v2/service_instances/26fae4d0-df82-42f3-ac67-da5873e3a277",
        "apps_url": "/v2/routes/674b6eac-4a22-4a9d-bee2-b61299a57bf4/apps",
        "route_mappings_url": "/v2/routes/674b6eac-4a22-4a9d-bee2-b61299a57bf4/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a71d7a39-860e-48e0-b361-acafe9d6561d
Content-Length: 1054
X-Content-Type-Options: nosniff