# Cloud Foundry Sidecars API

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

Cloud Foundry Sidecars API is one of 49 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 Sidecars. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

Sidecars are used to run a process alongside an app.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/v3/sidecars/{guid}` | Get a sidecar |
| PATCH | `/v3/sidecars/{guid}` | Update a sidecar |
| DELETE | `/v3/sidecars/{guid}` | Delete a sidecar |
| GET | `/v3/apps/{guid}/sidecars` | List sidecars for app |
| POST | `/v3/apps/{guid}/sidecars` | Create a sidecar associated with an app |
| GET | `/v3/processes/{guid}/sidecars` | List sidecars for process |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cloud-foundry/refs/heads/main/openapi/cloud-foundry-sidecars-api-openapi.yml
- **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/
- **Documentation** — https://www.openservicebrokerapi.org/
- **Specification** — https://github.com/openservicebrokerapi/servicebroker
- **Documentation** — https://github.com/cloudfoundry/app-autoscaler/blob/main/docs/user_guide.md
- **Source Code** — https://github.com/cloudfoundry/app-autoscaler

## 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/)
- [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 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/)
- [Cloud Foundry Admin API](https://apis.io/apis/cloud-foundry/cloud-foundry-admin-api/)
- [Cloud Foundry App Usage Events API](https://apis.io/apis/cloud-foundry/cloud-foundry-app-usage-events-api/)

## Tags

Sidecars

---

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