Class: Routes

Routes

new Routes(endPoint)

Manages Routes for Cloud Foundry
Parameters:
Name Type Description
endPoint String [CC endpoint]
Source:

Methods

add(token_type, access_token, routeOptions) → {JSON}

Add a Route http://apidocs.cloudfoundry.org/213/routes/creating_a_route.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
routeOptions JSON [route options]
Source:
Returns:
[return a JSON response]
Type
JSON

getRoute(token_type, access_token, guid) → {JSON}

Get a Route http://apidocs.cloudfoundry.org/214/routes/retrieve_a_particular_route.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
guid String [route guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getRoutes(token_type, access_token, filter) → {JSON}

Get Routes http://apidocs.cloudfoundry.org/214/routes/list_all_routes.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
filter JSON [Search options]
Source:
Returns:
[return a JSON response]
Type
JSON
Example
Paging: /v2/routes?order-direction=asc&page=2&results-per-page=50

qs: {
    'page': page,
    'results-per-page': 50
}

remove(token_type, access_token, route_guid) → {String}

Remove a Route http://apidocs.cloudfoundry.org/214/routes/delete_a_particular_route.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
route_guid String [route guid]
Source:
Returns:
[output]
Type
String

setEndPoint(endPoint)

Set endpoint
Parameters:
Name Type Description
endPoint String [CC endpoint]
Source: