Class: ServiceInstances

ServiceInstances

Manages Service Instances on Cloud Foundry

Constructor

new ServiceInstances(endPoint)

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

Methods

create(appOptions) → {JSON}

Create a Service Instance https://apidocs.cloudfoundry.org/226/service_instances/delete_a_service_instance.html
Parameters:
Name Type Description
appOptions JSON [options to create the application]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstance(guid) → {JSON}

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

getInstanceBindings(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
guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstancePermissions(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
guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstanceRoutes(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
guid String [servicePlan guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getInstances(filter) → {JSON}

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

remove(guid) → {JSON}

Remove a Service Instance https://apidocs.cloudfoundry.org/226/service_instances/delete_a_service_instance.html
Parameters:
Name Type Description
guid String [Service Instance guid]
Source:
Returns:
[return a JSON response]
Type
JSON