Cloud Foundry Jobs API
The Jobs API from Cloud Foundry — 1 operation(s) for jobs.
The Jobs API from Cloud Foundry — 1 operation(s) for jobs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cloud-foundry:cloud-foundry-jobs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Cloud Foundry V3 Jobs API
description: '# Welcome to the Experimental Cloud Foundry V3 API Docs!'
version: latest
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
contact:
name: Cloud Foundry
url: https://www.cloudfoundry.org/
servers:
- url: https://api.example.local
description: Cloud Foundry V3 API server
security:
- oauth:
- cloud_controller.read
- cloud_controller.write
tags:
- name: Jobs
description: Jobs are created by the platform when performing certain asynchronous actions.
paths:
/v3/jobs/{guid}:
get:
summary: Get a job
description: Retrieve a specific job.
operationId: getJob
tags:
- Jobs
parameters:
- $ref: '#/components/parameters/Guid'
responses:
'200':
description: Successfully retrieved job
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
examples:
default:
summary: default
value:
guid: 123e4567-e89b-12d3-a456-426614174000
created_at: '2016-10-19T20:25:04Z'
updated_at: '2016-11-08T16:41:26Z'
operation: app.delete
state: FAILED
links:
self:
href: https://api.example.org/v3/jobs/b19ae525-cbd3-4155-b156-dc0c2a431b4c
app:
href: https://api.example.org/v3/apps/7b34f1cf-7e73-428a-bb5a-8a17a8058396
errors:
- code: 10008
title: CF-UnprocessableEntity
detail: something went wrong
warnings:
- detail: warning! warning!
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/BadGateway'
'503':
$ref: '#/components/responses/ServiceUnavailable'
components:
responses:
NotFound:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
ServiceUnavailable:
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
UnprocessableEntity:
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/html:
schema:
type: string
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
BadGateway:
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
schemas:
Warning:
type: object
properties:
detail:
type: string
description: Description of the warning
Error:
type: object
properties:
code:
type: integer
description: A numeric code for this error
detail:
type: string
description: Detailed description of the error
title:
type: string
description: Name of the error
BaseSchema:
type: object
properties:
guid:
type: string
format: uuid
description: The unique identifier for the resource
created_at:
type: string
format: date-time
description: The ISO8601 compatible date and time when resource was created
updated_at:
type: string
format: date-time
description: The ISO8601 compatible date and time when resource was last updated
description: 'A resource represents an individual object within the system, such as an app or a service. It is represented as a JSON object.
A resource consists of several required resource fields and other attributes specific to the resource.
See Resources and Experimental Resources for specific resources.
'
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
description: 'An error response will always return a list of error objects. Errors appear on the job resource for asynchronous operations.
Clients should use the code and title fields for programmatically handling specific errors. The message in the detail field is subject to change over time.
'
Job:
type: object
allOf:
- $ref: '#/components/schemas/BaseSchema'
- properties:
operation:
type: string
description: The type of operation the job is performing
state:
type: string
description: The current state of the job
enum:
- PROCESSING
- COMPLETE
- FAILED
- POLLING
errors:
type: array
description: Any errors encountered during job execution
items:
$ref: '#/components/schemas/Error'
warnings:
type: array
description: Any warnings encountered during job execution
items:
$ref: '#/components/schemas/Warning'
links:
type: object
additionalProperties: true
properties:
self:
$ref: '#/components/schemas/Link'
description: The URL to get this job
manifest:
$ref: '#/components/schemas/Link'
description: The URL to get the manifest for this job
service_brokers:
$ref: '#/components/schemas/Link'
description: The URL to get the service broker for this job
service_credential_binding:
$ref: '#/components/schemas/Link'
description: The URL to get the service credential binding for this job
service_instances:
$ref: '#/components/schemas/Link'
description: The URL to get the service instance for this job
service_route_bindings:
$ref: '#/components/schemas/Link'
description: The URL to get the service route binding for this job
description: Jobs are created by the platform when performing certain asynchronous actions. Asynchronous jobs are commonly used for long-running tasks such as uploading large files, staging applications, or deleting resources.
Link:
type: object
properties:
href:
type: string
description: The URL of the link
method:
type: string
description: An optional field containing the HTTP method to be used when following the URL
required:
- href
description: 'Each link is keyed by its type and will include a href for the URL and an optional method for links that cannot be followed using GET.
'
parameters:
Guid:
name: guid
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier for the resource
securitySchemes:
oauth:
type: oauth2
flows:
implicit:
authorizationUrl: https://uaa.cloudfoundry.local/api-oauth/dialog
scopes:
cloud_controller.admin: This scope provides read and write access to all resources
cloud_controller.admin_read_only: This scope provides read only access to all resources
cloud_controller.global_auditor: This scope provides read access to all resources
cloud_controller.read: Read access to the Cloud Controller
cloud_controller.write: Write access to the Cloud Controller
cloud_controller.update_build_state: This scope allows its bearer to update the state of a build; currently only used when updating builds
cloud_controller_service_permissions.read: This scope provides read only access for service instance permissions
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Bearer JWT token authentication