Constructor
new Routes(endPoint, options) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
endPoint |
String | [CC endpoint] |
options |
Object | [Configuration options] |
- Source:
Returns:
- Type
- void
Methods
add(routeOptions) → {Promise}
Create a new Route
v2: http://apidocs.cloudfoundry.org/214/routes/creating_a_route.html
v3: https://v3-apidocs.cloudfoundry.org/#create-a-route
Parameters:
| Name | Type | Description |
|---|---|---|
routeOptions |
Object | [Route options] |
- Source:
Returns:
[Promise resolving to created route]
- Type
- Promise
getApps(guid, filter) → {Promise}
Get apps associated with a Route
v2: http://apidocs.cloudfoundry.org/214/routes/list_all_apps_for_the_route.html
v3: https://v3-apidocs.cloudfoundry.org/#list-route-destinations
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | [Route GUID] |
filter |
Object | [Filter options] |
- Source:
Returns:
[Promise resolving to apps list]
- Type
- Promise
getRoute(guid) → {Promise}
Get a specific Route by GUID
v2: http://apidocs.cloudfoundry.org/214/routes/retrieve_a_particular_route.html
v3: https://v3-apidocs.cloudfoundry.org/#get-a-route
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | [Route GUID] |
- Source:
Returns:
[Promise resolving to route]
- Type
- Promise
getRoutes(filter) → {Promise}
Get Routes (supports both v2 and v3)
v2: http://apidocs.cloudfoundry.org/214/routes/list_all_routes.html
v3: https://v3-apidocs.cloudfoundry.org/#list-routes
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
Object | [Filter options] |
- Source:
Returns:
[Promise resolving to routes list]
- Type
- Promise
remove(guid, deleteOptions) → {Promise}
Delete a Route
v2: http://apidocs.cloudfoundry.org/214/routes/delete_a_route.html
v3: https://v3-apidocs.cloudfoundry.org/#delete-a-route
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | [Route GUID] |
deleteOptions |
Object | [Delete options] |
- Source:
Returns:
[Promise resolving to delete result]
- Type
- Promise
update(guid, routeOptions) → {Promise}
Update a Route
v2: http://apidocs.cloudfoundry.org/214/routes/updating_a_route.html
v3: https://v3-apidocs.cloudfoundry.org/#update-a-route
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | [Route GUID] |
routeOptions |
Object | [Route options] |
- Source:
Returns:
[Promise resolving to updated route]
- Type
- Promise