application broker API 0.7

Overview

The purpose of this application is to easily expose Cloud Foundry applications to marketplace as service offerings without implementing separate brokers for each of them.

Version information

Version: 0.1.0

Paths

Implementation of Service Broker API method (for details check http://docs.cloudfoundry.org/services/api.html).

PUT /service_instances/{instance_id}/service_bindings/{binding_id}

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Binds to specified service instance and returns credentials necessary to establish connection to that service.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	instance_id	Service instance GUID	true	string
PathParameter	binding_id	Service binding GUID	true	string

Responses

HTTP Code	Description	Schema
200	ServiceBindingResponse	ServiceBindingResponse
201	ServiceBindingResponse	ServiceBindingResponse
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Implementation of Service Broker API method (for details check http://docs.cloudfoundry.org/services/api.html).

DELETE /service_instances/{instance_id}/service_bindings/{binding_id}

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Unbinds specified service instance.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	instance_id	Service instance GUID	true	string
PathParameter	binding_id	Service binding GUID	true	string

Responses

HTTP Code	Description	Schema
200	OK	No Content
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Implementation of Service Broker API method (for details check http://docs.cloudfoundry.org/services/api.html).

GET /v2/catalog

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Returns the catalog of services managed by this broker.

Responses

HTTP Code	Description	Schema
200	CatalogExtensionResponse	CatalogExtension
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Appends service to the catalog managed by this broker

POST /v2/catalog

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Responses

HTTP Code	Description	Schema
201	ServiceExtensionResponse	ServiceExtension
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Updates service in the catalog managed by this broker

PUT /v2/catalog/{service_id}

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	service_id	Service GUID	true	string

Responses

HTTP Code	Description	Schema
200	ServiceExtensionResponse	ServiceExtension
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Deletes service description from the catalog

DELETE /v2/catalog/{service_id}

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	service_id	Service GUID	true	string

Responses

HTTP Code	Description	Schema
204	No Content	No Content
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Implementation of Service Broker API method (for details check http://docs.cloudfoundry.org/services/api.html).

PUT /v2/service_instances/{instance_id}

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Creates a service instance for specific plan.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	instance_id	Service instance GUID	true	string

Responses

HTTP Code	Description	Schema
201	ServiceCreationResponse	ServiceCreationResponse
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Implementation of Service Broker API method (for details check http://docs.cloudfoundry.org/services/api.html).

DELETE /v2/service_instances/{instance_id}

Description

Privilege level: Consumer of this endpoint must login using basic authentication credentials (valid login and password)

Deletes previously created service instance.

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	instance_id	Service instance GUID	true	string

Responses

HTTP Code	Description	Schema
200	OK	No Content
400	Bad Request	No Content
404	Not Found	No Content
409	Conflict	No Content
500	Internal Server Error	BrokerError

Definitions

Amount

Amount describers Cloud Foundry cost amount

Name	Description	Required	Schema	Default
usd		false	number (float)

BrokerError

BrokerError describes Cloud Foundry broker error

Name	Description	Required	Schema	Default
description		false	string

Catalog

Catalog describes Cloud Foundry catalog

Name	Description	Required	Schema	Default
services		false	Service array

CatalogExtension

Name	Description	Required	Schema	Default
services		false	ServiceExtension array

CfApp

Name	Required	Schema
buildpack	false	string
command	false	string
disk_quota	false	integer (int64)
environment_json	false	object
instances	false	integer (int64)
memory	false	integer (int64)
name	false	string
path	false	string
routes_url	false	string
space_guid	false	string
state	false	string

CfAppInstance

Name	Description	Required	Schema	Default
since		false	number (double)
state		false	string

CfAppResource

Name	Description	Required	Schema	Default
entity		false	CfApp
metadata		false	CfMeta

CfAppSummary

Name	Required	Schema
buildpack	false	string
command	false	string
disk_quota	false	integer (int64)
environment_json	false	object
guid	false	string
instances	false	integer (int64)
memory	false	integer (int64)
name	false	string
path	false	string
routes	false	CfAppSummaryRoute array
routes_url	false	string
services	false	CfAppSummaryService array
space_guid	false	string
state	false	string

CfAppSummaryRoute

Name	Required	Schema
domain	false	CfDomain
guid	false	string
host	false	string

CfAppSummaryService

Name	Required	Schema
guid	false	string
name	false	string
service_plan	false	CfAppSummaryServicePlan

CfAppSummaryServicePlan

Name	Required	Schema
Service	false	CfAppSummaryServicePlanService
guid	false	string
name	false	string

CfAppSummaryServicePlanService

Name	Description	Required	Schema	Default
guid		false	string
label		false	string

CfAppsResponse

cfAppsResponse describes the Cloud Controller API result for a list of apps

Name	Required	Schema
resources	false	CfAppResource array
total_pages	false	integer (int64)
total_results	false	integer (int64)

CfBinding

CFBindingResponse describes a CF Service Binding within the Cloud Controller

Name	Required	Schema
app_guid	false	string
guid	false	string
service_instance_guid	false	string

CfBindingResource

Name	Description	Required	Schema	Default
entity		false	CfBinding
metadata		false	CfMeta

CfBindingsResources

Name	Description	Required	Schema	Default
resources		false	CfBindingResource array
total_results		false	integer (int64)

CfCopyBitsRequest

Name	Description	Required	Schema	Default
source_app_guid		false	string

CfCreateRouteRequest

Name	Required	Schema
domain_guid	false	string
host	false	string
space_guid	false	string

CfDomain

Name	Description	Required	Schema	Default
guid		false	string
name		false	string

CfDomainResponse

Name	Description	Required	Schema	Default
entity		false	CfDomain
metadata		false	CfMeta

CfJob

Name	Required	Schema
error	false	string
guid	false	string
status	false	string

CfJobResponse

Name	Description	Required	Schema	Default
entity		false	CfJob
metadata		false	CfMeta

CfMeta

Name	Description	Required	Schema	Default
guid		false	string
url		false	string

CfRoute

Name	Required	Schema
domain_guid	false	string
domain_url	false	string
host	false	string

CfRouteResource

Name	Description	Required	Schema	Default
entity		false	CfRoute
metadata		false	CfMeta

CfRoutesResponse

Name	Required	Schema
resources	false	CfRouteResource array
total_pages	false	integer (int64)
total_results	false	integer (int64)

CfService

Name	Required	Schema
label	false	string
provider	false	string
service_broker_guid	false	string
service_plans_url	false	string

CfServiceBindingCreateRequest

Name	Required	Schema
app_guid	false	string
parameters	false	object
service_instance_guid	false	string

CfServiceBindingCreateResponse

Name	Description	Required	Schema	Default
metadata		false	CfMeta

CfServiceBroker

Name	Required	Schema
auth_password	false	string
auth_username	false	string
broker_url	false	string
name	false	string

CfServiceBrokerResource

Name	Description	Required	Schema	Default
entity		false	CfServiceBroker
metadata		false	CfMeta

CfServiceBrokerResources

Name	Description	Required	Schema	Default
resources		false	CfServiceBrokerResource array
total_results		false	integer (int64)

CfServiceContext

CfServiceContext describes a CF Service Instance within the Cloud Controller

Name	Required	Schema
AppName	false	string
InstanceID	false	string
InstanceName	false	string
OrgName	false	string
SpaceGUID	false	string
SpaceName	false	string

CfServiceInstanceCreateRequest

Name	Required	Schema
name	false	string
parameters	false	object
service_plan_guid	false	string
space_guid	false	string
tags	false	string array

CfServiceInstanceCreateResponse

Name	Description	Required	Schema	Default
metadata		false	CfMeta

CfServicePlanResource

Name	Description	Required	Schema	Default
entity		false	CfAppSummaryServicePlan
metadata		false	CfMeta

CfServicePlansResources

Name	Description	Required	Schema	Default
resources		false	CfServicePlanResource array
total_results		false	integer (int64)

CfServiceResource

Name	Description	Required	Schema	Default
entity		false	CfService
metadata		false	CfMeta

CfServicesResources

Name	Description	Required	Schema	Default
resources		false	CfServiceResource array
total_results		false	integer (int64)

CfSpace

Name	Required	Schema
guid	false	string
name	false	string
organization_guid	false	string

CfSpaceResource

Name	Description	Required	Schema	Default
entity		false	CfSpace
metadata		false	CfMeta

CfUserProvidedService

Name	Required	Schema
credentials	false	object
name	false	string
route_service_url	false	string
space_guid	false	string
syslog_drain_url	false	string

CfUserProvidedServiceResource

Name	Description	Required	Schema	Default
entity		false	CfUserProvidedService
metadata		false	CfMeta

CfVcapApplication

Name	Description	Required	Schema	Default
name		false	string
uris		false	string array

Cost

Cost describers Cloud Foundry plan Cost

Name	Description	Required	Schema	Default
amount		false	Amount
unit		false	string

Dashboard

Dashboard describes Cloud Foundry dashboard

Name	Required	Schema
id	false	string
redirect_uri	false	string
secret	false	string

Plan

Plan describes Cloud Foundry plan structure

Name	Required	Schema
description	false	string
free	false	boolean
id	false	string
metadata	false	PlanMeta
name	false	string

PlanMeta

PlanMeta describers Cloud Foundry plan meta-data

Name	Required	Schema
bullets	false	string array
costs	false	string
displayName	false	string

Service

Service describes Cloud Foundry service

Name	Required	Schema
bindable	false	boolean
dashboard_client	false	Dashboard
description	false	string
id	false	string
metadata	false	ServiceMeta
name	false	string
plans	false	Plan array
requires	false	string array
tags	false	string array

ServiceBindingRequest

ServiceBindingRequest describes Cloud Foundry service binding request

Name	Required	Schema
app_guid	false	string
plan_id	false	string
service_id	false	string

ServiceBindingResponse

ServiceBindingResponse describes Cloud Foundry service binding response

Name	Description	Required	Schema	Default
credentials		false	object

ServiceConfiguration

Name	Description	Required	Schema	Default
parameters		false	string array
service_name		false	string

ServiceCreationRequest

ServiceCreationRequest describes Cloud Foundry service provisioning request

Name	Required	Schema
Parameters	false	object
organization_guid	false	string
plan_id	false	string
service_id	false	string
space_guid	false	string

ServiceCreationResponse

ServiceCreationResponse describes Cloud Foundry service provisioning response

Name	Description	Required	Schema	Default
dashboard_url		false	string

ServiceExtension

Name	Required	Schema
app	false	CfAppResource
bindable	false	boolean
configuration	false	ServiceConfiguration array
dashboard_client	false	Dashboard
description	false	string
id	false	string
metadata	false	ServiceMeta
name	false	string
plans	false	Plan array
requires	false	string array
tags	false	string array

ServiceInstanceExtension

Name	Required	Schema
app	false	CfAppResource
id	false	string
service_id	false	string

ServiceLastOperationResponse

ServiceMeta

ServiceMeta describers Cloud Foundry service meta-data

Name	Required	Schema
displayName	false	string
documentationUrl	false	string
imageUrl	false	string
longDescription	false	string
providerDisplayName	false	string
supportUrl	false	string

Home | FAQs