Updating an App
PATCH /v3/apps/:guid
Request
Route
PATCH /v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53
Parameters
Name |
Description |
Valid Values |
Example Values |
name
|
Name of the App
|
|
|
environment_variables
|
Environment variables to be used for the App when running
|
|
|
Body
Name |
Description |
Default |
Valid Values |
Example Values |
{
"name": "new_name",
"environment_variables": {
"MY_ENV_VAR": "foobar",
"FOOBAR": "MY_ENV_VAR"
}
}
Headers
cURL
curl "https://api.[your-domain.com]/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53" -d '{
"name": "new_name",
"environment_variables": {
"MY_ENV_VAR": "foobar",
"FOOBAR": "MY_ENV_VAR"
}
}' -X PATCH \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1OCIsImVtYWlsIjoiZW1haWwtMjc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NjV9.yYtDsrxU4PiqdL1zh_nptt51mfJCH5TqoOSOynhk4XU" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"guid": "guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53",
"name": "new_name",
"desired_state": "STOPPED",
"total_desired_instances": 0,
"created_at": "2015-06-16T23:41:05Z",
"updated_at": "2015-06-16T23:41:05Z",
"environment_variables": {
"MY_ENV_VAR": "foobar",
"FOOBAR": "MY_ENV_VAR"
},
"_links": {
"self": {
"href": "/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53"
},
"processes": {
"href": "/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53/processes"
},
"packages": {
"href": "/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53/packages"
},
"space": {
"href": "/v2/spaces/9657cff7-bc8e-41c4-a261-fe003930988a"
},
"start": {
"href": "/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53/start",
"method": "PUT"
},
"stop": {
"href": "/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53/stop",
"method": "PUT"
},
"assign_current_droplet": {
"href": "/v3/apps/guid-4ec7d5c1-3774-4d8d-9f9c-f7239c8b6f53/current_droplet",
"method": "PUT"
}
}
}
Headers