How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cloud Foundry

Open Service Broker API

The Open Service Broker API is the open specification originally developed by Cloud Foundry and now used by Kubernetes and other platforms to provision and manage backing services through a common HTTP interface. Brokers expose a catalog and lifecycle operations for service instances and bindings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Open Service Broker API is one of 14 APIs that Cloud Foundry publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Marketplace, Open Standard, and Service Broker. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 10 operations across 5 paths, organized into 3 resource areas, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version master - might contain changes that are not yet released.

Requests are made against 2 base URLs: http://example.com, http://localhost:3000.

10 operations 5 paths 29 schemas 2 DELETE5 GET1 PATCH2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
master - might contain changes that are not yet released
Base URL
https://{broker-host}
Authentication
HTTP Basic
Contact
Open Service Broker API
License
Apache 2.0
Resource Areas
3

Authentication & Security 1

Open Service Broker API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 2 DELETE, 5 GET, 1 PATCH, 2 PUT. They span 3 resource areas: Catalog, ServiceInstances, ServiceBindings. Each is listed below with its method, path, parameters, and response codes.

Catalog 1
GET
/v2/catalog
get the catalog of services that the service broker offers
catalog.get 1 param → 200
ServiceInstances 5
PUT
/v2/service_instances/{instance_id}
provision a service instance
serviceInstance.provision 4 params body → 200201202400401409422
PATCH
/v2/service_instances/{instance_id}
update a service instance
serviceInstance.update 4 params body → 200202400401422
DELETE
/v2/service_instances/{instance_id}
deprovision a service instance
serviceInstance.deprovision 6 params → 200202400401410422
GET
/v2/service_instances/{instance_id}
get a service instance
serviceInstance.get 5 params → 200404
GET
/v2/service_instances/{instance_id}/last_operation
get the last requested operation state for service instance
serviceInstance.lastOperation.get 5 params → 200400401404410
ServiceBindings 4
GET
/v2/service_instances/{instance_id}/service_bindings/{binding_id}/last_operation
get the last requested operation state for service binding
serviceBinding.lastOperation.get 6 params → 200400401404410
PUT
/v2/service_instances/{instance_id}/service_bindings/{binding_id}
generate a service binding
serviceBinding.binding 5 params body → 200201202400401409422
DELETE
/v2/service_instances/{instance_id}/service_bindings/{binding_id}
deprovision a service binding
serviceBinding.unbinding 7 params → 200202400401410422
GET
/v2/service_instances/{instance_id}/service_bindings/{binding_id}
get a service binding
serviceBinding.get 6 params → 200404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Service (11 properties), Plan (11 properties), ServiceBindingResource (7 properties), ServiceBindingRequest (7 properties). Each schema is shown below with its type and property counts.

Catalog
object
1 property
Service
object
11 properties 5 required
DashboardClient
object
3 properties
Plan
object
11 properties 3 required
Schemas
object
2 properties
ServiceInstanceSchema
object
2 properties
ServiceBindingSchema
object
1 property
ServiceInstanceResource
object
6 properties
ServiceInstanceProvisionRequestBody
object
6 properties 4 required
ServiceInstanceProvisionResponse
object
2 properties
ServiceInstanceAsyncOperation
object
3 properties
ServiceInstanceMetadata
object
2 properties
ServiceInstanceUpdateRequestBody
object
5 properties 1 required
ServiceInstancePreviousValues
object
4 properties
AsyncOperation
object
1 property
LastOperationResource
object
4 properties 1 required
ServiceBindingResource
object
7 properties
ServiceBindingRequest
object
7 properties 2 required
ServiceBindingMetadata
object
2 properties
ServiceBindingResouceObject
object
2 properties
ServiceBindingResponse
object
6 properties
ServiceBindingEndpoint
object
3 properties 2 required
ServiceBindingVolumeMount
object
5 properties 5 required
ServiceBindingVolumeMountDevice
object
3 properties 1 required
Context
object
See [Context Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.mdcontext-object) for more details.
Metadata
object
See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.mdservice-metadata) for more details.
MaintenanceInfo
object
2 properties 1 required
Object
object
Error
object
See [Service Broker Errors](https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.mdservice-broker-errors) for more details.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloud-foundry-open-service-broker-api-openapi.yaml Raw ↑

Other APIs Cloud Foundry publishes across the network.

Cloud Foundry Cloud Controller API v3
AE Profile APIs.io
Cloud Foundry UAA
AE Profile APIs.io
Cloud Foundry Loggregator
AE Profile APIs.io
BOSH Director API
AE Profile APIs.io
Cloud Foundry Apps API
AE Profile APIs.io
Cloud Foundry Builds API
AE Profile APIs.io
Cloud Foundry Cloud Foundry Cloud Controller API V3 API
AE Profile APIs.io
Cloud Foundry Deployments API
AE Profile APIs.io
Cloud Foundry Jobs API
AE Profile APIs.io
Cloud Foundry Organizations API
AE Profile APIs.io
Cloud Foundry Service Instances API
AE Profile APIs.io
Cloud Foundry Spaces API
AE Profile APIs.io
#Marketplace#Open Standard#Service Broker
← Back to O APIs
API Details
ID
cloud-foundry:open-service-broker-api
Base URL
https://{broker-host}
Docs
https://www.openservicebrokerapi.org/
Provider
Cloud Foundry
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=open-service-broker-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/open-service-broker-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Open Service Broker API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.