Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cloud-foundry-service-offerings-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Cloud Foundry V3 Service Offerings API
description: '# Welcome to the Experimental Cloud Foundry V3 API Docs!'
version: latest
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
contact:
name: Cloud Foundry
url: https://www.cloudfoundry.org/
servers:
- url: https://api.example.local
description: Cloud Foundry V3 API server
security:
- oauth:
- cloud_controller.read
- cloud_controller.write
tags:
- name: Service Offerings
description: Service offerings are services that are available to be used.
paths:
/v3/service_offerings:
get:
summary: List service offerings
description: This endpoint retrieves the service offerings the user has access to.
operationId: listServiceOfferings
tags:
- Service Offerings
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/OrderBy'
- name: names
in: query
schema:
type: array
items:
type: string
description: Comma-delimited list of service offering names to filter by
- name: available
in: query
schema:
type: boolean
description: Filter by the `available` property; valid values are `true` or `false`
- name: service_broker_guids
in: query
schema:
type: array
items:
type: string
description: Comma-delimited list of service broker GUIDs to filter by
- name: space_guids
in: query
schema:
type: array
items:
type: string
description: Comma-delimited list of space guids to filter by
- name: organization_guids
in: query
schema:
type: array
items:
type: string
description: Comma-delimited list of organization guids to filter by
- name: service_broker_names
in: query
schema:
type: array
items:
type: string
description: Comma-delimited list of service broker names to filter by
- $ref: '#/components/parameters/LabelSelector'
- name: fields
in: query
schema:
type: object
description: Fields to include in the response
- $ref: '#/components/parameters/CreatedAts'
- $ref: '#/components/parameters/UpdatedAts'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceOfferingList'
examples:
default:
summary: default
value:
pagination:
total_results: 3
total_pages: 2
first:
href: https://api.example.org?page=1&per_page=2
last:
href: https://api.example.org?page=2&per_page=2
next:
href: https://api.example.org?page=2&per_page=2
previous: null
resources:
- guid: 123e4567-e89b-12d3-a456-426614174000
name: my_service_offering
description: Provides my service
available: true
tags:
- relational
- caching
requires: []
created_at: '2019-11-28T13:44:02Z'
updated_at: '2019-11-28T13:44:02Z'
shareable: true
documentation_url: https://some-documentation-link.io
broker_catalog:
id: db730a8c-11e5-11ea-838a-0f4fff3b1cfb
metadata:
shareable: true
features:
plan_updateable: true
bindable: true
instances_retrievable: true
bindings_retrievable: true
allow_context_updates: false
relationships:
service_broker:
data:
guid: 123e4567-e89b-12d3-a456-426614174000
metadata:
labels: {}
annotations: {}
links:
self:
href: https://api.example.org/v3/service_offerings/bf7eb420-11e5-11ea-b7db-4b5d5e7976a
service_plans:
href: https://api.example.org/v3/service_plans?service_offering_guids=bf7eb420-11e5-11ea-b7db-4b5d5e7976a
service_broker:
href: https://api.example.org/v3/service_brokers/13c60e38-11e7-11ea-9106-33ee3c5bd4d7
- guid: 123e4567-e89b-12d3-a456-426614174000
name: other_service_offering
description: Provides another service
available: true
tags:
- caching
requires: []
created_at: '2019-11-29T16:44:02Z'
updated_at: '2019-11-29T16:44:02Z'
shareable: true
documentation_url: https://some-other-documentation-link.io
broker_catalog:
id: 3cb11822-12bb-11ea-beb1-a350dc7453b9
metadata:
shareable: true
features:
plan_updateable: true
bindable: true
instances_retrievable: true
bindings_retrievable: true
allow_context_updates: false
relationships:
service_broker:
data:
guid: 123e4567-e89b-12d3-a456-426614174000
metadata:
labels: {}
annotations: {}
links:
self:
href: https://api.example.org/v3/service_offerings/20e6cd62-12bb-11ea-90d1-7bfec2c75bcd
service_plans:
href: https://api.example.org/v3/service_plans?service_offering_guids=20e6cd62-12bb-11ea-90d1-7bfec2c75bcd
service_broker:
href: https://api.example.org/v3/service_brokers/13c60e38-11e7-11ea-9106-33ee3c5bd4d7
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'409':
$ref: '#/components/responses/Conflict'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/BadGateway'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/v3/service_offerings/{guid}:
get:
summary: Get a service offering
description: This endpoint retrieves the service offering by GUID.
operationId: getServiceOffering
tags:
- Service Offerings
parameters:
- $ref: '#/components/parameters/Guid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceOffering'
examples:
default:
summary: default
value:
guid: 123e4567-e89b-12d3-a456-426614174000
name: my_service_offering
description: Provides my service
available: true
tags:
- relational
- caching
requires: []
created_at: '2019-11-28T13:44:02Z'
updated_at: '2019-11-28T13:44:02Z'
shareable: true
documentation_url: https://some-documentation-link.io
broker_catalog:
id: db730a8c-11e5-11ea-838a-0f4fff3b1cfb
metadata:
shareable: true
features:
plan_updateable: true
bindable: true
instances_retrievable: true
bindings_retrievable: true
allow_context_updates: false
relationships:
service_broker:
data:
guid: 123e4567-e89b-12d3-a456-426614174000
metadata:
labels: {}
annotations: {}
links:
self:
href: https://api.example.org/v3/service_offerings/bf7eb420-11e5-11ea-b7db-4b5d5e7976a
service_plans:
href: https://api.example.org/v3/service_plans?service_offering_guids=bf7eb420-11e5-11ea-b7db-4b5d5e7976a
service_broker:
href: https://api.example.org/v3/service_brokers/13c60e38-11e7-11ea-9106-33ee3c5bd4d7
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
patch:
summary: Update a service offering
description: This endpoint updates a service offering with labels and annotations.
operationId: updateServiceOffering
tags:
- Service Offerings
parameters:
- $ref: '#/components/parameters/Guid'
requestBody:
content:
application/json:
schema:
properties:
metadata:
$ref: '#/components/schemas/Metadata'
examples:
default:
summary: default
value:
metadata:
labels:
key: value
annotations:
note: detailed information
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceOffering'
examples:
default:
summary: default
value:
guid: 123e4567-e89b-12d3-a456-426614174000
name: my_service_offering
description: Provides my service
available: true
tags:
- relational
- caching
requires: []
created_at: '2019-11-28T13:44:02Z'
updated_at: '2019-11-28T13:44:02Z'
shareable: true
documentation_url: https://some-documentation-link.io
broker_catalog:
id: db730a8c-11e5-11ea-838a-0f4fff3b1cfb
metadata:
shareable: true
features:
plan_updateable: true
bindable: true
instances_retrievable: true
bindings_retrievable: true
allow_context_updates: false
relationships:
service_broker:
data:
guid: 123e4567-e89b-12d3-a456-426614174000
metadata:
labels: {}
annotations: {}
links:
self:
href: https://api.example.org/v3/service_offerings/bf7eb420-11e5-11ea-b7db-4b5d5e7976a
service_plans:
href: https://api.example.org/v3/service_plans?service_offering_guids=bf7eb420-11e5-11ea-b7db-4b5d5e7976a
service_broker:
href: https://api.example.org/v3/service_brokers/13c60e38-11e7-11ea-9106-33ee3c5bd4d7
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/ServiceUnavailable'
delete:
summary: Delete a service offering
description: 'This endpoint deletes a service offering. This is typically used to remove orphan service offerings from the Cloud Foundry database when they have been removed from the service broker catalog, or when the service broker has been removed.
Note that this operation only affects the Cloud Foundry database, and no attempt is made to contact the service broker.'
operationId: deleteServiceOffering
tags:
- Service Offerings
parameters:
- $ref: '#/components/parameters/Guid'
- name: purge
in: query
schema:
type: boolean
description: If `true`, any service plans, instances, and bindings associated with this service offering will also be deleted
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/500'
components:
schemas:
Pagination:
type: object
properties:
total_results:
type: integer
description: The total number of results available
total_pages:
type: integer
description: The total number of pages available
first:
allOf:
- $ref: '#/components/schemas/Link'
- description: The first page of results
last:
allOf:
- $ref: '#/components/schemas/Link'
- description: The last page of results
next:
oneOf:
- $ref: '#/components/schemas/Link'
- type: 'null'
description: The next page of results
previous:
oneOf:
- $ref: '#/components/schemas/Link'
- type: 'null'
description: The previous page of results
description: 'Pagination is a technique used to divide a large set of results into smaller, more manageable sets. This allows clients to retrieve results in smaller chunks, reducing the amount of data transferred and improving performance.
The pagination object is a JSON object that contains information about the pagination state of the results. It includes the total number of results available, the total number of pages available, and links to the first, last, next, and previous pages of results.
'
ServiceOfferingList:
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
resources:
type: array
items:
$ref: '#/components/schemas/ServiceOffering'
Link:
type: object
properties:
href:
type: string
description: The URL of the link
method:
type: string
description: An optional field containing the HTTP method to be used when following the URL
required:
- href
description: 'Each link is keyed by its type and will include a href for the URL and an optional method for links that cannot be followed using GET.
'
ServiceOffering:
type: object
allOf:
- $ref: '#/components/schemas/BaseSchema'
- properties:
service_broker_guid:
type: string
service_broker_name:
type: string
metadata:
$ref: '#/components/schemas/Metadata'
links:
type: object
properties:
self:
$ref: '#/components/schemas/Link'
description: The URL to get this service offering
service_plans:
$ref: '#/components/schemas/Link'
description: The URL to get the service plans for this offering
service_broker:
$ref: '#/components/schemas/Link'
description: The URL to get the service broker for this offering
Metadata:
type: object
properties:
labels:
type: object
additionalProperties:
type:
- string
- 'null'
description: 'A set of key-value pairs that describe the resource. Labels are a JSON object that contains information about a resource. They are used to tag resources with metadata that can be used to filter and group resources. Labels are included in the response body of a request to retrieve a resource.
Labels are user-specified key/value pairs that are attached to API Resources. They are queryable, identifying attributes of a resource, but they do not affect the operation of CloudFoundry.
For example, an app may be assigned a label with key sensitive and possible values true or false.
Users could then find all sensitive apps with a selector for sensitive=true, resulting in a response containing only apps having the label key sensitive with a label value of true.
Labels
Labels allow users to apply identifying attributes to resources that are meaningful to the user, but not the CloudFoundry system.
Examples may include (but are not limited to):
"production" : "true" or "production" : "false"
"env" : "dev" or "env" : "test" or "env" : "prod"
"chargeback-code" : "abc123"
Label keys
Label keys are made up of an (optional) prefix, and name. If a prefix is present, it is separated from the name by a /. Prefixes are dns names intended to enable namespacing of label keys.
A label key prefix must adhere to the following restrictions:
Length: 0-253 characters
Allowed characters: alphanumeric ( [a-z0-9A-Z] ), -, and .
DNS subdomain format (series of subdomain labels separated by .)
A label key name must adhere to the following restrictions:
Length: 1-63 characters
Allowed characters: alphanumeric ( [a-z0-9A-Z] ), -, _, and .
Must begin and end with an alphanumeric character
Label values
Label values must adhere to the following restrictions:
Length: 0-63 characters
Allowed characters: alphanumeric ( [a-z0-9A-Z] ), -, _, and .
Must begin and end with an alphanumeric character
Empty values are allowed
'
annotations:
type: object
additionalProperties:
type:
- string
- 'null'
description: 'A set of key-value pairs that describe the resource. Annotations are a JSON object that contains information about a resource. They are used to tag resources with metadata that can be used to filter and group resources. Annotations are included in the response body of a request to retrieve a resource.
Annotations are user-specified key-value pairs that are attached to API resources. They do not affect the operation of Cloud Foundry. Annotations cannot be used in filters.
When a service instance is being created, the service broker is sent the annotations of the service instance, and the space and organization in which the service instance resides. When a service instance is being updated, the service broker is sent the annotations of the space and organization in which the service instance resides. When a service binding is being created, the service broker is sent annotations of any associated app, and the space and organization in which the binding resides. Only annotations with a prefix (e.g. company.com/contacts) are sent to service brokers.
Examples may include (but are not limited to):
"contact info": "bob@example.com jane@example.com"
"library versions": "Spring: 5.1, Redis Client: a184098. yaml parser: 38"
"git-sha": "d56fe0367554ae5e878e37ed6c5b9a82f5995512"
Annotation keys
Annotation keys are made up of an (optional) prefix and name. If a prefix is present, it is separated from the name by a /. Prefixes are DNS names intended to enable namespacing of annotation keys.
An annotation key prefix must adhere to the following restrictions:
Length: 0-253 characters
Allowed characters: a-z, A-Z, 0-9, -, and .; emojis cannot be used in keys
DNS subdomain format (series of subdomain annotations separated by .)
An annotation key name must adhere to the following restrictions:
Length: 1-63 characters
Allowed characters: a-z, A-Z, 0-9, -, _, and .; emojis cannot be used in keys
Must begin and end with an alphanumeric character
Annotation values
Annotation values must adhere to the following restrictions:
Length: 0-5000 unicode characters
'
description: 'Metadata is a JSON object that contains information about a resource. It includes the GUID of the resource, the time the resource was created, the time the resource was last updated, and links to the resource.
Metadata is included in the response body of a request to retrieve a resource.
'
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
description: 'An error response will always return a list of error objects. Errors appear on the job resource for asynchronous operations.
Clients should use the code and title fields for programmatically handling specific errors. The message in the detail field is subject to change over time.
'
Error:
type: object
properties:
code:
type: integer
description: A numeric code for this error
detail:
type: string
description: Detailed description of the error
title:
type: string
description: Name of the error
BaseSchema:
type: object
properties:
guid:
type: string
format: uuid
description: The unique identifier for the resource
created_at:
type: string
format: date-time
description: The ISO8601 compatible date and time when resource was created
updated_at:
type: string
format: date-time
description: The ISO8601 compatible date and time when resource was last updated
description: 'A resource represents an individual object within the system, such as an app or a service. It is represented as a JSON object.
A resource consists of several required resource fields and other attributes specific to the resource.
See Resources and Experimental Resources for specific resources.
'
responses:
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
UnprocessableEntity:
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
NotFound:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
BadGateway:
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/html:
schema:
type: string
ServiceUnavailable:
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
OrderBy:
name: order_by
in: query
required: false
schema:
type: string
description: 'Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
'
example: created_at
CreatedAts:
name: created_ats
in: query
required: false
schema:
type: string
description: 'Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators).
'
example: '2021-01-01T00:00:00Z'
PerPage:
name: per_page
in: query
required: false
schema:
type: integer
description: Number of results per page, valid values are 1 through 5000
example: 50
LabelSelector:
name: label_selector
in: query
description: A query string containing a list of [label selector](#labels-and-selectors) requirements
required: false
schema:
type: string
example: environment=production
Page:
name: page
in: query
required: false
schema:
type: integer
description: Page to display; valid values are integers >= 1
example: 1
UpdatedAts:
name: updated_ats
in: query
required: false
schema:
type: string
description: 'Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators).
'
example: '2021-01-01T00:00:00Z'
Guid:
name: guid
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier for the resource
securitySchemes:
oauth:
type: oauth2
flows:
implicit:
authorizationUrl: https://uaa.cloudfoundry.local/api-oauth/dialog
scopes:
cloud_controller.admin: This scope provides read and write access to all resources
cloud_controller.admin_read_only: This scope provides read only access to all resources
cloud_controller.global_auditor: This scope provides read access to all resources
cloud_controller.read: Read access to the Cloud Controller
cloud_controller.write: Write access to the Cloud Controller
cloud_controller.update_build_state: This scope allows its bearer to update the state of a build; currently only used when updating builds
cloud_controller_service_permissions.read: This scope provides read only access for service instance permissions
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Bearer JWT token authentication