Skip to main content
undefined
undefined

Official websites use .gov
A .gov website belongs to an official government organization in the United States.

undefined

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

End-of-life for CloudFoundry API v2

Invalid DateTime

Cloud.gov end-of-life for v2 of Cloud Foundry API

When Cloud.gov app developers interact with our the platform, they
do so via the Cloud Foundry API at https://api.fr.cloud.gov. Currently
that API works for both version 2 (with /v2  paths) and version 3
(with /v3  paths).

The v2 API has been in deprecated status with the Cloud Foundry
Foundation since 2021, and in 2025 the Cloud Foundry development
teams will stop supporting v2. At Cloud.gov we will continue
to support v2 for through June 6, 2025, per our
deprecation policy.

What this means for our customers

This only impacts developers on the Cloud.gov Platform, not Cloud.gov Pages.
This should not impact any applications running on Cloud.gov, but it may
impact how you deploy and manage your applications.

Your team should check that all of the following have been updated to v3-compatible
versions, if applicable:

  • CF Client, cf-cli . You can check your version with cf version .

    • Versions v7.7.1 and v8.7.1 are the minimum supported versions.
    • In early 2025, unsupported clients will trigger an alert like this:
      🚨 [WARNING] Outdated CF CLI version - please upgrade: https://github.com/cloudfoundry/cli/releases/latest 🚨 
    • You may continue using unsupported clients until v2 is discontinued.
    • If you need to reinstall/upgrade your client, follow our documentation

  • cf-cli  plugins. Our Cloud.gov documentation references a number of useful plugins, their current v3 Plugin Status is detailed in the table below.

    • For “pending” plugins, periodically check the linked GitHub issues for status.
    • For plugins with no update pending, seek an alternative.

  • CF API client libraries such as cf-java-client, go-cfclient, or cf-python-client:

    • Review your deployment and management scripts for such libraries
    • Ensure you’ve updated to a v3-compatible library

  • Terraform:

  • Scripts that directly use cf curl :

    • Review the scripts and ensure you’re using paths that start with /v3/ 
    • The API has changed so review the v3 API docs

Plugin Status

Plugin v3 Compatible?
app-autoscaler-plugin Yes
cf-service-connect Pending
log-cache-cli plugin Pending
stack-auditor plugin Pending
report-usage plugin Pending
cf-route-lookup No, use cf routes  instead
top plugin No, this is an admin-only tool, no replacement expected
statistics plugin No, project appears abandoned

Deprecation timeline

  • January 2025: Cloud.gov will start publishing statistics on usage of v2  vs v3  endpoints to track progress to decommissioning.
    • v2 CF CLI clients will trigger an alert that they need updating.
  • February 2025: Cloud.gov will publish our v2 “brownout” schedule. Brownouts are when we intentionally disable the
    v2 endpoint for a published period of time so developers can test their development and release procedures.
    • We will schedule brownouts to accommodate customer releases, so please respond to any suggested brownout schedule.
  • March, April, May 2025: Cloud.gov will hold published v2 brownouts. These will increase in duration as we approach end-of-life.
  • June 7, 2025: Cloud.gov will permanently disable v2.

The Cloud.gov team may accelerate this schedule if v2 usage has ceased, or if maintaining v2 poses risks to platform operation.

Updates

Updates to this page, or links to additional documentation will be listed below: