# Cloud Foundry Cloud Controller API v3

**Canonical:** https://apis.io/apis/cloud-foundry/capi-v3/  
**Provider:** Cloud Foundry — https://apis.io/providers/cloud-foundry/  
**Base URL:** https://api.{system-domain}  
**Documentation:** https://v3-apidocs.cloudfoundry.org/

Cloud Foundry Cloud Controller API v3 is one of 14 APIs that [Cloud Foundry](https://apis.io/providers/cloud-foundry/) publishes on the [APIs.io](https://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.

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.<system-domain>.

## Operations (60 of 248)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | Global API Root |
| GET | `/v3` | Get V3 API root |
| POST | `/v3/admin/actions/clear_buildpack_cache` | Clear the buildpack cache |
| GET | `/v3/apps` | List apps |
| POST | `/v3/apps` | Create an app |
| GET | `/v3/apps/{guid}` | Get an app |
| PATCH | `/v3/apps/{guid}` | Update an app |
| DELETE | `/v3/apps/{guid}` | Delete an app |
| POST | `/v3/apps/{guid}/actions/start` | Start an app |
| POST | `/v3/apps/{guid}/actions/stop` | Stop an app |
| POST | `/v3/apps/{guid}/actions/restart` | Restart an app |
| GET | `/v3/apps/{guid}/droplets` | List droplets for an app |
| GET | `/v3/apps/{guid}/droplets/current` | Get current droplet |
| GET | `/v3/apps/{guid}/relationships/current_droplet` | Get current droplet association for an app |
| PATCH | `/v3/apps/{guid}/relationships/current_droplet` | Set current droplet |
| GET | `/v3/app_usage_events` | List app usage events |
| GET | `/v3/app_usage_events/{guid}` | Get an app usage event |
| POST | `/v3/app_usage_events/actions/destructively_purge_all_and_reseed` | Purge and seed app usage events |
| GET | `/v3/audit_events` | List audit events |
| GET | `/v3/audit_events/{guid}` | Get an audit event |
| GET | `/v3/builds` | List builds |
| POST | `/v3/builds` | Create a build |
| GET | `/v3/builds/{guid}` | Get a build |
| PATCH | `/v3/builds/{guid}` | Update a build |
| GET | `/v3/buildpacks` | List buildpacks |
| POST | `/v3/buildpacks` | Create a buildpack |
| GET | `/v3/buildpacks/{guid}` | Get a buildpack |
| PATCH | `/v3/buildpacks/{guid}` | Update a buildpack |
| DELETE | `/v3/buildpacks/{guid}` | Delete a buildpack |
| POST | `/v3/buildpacks/{guid}/upload` | Upload buildpack bits |
| GET | `/v3/deployments` | List deployments |
| POST | `/v3/deployments` | Create a deployment |
| GET | `/v3/deployments/{guid}` | Get a deployment |
| PATCH | `/v3/deployments/{guid}` | Update a deployment |
| POST | `/v3/deployments/{guid}/actions/cancel` | Cancel a deployment |
| POST | `/v3/deployments/{guid}/actions/continue` | Continue a deployment |
| GET | `/v3/domains` | List domains |
| POST | `/v3/domains` | Create a domain |
| GET | `/v3/domains/{guid}` | Get a domain |
| PATCH | `/v3/domains/{guid}` | Update a domain |
| DELETE | `/v3/domains/{guid}` | Delete a domain |
| POST | `/v3/domains/{guid}/relationships/shared_organizations` | Share a domain |
| DELETE | `/v3/domains/{guid}/relationships/shared_organizations/{org_guid}` | Unshare a domain |
| GET | `/v3/droplets` | List droplets |
| POST | `/v3/droplets` | Create a droplet |
| GET | `/v3/droplets/{guid}` | Get a droplet |
| PATCH | `/v3/droplets/{guid}` | Update a droplet |
| DELETE | `/v3/droplets/{guid}` | Delete a droplet |
| GET | `/v3/droplets/{guid}/download` | Download droplet bits |
| POST | `/v3/droplets/{guid}/upload` | Upload droplet bits |
| GET | `/v3/environment_variable_groups/{name}` | Get an environment variable group |
| PATCH | `/v3/environment_variable_groups/{name}` | Update environment variable group |
| GET | `/v3/feature_flags` | List feature flags |
| GET | `/v3/feature_flags/{name}` | Get a feature flag |
| PATCH | `/v3/feature_flags/{name}` | Update a feature flag |
| GET | `/v3/info` | Get platform info |
| GET | `/v3/info/usage_summary` | Get platform usage summary |
| GET | `/v3/isolation_segments` | List isolation segments |
| POST | `/v3/isolation_segments` | Create an isolation segment |
| GET | `/v3/isolation_segments/{guid}` | Get an isolation segment |

…and 188 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloud-foundry/refs/heads/main/openapi/cloud-foundry-capi-v3-openapi.yaml
- **APIReference** — https://v3-apidocs.cloudfoundry.org/
- **Documentation** — https://docs.cloudfoundry.org/
- **Source Code** — https://github.com/cloudfoundry/cloud_controller_ng
- **Specification** — https://github.com/cloudfoundry/cf-openapi
- **Reference** — https://cloudfoundry.github.io/cf-openapi/
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/cloud-foundry/refs/heads/main/apis.yml

## Other Cloud Foundry APIs (12)

- [Cloud Foundry UAA](https://apis.io/apis/cloud-foundry/uaa/)
- [Cloud Foundry Loggregator](https://apis.io/apis/cloud-foundry/loggregator/)
- [Open Service Broker API](https://apis.io/apis/cloud-foundry/open-service-broker-api/)
- [BOSH Director API](https://apis.io/apis/cloud-foundry/bosh/)
- [Cloud Foundry Apps API](https://apis.io/apis/cloud-foundry/cloud-foundry-apps-api/)
- [Cloud Foundry Builds API](https://apis.io/apis/cloud-foundry/cloud-foundry-builds-api/)
- [Cloud Foundry Cloud Foundry Cloud Controller API V3 API](https://apis.io/apis/cloud-foundry/cloud-foundry-cloud-foundry-cloud-controller-api-v3-api/)
- [Cloud Foundry Deployments API](https://apis.io/apis/cloud-foundry/cloud-foundry-deployments-api/)
- [Cloud Foundry Jobs API](https://apis.io/apis/cloud-foundry/cloud-foundry-jobs-api/)
- [Cloud Foundry Organizations API](https://apis.io/apis/cloud-foundry/cloud-foundry-organizations-api/)
- [Cloud Foundry Service Instances API](https://apis.io/apis/cloud-foundry/cloud-foundry-service-instances-api/)
- [Cloud Foundry Spaces API](https://apis.io/apis/cloud-foundry/cloud-foundry-spaces-api/)

## Tags

Cloud Foundry Cloud Controller API V3, Application, Deployment, Organization, Spaces, Service Instances

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cloud-foundry/capi-v3/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cloud-foundry/.