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/4c496207-8ede-4af1-90c3-bdf3c93d6c27/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
guid The guid of the Service Instance.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNSIsImVtYWlsIjoiZW1haWwtMjI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5ODd9.Am3Q76HLThws4P7h8b661oKqef1060KNwagoBSSkiQ4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/4c496207-8ede-4af1-90c3-bdf3c93d6c27/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNSIsImVtYWlsIjoiZW1haWwtMjI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5ODd9.Am3Q76HLThws4P7h8b661oKqef1060KNwagoBSSkiQ4" \
	-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": "a7ea8347-5ffa-4bff-b286-5f9f9acc1ecd",
        "url": "/v2/routes/a7ea8347-5ffa-4bff-b286-5f9f9acc1ecd",
        "created_at": "2016-01-13T17:29:47Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-8",
        "path": "",
        "domain_guid": "10e5a0c9-cc19-49f4-97cf-05223c6de274",
        "space_guid": "e41a58b0-7998-4d90-b614-7130bc905126",
        "service_instance_guid": "4c496207-8ede-4af1-90c3-bdf3c93d6c27",
        "port": 0,
        "domain_url": "/v2/domains/10e5a0c9-cc19-49f4-97cf-05223c6de274",
        "space_url": "/v2/spaces/e41a58b0-7998-4d90-b614-7130bc905126",
        "service_instance_url": "/v2/service_instances/4c496207-8ede-4af1-90c3-bdf3c93d6c27",
        "apps_url": "/v2/routes/a7ea8347-5ffa-4bff-b286-5f9f9acc1ecd/apps"
      }
    }
  ]
}

Headers

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