Cloud Foundry V3 API

Name: Cloud Foundry V3 API
Brand: Cloud Foundry V3 API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureContainer Orchestrationoauth2238 EndpointsREST

For Agents

Manage Cloud Foundry applications, deployments, droplets, services, and organisations through the V3 cloud controller API using OAuth2 (UAA).

Install Jentic One Beta

Connect the Cloud Foundry V3 API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cloud Foundry V3 API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Cloud Foundry V3 API.

Push and start applications via /v3/apps and /v3/apps/{guid}/actions/start

Trigger zero-downtime deployments to swap droplets without restart

Run one-off tasks against an app for migrations or scheduled jobs

GET STARTED

Start building with Cloud Foundry V3 API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Cloud Foundry V3 API, keeping it validated and agent-ready. Cloud Foundry V3 is the cloud controller API for the open-source platform-as-a-service used by SAP BTP, IBM, and other distributions. It introduces support for one-off tasks, multi-process applications via Procfiles, direct access to packages and droplets, and zero-downtime deployments that change source code without stopping the app. The spec covers 238 endpoints across apps, builds, deployments, droplets, organisations, spaces, service instances, and audit events.

Use Cases

Patterns agents use Cloud Foundry V3 API for, with concrete tasks.

★ Continuous Deployment to Cloud Foundry

Drive zero-downtime application deployments from a CI pipeline. Upload a package, build a droplet, and POST a deployment to swap the running droplet on /v3/apps/{guid}/relationships/current_droplet. The deployment endpoint orchestrates rolling instance replacement so user traffic stays on the old droplet until the new one is healthy.

POST a package to /v3/apps/{guid}/packages, create a build, then PATCH /v3/apps/{guid}/relationships/current_droplet with the new droplet GUID.

One-Off Task Execution

Run database migrations, data backfills, or scheduled jobs as one-off tasks attached to an application. Tasks share the app's droplet and environment, so the same code that serves traffic also executes the task. Useful for replacing standalone job runners with platform-native invocations.

POST /v3/apps/{guid}/tasks with command='rake db:migrate' and poll the task GUID until state=SUCCEEDED.

Multi-Tenant Organisation Audit

Pull governance data across organisations and spaces for security and compliance reviews. Combine /v3/organizations, /v3/spaces, /v3/users, and /v3/audit_events to answer who did what, when, and against which app or service. Useful for SOC2 evidence collection on Cloud Foundry estates.

GET /v3/audit_events with created_ats[gte]=24h_ago and group results by organization_guid for the compliance report.

AI Agent Cloud Foundry Operations

Let a Jentic-powered SRE agent operate a Cloud Foundry estate. The agent searches Jentic for 'restart a Cloud Foundry app' or 'list apps in a space', loads the matching V3 operation, and executes it. UAA OAuth2 credentials stay in the Jentic vault.

Search Jentic for 'start a Cloud Foundry app', load the startApp operation, and execute POST /v3/apps/{guid}/actions/start.

Key Endpoints

238 endpoints — jentic publishes the only available openapi specification for cloud foundry v3 api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/v3/apps

List applications

GET

/v3/apps/{guid}

Get a single application

POST

/v3/apps/{guid}/actions/start

Start an application

GET

/v3/apps/{guid}/env

Get application environment

PATCH

/v3/apps/{guid}/relationships/current_droplet

Swap the running droplet

GET

/v3/apps/{guid}/droplets/current

Get the current droplet for an app

GET

/v3/apps/{guid}/permissions

Get permissions for an app

GET

/v3/apps/{guid}/ssh_enabled

Check whether SSH is enabled

GET

/v3/apps

List applications

GET

/v3/apps/{guid}

Get a single application

POST

/v3/apps/{guid}/actions/start

Start an application

GET

/v3/apps/{guid}/env

Get application environment

PATCH

/v3/apps/{guid}/relationships/current_droplet

Swap the running droplet

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Cloud Foundry UAA OAuth2 tokens are stored encrypted in the Jentic vault. Agents receive scoped access tokens — the raw UAA token never enters the agent's context, which is critical because UAA tokens grant cross-org access on shared foundations.

Intent-based discovery

Agents search Jentic by intent (for example 'start a Cloud Foundry app' or 'run a CF task') and Jentic returns the matching V3 operation with its input schema. With 238 endpoints, intent-based discovery is the difference between a working agent and one that browses docs.

Time to first call

Direct Cloud Foundry V3 integration: 1-2 weeks across UAA token handling, paginated list traversal, and the package/build/droplet/deployment lifecycle. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Cloud Foundry V3 API through Jentic.

Why is there no official OpenAPI spec for Cloud Foundry V3 API?

The Cloud Foundry community publishes reference docs but not a maintained OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cloud Foundry V3 API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Cloud Foundry V3 API use?

The API uses OAuth2 against UAA (User Account and Authentication), the Cloud Foundry identity service. Obtain a token from your foundation's UAA endpoint and pass it as Authorization: Bearer <token>. Through Jentic, UAA tokens are stored encrypted in the vault.

Can I do zero-downtime deployments through the V3 API?

Yes. PATCH /v3/apps/{guid}/relationships/current_droplet starts a rolling deployment that replaces instances in batches, keeping the old droplet serving traffic until the new one is healthy. The /v3/deployments resource exposes the in-flight state and lets you cancel.

How do I run a one-off task on Cloud Foundry through Jentic?

Run jentic search 'run a one-off task on Cloud Foundry', load the createTask operation, and execute POST /v3/apps/{guid}/tasks with the command and disk and memory limits. Jentic handles the UAA bearer token from the stored credential.

Does the API expose audit events?

Yes. GET /v3/audit_events returns platform-wide audit records, filterable by created_ats, target_guids, and types. This is the canonical source for compliance reporting on a Cloud Foundry estate.

How do I list applications in a specific space?

GET /v3/apps with the space_guids query parameter set to the target space GUID. The response is paginated; follow the next link until no more pages remain. The same pattern works for filtering by organization_guids.