Cloud Foundry website screenshot

Cloud Foundry

Cloud Foundry is an open-source, multi-cloud Platform as a Service (PaaS) governed by the Cloud Foundry Foundation. It provides a developer-friendly application platform where operators push source code or container images and Cloud Foundry handles staging, routing, scaling, and lifecycle management. The CF API (api.cloudfoundry.org) is the primary control plane and is documented at v3.cloudfoundry.org/version/release-candidate. The ecosystem also includes the User Account and Authentication (UAA) OAuth 2.0 server, the Loggregator log and metric pipeline, the Diego container scheduler, the Open Service Broker API for marketplace services, and the Eirini Kubernetes-based scheduler.

5 APIs 0 Features
Cloud Foundry FoundationContainersMulti-CloudOpen SourcePaaSPlatform

APIs

Cloud Foundry Cloud Controller API v3

The Cloud Controller API v3 is the primary REST control plane for Cloud Foundry. It manages organizations, spaces, applications, processes, builds, droplets, packages, routes, d...

Cloud Foundry UAA

The User Account and Authentication (UAA) server is Cloud Foundry's identity provider and OAuth 2.0 authorization server. It issues tokens consumed by the Cloud Controller, brok...

Cloud Foundry Loggregator

Loggregator is Cloud Foundry's distributed log and metric pipeline that aggregates application logs, platform component logs, and metrics for streaming consumption by users and ...

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

BOSH Director API

BOSH is Cloud Foundry's release engineering tool for packaging, deploying, and managing distributed software. The BOSH Director API exposes deployment, stemcell, release, task, ...

Collections

Cloud Foundry Cloud Controller API v3

OPEN

Semantic Vocabularies

Cloud Foundry Context

0 classes · 11 properties

JSON-LD

API Governance Rules

Cloud Foundry API Rules

10 rules · 4 errors 5 warnings 1 info

SPECTRAL

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
👥
GitHub
GitHub
🔗
Foundation
Foundation
🔗
Community
Community
🔗
Slack
Slack
📰
Blog
Blog
🔗
Events
Events
📜
PrivacyPolicy
PrivacyPolicy
🔗
Trademark
Trademark
🔗
JSONLD
JSONLD
🔗
Spectral
Spectral

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Cloud Foundry Cloud Controller API v3
  version: 3.220.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: API root
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/
  docs: Returns links to V2 and V3 endpoints and other metadata.
- info:
    name: V3 root
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3
  docs: V3 root
- info:
    name: List apps
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/apps
    params:
    - name: page
      value: ''
      type: query
    - name: per_page
      value: ''
      type: query
    - name: names
      value: ''
      type: query
    - name: space_guids
      value: ''
      type: query
    - name: organization_guids
      value: ''
      type: query
  docs: List apps
- info:
    name: Create app
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/apps
    body:
      type: json
      data: '{}'
  docs: Create app
- info:
    name: Get app
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/apps/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Get app
- info:
    name: Update app
    type: http
  http:
    method: PATCH
    url: https://api.cloudfoundry.org/v3/apps/:guid
    params:
    - name: guid
      value: ''
      type: path
    body:
      type: json
      data: '{}'
  docs: Update app
- info:
    name: Delete app
    type: http
  http:
    method: DELETE
    url: https://api.cloudfoundry.org/v3/apps/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Delete app
- info:
    name: Start app
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/apps/:guid/actions/start
    params:
    - name: guid
      value: ''
      type: path
  docs: Start app
- info:
    name: Stop app
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/apps/:guid/actions/stop
    params:
    - name: guid
      value: ''
      type: path
  docs: Stop app
- info:
    name: List organizations
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/organizations
    params:
    - name: page
      value: ''
      type: query
    - name: per_page
      value: ''
      type: query
    - name: names
      value: ''
      type: query
  docs: List organizations
- info:
    name: Create organization
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/organizations
    body:
      type: json
      data: '{}'
  docs: Create organization
- info:
    name: Get organization
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/organizations/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Get organization
- info:
    name: Update organization
    type: http
  http:
    method: PATCH
    url: https://api.cloudfoundry.org/v3/organizations/:guid
    params:
    - name: guid
      value: ''
      type: path
    body:
      type: json
      data: '{}'
  docs: Update organization
- info:
    name: Delete organization
    type: http
  http:
    method: DELETE
    url: https://api.cloudfoundry.org/v3/organizations/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Delete organization
- info:
    name: List spaces
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/spaces
    params:
    - name: page
      value: ''
      type: query
    - name: per_page
      value: ''
      type: query
    - name: names
      value: ''
      type: query
    - name: organization_guids
      value: ''
      type: query
  docs: List spaces
- info:
    name: Create space
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/spaces
    body:
      type: json
      data: '{}'
  docs: Create space
- info:
    name: Get space
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/spaces/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Get space
- info:
    name: Update space
    type: http
  http:
    method: PATCH
    url: https://api.cloudfoundry.org/v3/spaces/:guid
    params:
    - name: guid
      value: ''
      type: path
    body:
      type: json
      data: '{}'
  docs: Update space
- info:
    name: Delete space
    type: http
  http:
    method: DELETE
    url: https://api.cloudfoundry.org/v3/spaces/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Delete space
- info:
    name: List service instances
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/service_instances
    params:
    - name: page
      value: ''
      type: query
    - name: per_page
      value: ''
      type: query
  docs: List service instances
- info:
    name: Create service instance
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/service_instances
    body:
      type: json
      data: '{}'
  docs: Create service instance
- info:
    name: Get service instance
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/service_instances/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Get service instance
- info:
    name: Update service instance
    type: http
  http:
    method: PATCH
    url: https://api.cloudfoundry.org/v3/service_instances/:guid
    params:
    - name: guid
      value: ''
      type: path
    body:
      type: json
      data: '{}'
  docs: Update service instance
- info:
    name: Delete service instance
    type: http
  http:
    method: DELETE
    url: https://api.cloudfoundry.org/v3/service_instances/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Delete service instance
- info:
    name: List builds
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/builds
    params:
    - name: page
      value: ''
      type: query
    - name: per_page
      value: ''
      type: query
  docs: List builds
- info:
    name: Create build
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/builds
    body:
      type: json
      data: '{}'
  docs: Create build
- info:
    name: List deployments
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/deployments
    params:
    - name: page
      value: ''
      type: query
    - name: per_page
      value: ''
      type: query
  docs: List deployments
- info:
    name: Create deployment
    type: http
  http:
    method: POST
    url: https://api.cloudfoundry.org/v3/deployments
    body:
      type: json
      data: '{}'
  docs: Create deployment
- info:
    name: Get job
    type: http
  http:
    method: GET
    url: https://api.cloudfoundry.org/v3/jobs/:guid
    params:
    - name: guid
      value: ''
      type: path
  docs: Long-running asynchronous job status.
bundled: true