Home
Version 3
Apps API

Apps API

Delete a Particular App

DELETE /v2/apps/:guid

Request

Route

DELETE /v2/apps/4bd9b039-9cfe-4bdd-a9ba-da78af0fc24d

Body

Name Description Default Valid Values Example Values
name The name of the app.
  • my_super_app
memory The amount of memory each instance should have. In megabytes.
  • 1024
  • 512
instances The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.
  • 2
  • 6
  • 10
disk_quota The maximum amount of disk available to an instance of an app. In megabytes.
  • 1204
  • 2048
space_guid The guid of the associated space.
  • guid-b66a7015-1520-4df0-ad89-cf00e109a009
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-289622bd-2b71-4c4e-acc4-0c4fe7da48fd
state The current desired state of the app. One of STOPPED or STARTED. STOPPED
  • STOPPED
  • STARTED
detected_start_command The command detected by the buildpack during staging.
command The command to start an app after it is staged, maximum length: 4096 (e.g. 'rails s -p $PORT' or 'java com.org.Server $PORT').
buildpack Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
  • https://github.com/virtualstaticvoid/heroku-buildpack-r.git
  • an_example_installed_buildpack
health_check_type Type of health check to perform. port
  • port
  • none
health_check_timeout Timeout for health checking of an staged app when starting up
diego Use diego to stage and to run when available false
  • true
  • false
docker_image Name of the Docker image containing the app
  • cloudfoundry/helloworld
  • registry.example.com:5000/user/repository/tag
docker_credentials_json Docker credentials for pulling docker image. {}
  • #<RspecApiDocumentation::Views::HtmlExample:0x0000000b317a80>
environment_json Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
production Deprecated. true
  • true
  • false
console Open the console port for the app (at $CONSOLE_PORT). false
  • true
  • false
debug Open the debug port for the app (at $DEBUG_PORT). false
  • true
  • false
staging_failed_reason Reason for application staging failures
staging_failed_description Detailed description for the staging_failed_reason

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MyIsImVtYWlsIjoiZW1haWwtOTlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjYwMn0.qNA_U83RZbFqDvKd07jJSLMpY0Jcfh6sDxFzj_qJna8
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/4bd9b039-9cfe-4bdd-a9ba-da78af0fc24d" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MyIsImVtYWlsIjoiZW1haWwtOTlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjYwMn0.qNA_U83RZbFqDvKd07jJSLMpY0Jcfh6sDxFzj_qJna8" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 08d4e143-e9d2-464b-8929-d875e424741b
X-Content-Type-Options: nosniff

Audit Records Created By The Request

Audit Record: audit.app.delete-request

Attribute Name Value
id 24
guid d2a4b16c-5633-4d3c-ba40-bb7b6600732a
created_at 2015-08-31 21:50:02 UTC
updated_at
timestamp 2015-08-31 21:50:02 UTC
type audit.app.delete-request
actor uaa-id-153
actor_type user
actee 4bd9b039-9cfe-4bdd-a9ba-da78af0fc24d
actee_type app
metadata
{
  "request": {
    "recursive": false
  }
}
space_id
organization_guid 2f8978b4-8c26-4624-9c93-0f15e9d2efb7
space_guid 8cf563fb-422b-4734-9d53-f9fc13df5046
actor_name email-99@somedomain.com
actee_name name-625