Home
Version 3
User Provided Service Instances API

User Provided Service Instances API

List all Routes for the User Provided Service Instance

GET /v2/user_provided_service_instances/:guid/routes

Request

Route

GET /v2/user_provided_service_instances/7bfcf123-f2f9-4ee2-bcd7-3b7e487847bb/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
route_guid The guid of the route

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MSIsImVtYWlsIjoiZW1haWwtMjYzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5Njd9.XqxktT7c_xojL2ah_niL8quBVQtQlsZnnKgQJ-YZCaQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/7bfcf123-f2f9-4ee2-bcd7-3b7e487847bb/routes" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MSIsImVtYWlsIjoiZW1haWwtMjYzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5Njd9.XqxktT7c_xojL2ah_niL8quBVQtQlsZnnKgQJ-YZCaQ" \
	-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": "b3f64653-abd7-4df9-9587-dabb1ac6349a",
        "url": "/v2/routes/b3f64653-abd7-4df9-9587-dabb1ac6349a",
        "created_at": "2015-10-15T23:52:47Z",
        "updated_at": "2015-10-15T23:52:47Z"
      },
      "entity": {
        "host": "host-26",
        "path": "",
        "domain_guid": "8c954c77-68ab-4f85-a5e3-7bff6c451c3d",
        "space_guid": "3f5602f6-4017-44d4-b380-ddd0f1fea3a8",
        "service_instance_guid": "7bfcf123-f2f9-4ee2-bcd7-3b7e487847bb",
        "port": 0,
        "domain_url": "/v2/domains/8c954c77-68ab-4f85-a5e3-7bff6c451c3d",
        "space_url": "/v2/spaces/3f5602f6-4017-44d4-b380-ddd0f1fea3a8",
        "service_instance_url": "/v2/user_provided_service_instances/7bfcf123-f2f9-4ee2-bcd7-3b7e487847bb",
        "apps_url": "/v2/routes/b3f64653-abd7-4df9-9587-dabb1ac6349a/apps"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 92131dce-7f24-4b90-9b31-60c046d775e1
Content-Length: 979
X-Content-Type-Options: nosniff