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/5943f724-cf2f-46c2-aba9-1fb96872581d/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.eyJ1c2VyX2lkIjoidWFhLWlkLTExMCIsImVtYWlsIjoiZW1haWwtNzlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.7SYsSFSOPMT752MJaHjC_cE86Cm3QtX56nIJXUXOsds
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/5943f724-cf2f-46c2-aba9-1fb96872581d/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMCIsImVtYWlsIjoiZW1haWwtNzlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.7SYsSFSOPMT752MJaHjC_cE86Cm3QtX56nIJXUXOsds" \
	-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": "9d4d97c5-c4a7-4799-b560-ddc2e870f461",
        "url": "/v2/routes/9d4d97c5-c4a7-4799-b560-ddc2e870f461",
        "created_at": "2016-05-12T00:45:08Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-10",
        "path": "",
        "domain_guid": "79b0cace-7dd3-4625-a0f3-0524f876c20c",
        "space_guid": "e18c7e29-9678-4a9c-803e-c202a6e46944",
        "service_instance_guid": "5943f724-cf2f-46c2-aba9-1fb96872581d",
        "port": null,
        "domain_url": "/v2/domains/79b0cace-7dd3-4625-a0f3-0524f876c20c",
        "space_url": "/v2/spaces/e18c7e29-9678-4a9c-803e-c202a6e46944",
        "service_instance_url": "/v2/service_instances/5943f724-cf2f-46c2-aba9-1fb96872581d",
        "apps_url": "/v2/routes/9d4d97c5-c4a7-4799-b560-ddc2e870f461/apps",
        "route_mappings_url": "/v2/routes/9d4d97c5-c4a7-4799-b560-ddc2e870f461/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 91ffc6e5-917a-4e75-bcec-cd44f04a1196
Content-Length: 1046
X-Content-Type-Options: nosniff