Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Updating an App

PATCH /v3/apps/:guid

Request

Route

PATCH /v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0

Body

Name Description Default Valid Values Example Values
name Name of the App
environment_variables Environment variables to be used for the App when running
lifecycle Lifecycle to be used when updating the app. Note: lifecycle type cannot be changed. Buildpack can be set to null to allow the backend to auto-detect the appropriate buildpack. Stack can be updated, but cannot be null. Type and Data are required fields in lifecycle, but lifecycle itself is not required.
{
  "name": "new_name",
  "environment_variables": {
    "MY_ENV_VAR": "foobar",
    "FOOBAR": "MY_ENV_VAR"
  },
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "http://gitwheel.org/my-app",
      "stack": "redhat"
    }
  }
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQzNCIsImVtYWlsIjoiZW1haWwtMzAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTB9.qPO5kL4FuBZgh0f0TIfRDNGUxvTe8GsaXCvrSvI4XNs
Content-Type: application/json
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0" -d '{
  "name": "new_name",
  "environment_variables": {
    "MY_ENV_VAR": "foobar",
    "FOOBAR": "MY_ENV_VAR"
  },
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "http://gitwheel.org/my-app",
      "stack": "redhat"
    }
  }
}' -X PATCH \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQzNCIsImVtYWlsIjoiZW1haWwtMzAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTB9.qPO5kL4FuBZgh0f0TIfRDNGUxvTe8GsaXCvrSvI4XNs" \
	-H "Content-Type: application/json" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0",
  "name": "new_name",
  "desired_state": "STOPPED",
  "total_desired_instances": 0,
  "created_at": "2016-03-17T21:41:30Z",
  "updated_at": "2016-03-17T21:41:30Z",
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "http://gitwheel.org/my-app",
      "stack": "redhat"
    }
  },
  "environment_variables": {
    "MY_ENV_VAR": "foobar",
    "FOOBAR": "MY_ENV_VAR"
  },
  "links": {
    "self": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0"
    },
    "space": {
      "href": "/v2/spaces/80a9166a-4aec-4a83-b743-145b4fcd33cc"
    },
    "processes": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/processes"
    },
    "route_mappings": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/route_mappings"
    },
    "packages": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/packages"
    },
    "droplets": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/droplets"
    },
    "tasks": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/tasks"
    },
    "start": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/stop",
      "method": "PUT"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/guid-deb01706-9aeb-4fc2-a553-bbf77cdd8ee0/current_droplet",
      "method": "PUT"
    }
  }
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.034294
Content-Length: 1533