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/941631c2-885f-44d6-86e3-457da3c48031/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, generate_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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NiIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5Njd9.OBcv6rjrpvXDFKRhgb9ZFMtiCSLpT_uGkYE8iDvWN8I
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/941631c2-885f-44d6-86e3-457da3c48031/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NiIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5Njd9.OBcv6rjrpvXDFKRhgb9ZFMtiCSLpT_uGkYE8iDvWN8I" \
	-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": "819e7666-a98a-43d8-9f08-7e8c98b7a003",
        "url": "/v2/routes/819e7666-a98a-43d8-9f08-7e8c98b7a003",
        "created_at": "2015-11-13T17:02:47Z",
        "updated_at": null
      },
      "entity": {
        "host": "host-25",
        "path": "",
        "domain_guid": "b8f7217e-9b58-4f55-8a6f-17d10b88e7bb",
        "space_guid": "69e5024a-ba13-4b46-8551-0ace9c9f582d",
        "service_instance_guid": "941631c2-885f-44d6-86e3-457da3c48031",
        "port": 0,
        "domain_url": "/v2/domains/b8f7217e-9b58-4f55-8a6f-17d10b88e7bb",
        "space_url": "/v2/spaces/69e5024a-ba13-4b46-8551-0ace9c9f582d",
        "service_instance_url": "/v2/service_instances/941631c2-885f-44d6-86e3-457da3c48031",
        "apps_url": "/v2/routes/819e7666-a98a-43d8-9f08-7e8c98b7a003/apps"
      }
    }
  ]
}

Headers

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