Class: Spaces

Spaces

Manage Spaces on Cloud Foundry

Constructor

new Spaces(endPoint)

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

Methods

add(spaceOptions) → {JSON}

Create a Space http://apidocs.cloudfoundry.org/222/spaces/creating_a_space.html
Parameters:
Name Type Description
spaceOptions JSON [Space options]
Source:
Returns:
[return a JSON response]
Type
JSON

getSpace(guid) → {JSON}

Get a Space http://apidocs.cloudfoundry.org/214/spaces/retrieve_a_particular_space.html
Parameters:
Name Type Description
guid String [Space guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getSpaceApps(guid, filter) → {JSON}

Get Apps in a Space http://apidocs.cloudfoundry.org/214/spaces/list_all_apps_for_the_space.html
Parameters:
Name Type Description
guid String [Space guid]
filter JSON [Filter]
Source:
Returns:
[return a JSON response]
Type
JSON
Example
qs: {
                'q': 'name:' + params.appName,
                'inline-relations-depth': 1
            }

getSpaces() → {JSON}

Get Spaces http://apidocs.cloudfoundry.org/214/spaces/list_all_spaces.html
Source:
Returns:
[return a JSON response]
Type
JSON

getSummary(guid) → {JSON}

Get Space summary http://apidocs.cloudfoundry.org/222/spaces/get_space_summary.html
Parameters:
Name Type Description
guid String [Space guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getUserRoles(guid) → {JSON}

Get User Roles http://apidocs.cloudfoundry.org/222/spaces/retrieving_the_roles_of_all_users_in_the_space.html
Parameters:
Name Type Description
guid String [Space guid]
Source:
Returns:
[return a JSON response]
Type
JSON

remove(guid, spaceOptions) → {JSON}

Delete a Space http://apidocs.cloudfoundry.org/222/spaces/delete_a_particular_space.html
Parameters:
Name Type Description
guid String [Space uid]
spaceOptions JSON [Space options]
Source:
Returns:
[return a JSON response]
Type
JSON