Service Instances API

List all Routes for the Service Instance

GET /v2/service_instances/:guid/routes

Request

Route

GET /v2/service_instances/5a485a2b-ecbe-47b7-aea4-67c0eac9520f/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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NyIsImVtYWlsIjoiZW1haWwtMTczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDZ9.vMSVRznx526h0gQ4fuL6I5lFVnYwPJiZBP5KvOjawTw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/5a485a2b-ecbe-47b7-aea4-67c0eac9520f/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NyIsImVtYWlsIjoiZW1haWwtMTczQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDZ9.vMSVRznx526h0gQ4fuL6I5lFVnYwPJiZBP5KvOjawTw" \
	-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": "0dfb8ad6-31e0-4205-b03d-a91b91f7d332",
        "url": "/v2/routes/0dfb8ad6-31e0-4205-b03d-a91b91f7d332",
        "created_at": "2015-08-31T21:50:06Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-14",
        "path": "",
        "domain_guid": "4519501e-9f91-4ee6-a91d-565db24f8446",
        "space_guid": "f3807c3c-af31-4544-a89f-7cb87f281599",
        "service_instance_guid": "5a485a2b-ecbe-47b7-aea4-67c0eac9520f",
        "domain_url": "/v2/domains/4519501e-9f91-4ee6-a91d-565db24f8446",
        "space_url": "/v2/spaces/f3807c3c-af31-4544-a89f-7cb87f281599",
        "service_instance_url": "/v2/service_instances/5a485a2b-ecbe-47b7-aea4-67c0eac9520f",
        "apps_url": "/v2/routes/0dfb8ad6-31e0-4205-b03d-a91b91f7d332/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2a6a3407-5f75-4620-a73d-11b39c84ee47
Content-Length: 928
X-Content-Type-Options: nosniff