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/897ebe05-44b3-4c69-8e82-917cc754c222/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

Body

Name Description Default Valid Values Example Values
parameters Arbitrary parameters to pass along to the service broker. Must be a JSON object.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MiIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MjB9.IG9di8e8jZh6QgIxm1O5glx8HZpHVomfj4lK9dZAhMc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/897ebe05-44b3-4c69-8e82-917cc754c222/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MiIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MjB9.IG9di8e8jZh6QgIxm1O5glx8HZpHVomfj4lK9dZAhMc" \
	-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": "885d230c-86ff-4ac7-bf0f-d0919725f712",
        "url": "/v2/routes/885d230c-86ff-4ac7-bf0f-d0919725f712",
        "created_at": "2016-01-26T22:20:19Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-25",
        "path": "",
        "domain_guid": "ab966795-6e55-4b6c-9b2a-21384b2788aa",
        "space_guid": "6afb2d41-d9e4-4922-b928-f104adaf7513",
        "service_instance_guid": "897ebe05-44b3-4c69-8e82-917cc754c222",
        "port": 0,
        "domain_url": "/v2/domains/ab966795-6e55-4b6c-9b2a-21384b2788aa",
        "space_url": "/v2/spaces/6afb2d41-d9e4-4922-b928-f104adaf7513",
        "service_instance_url": "/v2/service_instances/897ebe05-44b3-4c69-8e82-917cc754c222",
        "apps_url": "/v2/routes/885d230c-86ff-4ac7-bf0f-d0919725f712/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 947
X-Content-Type-Options: nosniff