Cloud Foundry

Cloud Foundry Service Instances API

The Service Instances API from Cloud Foundry — 2 operation(s) for service instances.

GitHub OpenAPI

Operations 5

GET /v3/service_instances List service instances
POST /v3/service_instances Create service instance
GET /v3/service_instances/{guid} Get service instance
PATCH /v3/service_instances/{guid} Update service instance
DELETE /v3/service_instances/{guid} Delete service instance

Documentation

📖
Documentation
https://v3-apidocs.cloudfoundry.org/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloud-foundry/refs/heads/main/openapi/cloud-foundry-service-instances-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/cloud-foundry/refs/heads/main/collections/cloud-foundry-service-instances-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/cloud-foundry/refs/heads/main/collections/cloud-foundry-service-instances-api.opencollection.json
🔗
Source Code
https://github.com/cloudfoundry/cloud_controller_ng

Work with this as data

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-instances-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.

GitHub Google LinkedIn

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

OpenAPI Specification

cloud-foundry-service-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cloud Foundry Cloud Controller API v3 Apps Service Instances API
  description: 'Cloud Foundry Cloud Controller API v3 is the primary control plane of

    Cloud Foundry. It manages apps, packages, droplets, processes, tasks,

    organizations, spaces, service instances, and related resources.

    Requests authenticate with OAuth 2.0 bearer tokens issued by the

    Cloud Foundry UAA server.

    '
  version: 3.220.0
servers:
- url: https://api.cloudfoundry.org
  description: Public Cloud Foundry CC API endpoint (replace with your foundation host)
security:
- bearerAuth: []
tags:
- name: Service Instances
paths:
  /v3/service_instances:
    get:
      summary: List service instances
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Service instances page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
      tags:
      - Service Instances
    post:
      summary: Create service instance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceInstance'
      responses:
        '202':
          description: Accepted (asynchronous)
      tags:
      - Service Instances
  /v3/service_instances/{guid}:
    parameters:
    - $ref: '#/components/parameters/GuidParam'
    get:
      summary: Get service instance
      responses:
        '200':
          description: Service instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInstance'
      tags:
      - Service Instances
    patch:
      summary: Update service instance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceInstance'
      responses:
        '202':
          description: Accepted
      tags:
      - Service Instances
    delete:
      summary: Delete service instance
      responses:
        '202':
          description: Accepted
      tags:
      - Service Instances
components:
  schemas:
    PaginatedResponse:
      type: object
      properties:
        pagination:
          type: object
          properties:
            total_results:
              type: integer
            total_pages:
              type: integer
            first:
              type: object
            last:
              type: object
            next:
              type: object
            previous:
              type: object
        resources:
          type: array
          items:
            type: object
    ServiceInstance:
      type: object
      properties:
        guid:
          type: string
        name:
          type: string
        type:
          type: string
        relationships:
          type: object
  parameters:
    PerPage:
      name: per_page
      in: query
      schema:
        type: integer
        default: 50
    GuidParam:
      name: guid
      in: path
      required: true
      schema:
        type: string
    Page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT