Cloud Foundry API

🔗 Overview

V2 API Documentation Source Code

🔗 App Usage Events

• List all App Usage Events
• Purge and reseed App Usage Events
• Retrieve a Particular App Usage Event

🔗 Apps - Deprecated

• Associate Route with the App
• Copy the app bits for an App
• Creating a Docker App
• Creating an App
• Delete a Particular App
• Downloads the bits for an App
• Downloads the staged droplet for an App
• Get App summary
• Get detailed stats for a STARTED App
• Get the env for an App
• Get the instance information for a STARTED App
• List all Apps
• List all Routes for the App
• List all Service Bindings for the App
• Remove Route from the App
• Remove Service Binding from the App (deprecated)
• Restage an App
• Retrieve a Particular App
• Terminate the running App Instance at the given index
• Updating an App
• Uploads the bits for an App
• Uploads the droplet for an App
• Retrieving permissions on an App

🔗 Blobstores

• Delete all blobs in the Buildpack cache blobstore

🔗 Buildpacks

• Change the position of a Buildpack
• Creates an admin Buildpack
• Delete a Particular Buildpack
• Enable or disable a Buildpack
• List all Buildpacks
• Lock or unlock a Buildpack
• Assign a Buildpack to a Stack
• Retrieve a Particular Buildpack
• Upload the bits for an admin Buildpack

🔗 Domains - Deprecated

• Create a Domain owned by the given Organization (deprecated)
• Create a Shared Domain (deprecated)
• Delete a Particular Domain (deprecated)
• List all Domains (deprecated)
• List all Spaces for the Domain (deprecated)
• Retrieve a Particular Domain (deprecated)

🔗 Environment Variable Groups

• Getting the contents of the running environment variable group
• Getting the contents of the staging environment variable group
• Updating the contents of the running environment variable group
• Updating the contents of the staging environment variable group

🔗 Events

• List all Events
• Retrieve a Particular Event

🔗 Feature Flags - Deprecated

• Get all feature flags
• Get the App Bits Upload feature flag
• Get the App Scaling feature flag
• Get the Diego Docker feature flag
• Get the Environment Variable Visibility feature flag
• Get the Hide Marketplace From Unauthenticated Users feature flag
• Get the Private Domain Creation feature flag
• Get the Route Creation feature flag
• Get the Service Instance Creation feature flag
• Get the Service Instance Sharing feature flag
• Get the Set User Roles feature flag
• Get the Space Developer Environment Variable Visibility feature flag (experimental)
• Get the Space Scoped Private Broker Creation feature flag (experimental)
• Get the Task Creation feature flag
• Get the Unset User Roles feature flag
• Get the User Org Creation feature flag
• Set a feature flag

🔗 Files (removed)

• Retrieve File

🔗 Info

• Get Info

🔗 Jobs

• Retrieve Job that is queued
• Retrieve Job that was successful
• Retrieve Job with known failure
• Retrieve Job with unknown failure

🔗 Organization Quota Definitions

• Creating a Organization Quota Definition
• Delete a Particular Organization Quota Definition
• List all Organization Quota Definitions
• Retrieve a Particular Organization Quota Definition
• Updating a Organization Quota Definition

🔗 Organizations

• Associate Auditor with the Organization
• Associate Auditor with the Organization by Username
• Associate Billing Manager with the Organization
• Associate Billing Manager with the Organization by Username
• Associate Manager with the Organization
• Associate Manager with the Organization by Username
• Associate Private Domain with the Organization
• Associate User with the Organization
• Associate User with the Organization by Username
• Creating an Organization
• Delete a Particular Organization
• Get Organization summary
• List all Auditors for the Organization
• List all Billing Managers for the Organization
• List all Domains for the Organization (deprecated)
• List all Managers for the Organization
• List all Organizations
• List all Private Domains for the Organization
• List all Services for the Organization
• List all Space Quota Definitions for the Organization
• List all Spaces for the Organization
• List all Users for the Organization
• Remove Auditor from the Organization
• Remove Auditor with the Organization by Username (DEPRECATED)
• Remove Auditor from the Organization by Username
• Remove Billing Manager from the Organization
• Remove Billing Manager with the Organization by Username (DEPRECATED)
• Remove Billing Manager from the Organization by Username
• Remove Manager from the Organization
• Remove Manager with the Organization by Username (DEPRECATED)
• Remove Manager from the Organization by Username
• Remove Private Domain from the Organization
• Remove User from the Organization
• Remove User with the Organization by Username (DEPRECATED)
• Remove User from the Organization by Username
• Retrieve a Particular Organization
• Retrieving organization instance usage
• Retrieving organization memory usage
• Retrieving the roles of all Users in the Organization
• Update an Organization

🔗 Private Domains

• Create a Private Domain owned by the given Organization
• Delete a Particular Private Domain
• Filtering Private Domains by name
• List all Private Domains
• List all Shared Organizations for the Private Domain
• Retrieve a Particular Private Domain

🔗 Resource Match

• List all matching resources

🔗 Routes

• Associate App with the Route
• Check a HTTP Route exists
• Check a Route exists
• Creating a Route
• Delete a Particular Route
• List all Apps for the Route
• List all Route Mappings for the Route
• List all Routes
• Remove App from the Route
• Retrieve a Particular Route
• Update a Route

🔗 Route Mappings

• Delete a Particular Route Mapping
• List all Route Mappings
• Mapping an App and a Route
• Retrieve a Particular Route Mapping

🔗 Security Group Running Defaults

• Removing a Security Group as a default for running Apps
• Return the Security Groups used for running Apps
• Set a Security Group as a default for running Apps

🔗 Security Group Staging Defaults

• Removing a Security Group as a default for staging
• Return the Security Groups used for staging
• Set a Security Group as a default for staging

🔗 Security Groups

• Associate Space with the Security Group
• Associate Space with the Security Group for Staging
• Creating a Security Group
• Delete a Particular Security Group
• List all Security Groups
• List all Spaces for the Security Group
• List all Staging Spaces for the Security Group
• Remove Space from the Security Group
• Remove Space from the Security Group for Staging
• Retrieve a Particular Security Group
• Updating a Security Group

🔗 Service Bindings

• Create a Service Binding
• Delete a Particular Service Binding
• List all Service Bindings
• Retrieve a Particular Service Binding
• Retrieve a Particular Service Binding's Parameters (Experimental)

🔗 Service Brokers

• Create a Service Broker
• Delete a Particular Service Broker
• List all Service Brokers
• Retrieve a Particular Service Broker
• Update a Service Broker

🔗 Service Instances

• Binding a Service Instance to a Route
• Creating a Service Instance
• Delete a Service Instance
• List all Routes for the Service Instance
• List all Service Bindings for the Service Instance
• List all Service Instances
• List all Service Keys for the Service Instance
• Retrieve a Particular Service Instance
• Retrieve a Particular Service Instance's Parameters (Experimental)
• Retrieve a Particular Route Binding's Parameters (Experimental)
• Retrieving permissions on a Service Instance
• Retrieve Information Regarding Where a Service Instance is Shared From
• Retrieve Information Regarding Where a Service Instance is Shared To
• Unbinding a service instance from a route
• Update a Service Instance

🔗 Service Keys

• Create a Service Key
• Delete a Particular Service Key
• List all Service Keys
• Retrieve a Particular Service Key

🔗 Service Plan Visibilities

• Creating a Service Plan Visibility
• Delete a Particular Service Plan Visibilities
• List all Service Plan Visibilities
• Retrieve a Particular Service Plan Visibility
• Updating a Service Plan Visibility

🔗 Service Plans

• Delete a Particular Service Plans
• List all Service Instances for the Service Plan
• List all Service Plans
• Retrieve a Particular Service Plan
• Updating a Service Plan

🔗 Service Usage Events

• List Service Usage Events
• Purge and reseed Service Usage Events
• Retrieve a Particular Service Usage Event

🔗 Services

• Delete a Particular Service
• List all Service Plans for the Service
• List all Services
• Retrieve a Particular Service

🔗 Shared Domains

• Create a Shared Domain
• Delete a Particular Shared Domain
• Filtering Shared Domains by name
• List all Shared Domains
• Retrieve a Particular Shared Domain

🔗 Space Quota Definitions

• Associate Space with the Space Quota Definition
• Creating a Space Quota Definition
• Delete a Particular Space Quota Definition
• List all Space Quota Definitions
• List all Spaces for the Space Quota Definition
• Remove Space from the Space Quota Definition
• Retrieve a Particular Space Quota Definition
• Updating a Space Quota Definition

🔗 Spaces

• Associate Auditor with the Space
• Associate Auditor with the Space by Username
• Associate Developer with the Space
• Associate Developer with the Space by Username
• Associate Manager with the Space
• Associate Manager with the Space by Username
• Associate Security Group with the Space
• Associate Security Group with the Space for staging
• Creating a Space
• Delete a Particular Space
• Delete Unmapped Routes
• Get Space summary
• List all Apps for the Space
• List all Auditors for the Space
• List all Developers for the Space
• List all Domains for the Space (deprecated)
• List all Events for the Space
• List all Managers for the Space
• List all Routes for the Space
• List all Security Groups for the Space
• List all Staging Security Groups for the Space
• List all Service Instances for the Space
• List all Services for the Space
• List all Spaces
• Remove Auditor from the Space
• Remove Auditor with the Space by Username (DEPRECATED)
• Remove Auditor from the Space by Username
• Remove Developer from the Space
• Remove Developer with the Space by Username (DEPRECATED)
• Remove Developer from the Space by Username
• Remove Manager from the Space
• Remove Manager with the Space by Username (DEPRECATED)
• Remove Manager from the Space by Username
• Remove Security Group from the Space
• Remove Security Group from the Space for staging
• Retrieve a Particular Space
• Retrieving the roles of all Users in the Space
• Update a Space

🔗 Stacks - Deprecated

• Create a Stack
• Delete a Particular Stack
• List all Stacks
• Retrieve a Particular Stack

🔗 User Provided Service Instances

• Associate Route with the User Provided Service Instance
• Creating a User Provided Service Instance
• Delete a Particular User Provided Service Instance
• List all Routes for the User Provided Service Instance
• List all Service Bindings for the User Provided Service Instance
• List all User Provided Service Instances
• Remove Route from the User Provided Service Instance
• Retrieve a Particular User Provided Service Instance
• Updating a User Provided Service Instance

🔗 Users

• Associate Audited Organization with the User
• Associate Audited Space with the User
• Associate Billing Managed Organization with the User
• Associate Managed Organization with the User
• Associate Managed Space with the User
• Associate Organization with the User
• Associate Space with the User
• Creating a User
• Delete a Particular User
• Get User summary
• List all Audited Organizations for the User
• List all Audited Spaces for the User
• List all Billing Managed Organizations for the User
• List all Managed Organizations for the User
• List all Managed Spaces for the User
• List all Organizations for the User
• List all Spaces for the User
• List all Users
• Remove Audited Organization from the User
• Remove Audited Space from the User
• Remove Billing Managed Organization from the User
• Remove Managed Organization from the User
• Remove Managed Space from the User
• Remove Organization from the User
• Remove Space from the User
• Retrieve a Particular User
• Updating a User