Class: ServiceInstances

ServiceInstances

new ServiceInstances(endPoint)

Manages Service Instances on Cloud Foundry
Parameters:
Name Type Description
endPoint String [CC endpoint]
Source:

Methods

create(token_type, access_token, appOptions) → {json}

Create a Service Instance https://apidocs.cloudfoundry.org/226/service_instances/delete_a_service_instance.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
appOptions json [options to create the application]
Source:
Returns:
[information about the application]
Type
json

getInstance(token_type, access_token, service_instance_guid) → {JSON}

Get a Service Instance https://apidocs.cloudfoundry.org/226/service_instances/retrieve_a_particular_service_instance.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
service_instance_guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstanceBindings(token_type, access_token, service_instance_guid) → {JSON}

Get a Service Instance Bindings https://apidocs.cloudfoundry.org/226/service_instances/list_all_service_bindings_for_the_service_instance.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
service_instance_guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstancePermissions(token_type, access_token, service_instance_guid) → {JSON}

Get a Service Instance Permissions https://apidocs.cloudfoundry.org/226/service_instances/retrieving_permissions_on_a_service_instance.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
service_instance_guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstanceRoutes(token_type, access_token, service_instance_guid) → {JSON}

Get a Service Instance Routes https://apidocs.cloudfoundry.org/226/service_instances/list_all_routes_for_the_service_instance.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
service_instance_guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

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

Get Service Instances https://apidocs.cloudfoundry.org/226/service_instances/list_all_service_instances.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
filter String [query string]
Source:
Returns:
[return a JSON response]
Type
JSON

remove(token_type, access_token, service_instance_guid)

Remove a Service Instance https://apidocs.cloudfoundry.org/226/service_instances/delete_a_service_instance.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
service_instance_guid String [service_instance_guid]
Source:

setEndPoint(endPoint)

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