V2 EOL Readiness Checklist
As we announced in January, the Cloud.gov v2 API at https://api.fr.cloud.gov will be discontinued in June, and developers should ensure their deployment and app management code is using the v3 API. The v3 API has been the preferred API since 2021 and already accounts for 98% of API calls, so it’s likely you are already set for this change.
This guide provides a quick Readiness Checklist for this transition. Taking the steps in the checklist will address most uses of the v2 API.
Note: The code you run in Cloud.gov most likely does not need updating. Your applications at <appname>.app.cloud.gov will not be impacted. The API change may impact how you:
- deploy your apps in Cloud.gov
- manage or monitor your apps in Cloud.gov
Readiness Checklist
Going through this checklist will address most places where the v2 API may still be in use.
- Ensure you and your developers are using a version of the CF CLI, the Cloud Foundry command line interface (CLI), later than v7.7.1 or v8.7.1.
- Check your version by running
cf version. - If you need to upgrade, follow the V8 CLI Installation Guide.
- If approval processes will delay adopting a supported version, please notify Support
- Check your version by running
- Ensure your deployment code, such as your CD pipeline, is using a supported version of the CF CLI later than v7.7.1 or v8.7.1 (see above).
- Scan your application deployment code for the string ‘/v2’. If you find it, determine if it’s a call to the v2 API, e.g.
cf curl /v2/.....- As needed, update your code to use the
/v3/equivalents, per the v3 upgrade guide.
- As needed, update your code to use the
- If you use Terraform, ensure you’re using v3 CloudFoundry Terraform provider.
- The community-supported Terraform provider is not v3-compatible.
- The CloudFoundry Terraform maintainers have a migration guide for adopting the v3-compatible provider.
- If you use the cf-python-client, update to version v1.38.2 or higher.
- If you use the go-cfclient, ensure you’re using a version 3.0.0.alpha release.
Next steps
The Cloud.gov team will monitor use of the v2 API, and provide further guidance in the weeks ahead. As use declines, we should be able to identify specific programs using the v2 API and then notify them. If necessary, we may announce “brownouts” when we block access to the v2 API for short periods so teams can test their deployments and processes. Brownouts WILL NOT impact application availability.
As always, the Support Team is ready to assist you with your questions.
