Class: Spaces

Spaces

new Spaces(endPoint)

Manage Spaces on Cloud Foundry
Parameters:
Name Type Description
endPoint String [CC endpoint]
Source:

Methods

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

Create a Space http://apidocs.cloudfoundry.org/222/spaces/creating_a_space.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
Source:
Returns:
  • spaceOptions [Space option]
    Type
    JSON
  • [return a JSON response]
    Type
    JSON
Example
var spaceOptions = {

 }

getSpace(token_type, access_token, space_guid) → {JSON}

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

getSpaceApps(token_type, access_token, space_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
token_type String [Authentication type]
access_token String [Authentication token]
space_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(token_type, access_token) → {JSON}

Get Spaces http://apidocs.cloudfoundry.org/214/spaces/list_all_spaces.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
Source:
Returns:
[return a JSON response]
Type
JSON

getSummary(token_type, access_token, space_guid) → {JSON}

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

getUserRoles(token_type, access_token, space_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
token_type String [Authentication type]
access_token String [Authentication token]
space_guid String [Space guid]
Source:
Returns:
[return a JSON response]
Type
JSON

remove(token_type, access_token, space_guid) → {JSON|JSON}

Delete a Space http://apidocs.cloudfoundry.org/222/spaces/delete_a_particular_space.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
space_guid String [Space uid]
Source:
Returns:
  • spaceOptions [Space option]
    Type
    JSON
  • [return a JSON response]
    Type
    JSON

setEndPoint(endPoint)

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