The Cloud Controller API (CAPI) v3 is the primary control plane of Cloud Foundry. It manages apps, packages, droplets, builds, deployments, processes, tasks, revisions, routes, domains, organizations, spaces, roles, security groups, service brokers, offerings, plans, instances and credential bindings. The Cloud Foundry Foundation publishes a machine-readable OpenAPI 3.1 description of the surface from the cf-openapi project (158 paths / 248 operations), rendered at cloudfoundry.github.io/cf-openapi. Requests authenticate with OAuth 2.0 bearer tokens issued by the UAA server; there is no single public host because every Cloud Foundry foundation is self-hosted at its own api..
Cloud Foundry Cloud Controller API v3 is one of 14 APIs that Cloud Foundry publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Cloud Foundry Cloud Controller API V3, Application, Deployment, Organization, and Spaces. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes
248 operations
across 158 paths,
organized into 38 resource areas,
and defines 97 schemas.
It is described by OpenAPI 3.1.0, at version latest.
Requests are made against a single base URL, https://api.example.local.
248 operations158 paths97 schemas34 DELETE121 GET40 PATCH51 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Cloud Foundry Cloud Controller API v3 declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth) using the implicit flow, exposing 7 scopes.
It accepts HTTP bearer tokens (JWT) (bearer).
By default, every request must be authenticated.
bearer — Bearer JWT token authentication
Paths & Operations 248
Across 158 paths, the API surfaces 248 operations — 34 DELETE, 121 GET, 40 PATCH, 51 POST, 2 PUT. They span 38 resource areas, including Root, Admin, Apps, App Usage Events, Audit Events, Builds, Buildpacks, Deployments, and 30 more. Each is listed below with its method, path, parameters, and response codes.
Root 2
Root API endpoints that provide entry points and API information.
GET
/
Global API Root
getApiRoot→ 200404500
GET
/v3
Get V3 API root
getV3ApiRoot→ 200404500
Admin 1
Administrative operations for Cloud Foundry platform management.
POST
/v3/admin/actions/clear_buildpack_cache
Clear the buildpack cache
clearBuildpackCache→ 202401403404
Apps 21
Apps are top-level objects that link together and contain configuration information for your packages, droplets, processes, tasks, and more.
A manifest is a method for applying bulk configurations to apps and their underlying processes.
GET
/v3/apps/{guid}/manifest
Generate a manifest for an app
generateManifest1 param→ 200400401403404409422500
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are RouteDestination (9 properties), AppUsageEvent (9 properties), User (8 properties), IncludedResources (8 properties). Each schema is shown below with its type and property counts.
BaseSchema
object
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 r…
3 properties
Relationships
object
Relationships represent associations between resources. When relationships are mutable, they can be used to create, read, update, and delete these associations…
Relationship
object
1 property
RelationshipToOne
object
Some relationships relate a resource to exactly one other resource. For example an app can belong to only one space.
2 properties
RelationshipToMany
object
Some relationships relate a resource to several other resources. For example, an isolation segment can be entitled to multiple organizations.
2 properties
UserRelationshipToOne
objectnull
1 property
IncludedResources
object
Additional related resources included in the response when using the include parameter
8 properties
Link
object
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.
2 properties1 required
Pagination
object
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,…
6 properties
Metadata
object
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 res…
2 properties
Buildpack
object
A buildpack represents a set of scripts used to prepare an application for launch.
BuildpackList
object
2 properties
User
object
8 properties
Droplet
object
A droplet is the result of staging an application package. There are two types (lifecycles) of droplets buildpack and docker. In the case of the buildpacks, th…
DropletList
object
2 properties
Lifecycle
object
The lifecycle type defines how the application droplet is created and run. The following lifecycle types are supported: - buildpack: Traditional buildpacks for…
2 properties
Domain
object
A domain is a fully qualified domain name that is used for application routes. A domain can be scoped to an organization, meaning it can be used to create rout…
DomainList
object
2 properties
EnvironmentVariableGroup
object
Environment variable groups allow platform operators/admins to manage environment variables across all apps in a Cloud Foundry foundation. Variables in the run…
4 properties
Deployment
object
Deployments are objects that manage updates to applications with zero downtime. They can either: - Manage updating an app’s droplet directly after an applicati…
DeploymentList
object
2 properties
FeatureFlag
object
Feature flags are runtime flags that enable or disable functionality on the API.
5 properties
FeatureFlagList
object
2 properties
Build
object
Builds represent the process of transforming source code into a runnable artifact. Builds can be triggered manually or automatically as part of the app lifecyc…
BuildList
object
2 properties
AuditEvent
object
Audit events help Cloud Foundry operators monitor actions taken against resources (such as apps) via user or system actions.
AuditEventList
object
2 properties
App
object
Apps represent the core entities in the Cloud Foundry environment. They are the deployable units that run your code. Each app can have multiple processes, rout…
AppList
object
3 properties
AppEnvironment
object
Environment variables that will be provided to an app at runtime
5 properties
AppEnvironmentVariables
object
App environment variables with links
2 properties
AppPermissions
object
User permissions for an app
2 properties2 required
AppSshEnabled
object
SSH enabled status for an app
2 properties1 required
Route
object
A route in Cloud Foundry is used to direct traffic from a URL to an application.
RouteDestination
object
A route destination is a specification for where traffic on a route should be directed.
9 properties
RouteDestinationList
object
A list of route destinations
2 properties
Job
object
Jobs are created by the platform when performing certain asynchronous actions. Asynchronous jobs are commonly used for long-running tasks such as uploading lar…
Error
object
3 properties
Warning
object
1 property
AppUsageEvent
object
App usage events are a record of changes in the usage of apps and tasks. Examples include starting an application, scaling an application (from, say, one to th…
9 properties
AppUsageEventList
object
2 properties
IsolationSegment
object
An isolation segment provides a dedicated pool of compute resources for an organization or space.
IsolationSegmentList
object
2 properties
Organization
object
An org is a development account that an individual or multiple collaborators can own and use. All collaborators access an org with user accounts. Collaborators…
OrganizationList
object
A paginated list of organizations
2 properties
OrganizationQuota
object
Organization quotas are named sets of memory, log rate, service, and instance usage quotas. For example, one organization quota might allow up to 10 services,…
OrganizationQuotaList
object
A paginated list of organization quotas
Package
object
A package represents an application"s "source code" - either raw bits or a pointer to these bits. Packages are used to create builds, which result in a droplet…
PackageList
object
2 properties
Process
object
A process defines the runnable units of an app
ProcessList
A list of processes
ProcessStats
object
Statistics for a process
1 property
SecurityGroup
object
ServiceBroker
object
AppCredentialBinding
object
KeyCredentialBinding
object
ManagedServiceInstance
object
UserProvidedServiceInstance
object
ServicePlanVisibility
object
2 properties1 required
ServiceRouteBinding
object
Sidecar
object
SpaceQuota
object
Space
object
Stack
object
IndexLink
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. Can include a meta objec…
Errors
object
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 ti…
1 property
ServiceOffering
object
ServiceInstanceLastOperation
object
The last operation object for service instances
5 properties
BuildUpdate
object
7 properties
ResourceMatch
object
1 property
Revision
object
An App Revision is an immutable snapshot of an app at a particular point in time. Revisions are identified by a sequential version number. The "current" revisi…
RevisionList
object
2 properties
Role
object
Roles represent a set of permissions that can be granted to users. Roles are represented as a JSON object. A role consists of several required role fields and…
4 properties
SecurityGroupList
object
2 properties
SecurityGroupCreate
object
4 properties1 required
SecurityGroupUpdate
object
4 properties
ServiceBrokerList
object
2 properties
ServiceCredentialBindingLastOperation
object
The last operation object for service credential bindings
5 properties
ServiceCredentialBindingList
object
3 properties
ServiceInstanceList
object
2 properties
ServiceOfferingList
object
2 properties
ServicePlan
object
ServicePlanList
object
3 properties
ServiceRouteBindingList
object
3 properties
ServiceRouteBindingCreate
object
3 properties1 required
ServiceUsageEvent
object
ServiceUsageEventList
object
2 properties
SidecarList
object
2 properties
SpaceList
object
3 properties
SpaceFeature
object
3 properties
UserList
object
2 properties
SpaceQuotaList
object
2 properties
StackList
object
2 properties
Task
object
A task is a one-off process that can be run in the Cloud Foundry environment.
TaskList
object
2 properties
HealthCheck
object
Health check configuration for a process
2 properties
RouteList
object
A list of routes
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Cloud Foundry Cloud Controller API v3, 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.
