Update Droplet
Update a droplet
Update a droplet.
Request
URI
PATCH
https://api.example.local/v3/droplets/{guid}
COPY
Path Parameters
string
guid
Required
The unique identifier for the resource
Request Body
Droplet object that needs to be updated
Show optional properties
{
"image": "string"
}{
"metadata": {
"labels": {
"labels": "string"
},
"annotations": {
"annotations": "string"
}
},
"image": "string"
}
metadata
Optional
Metadata is a JSON object that contains information about a resource. It includes the GUID of the resource, the time the resource was created, the time the resource was last updated, and links to the resource. Metadata is included in the response body of a request to retrieve a resource.
string
image
Required
Image reference where the built complete image was stored
Responses
200
Successfully retrieved droplet
Returns
DropletGetResponse
of type(s)
application/json
{
"guid": "string",
"created_at": "string",
"updated_at": "string",
"state": "string",
"error": "string",
"lifecycle": {
"type": "string",
"data": {
"buildpacks": [
"string"
],
"stack": "string",
"credentials": {
"credentials": {
"username": "string",
"password": "string",
"token": "string"
}
}
}
},
"execution_metadata": "string",
"process_types": {},
"metadata": {
"labels": {
"labels": "string"
},
"annotations": {
"annotations": "string"
}
},
"links": {
"self": {
"href": "string",
"method": "string"
},
"package": {
"href": "string",
"method": "string"
},
"app": {
"href": "string",
"method": "string"
},
"assign_current_droplet": {
"href": "string",
"method": "string"
},
"download": {
"href": "string",
"method": "string"
},
"upload": {
"href": "string",
"method": "string"
}
},
"checksum": {
"type": "string",
"value": "string"
},
"buildpacks": [
{
"name": "string",
"detect_output": "string",
"version": "string",
"buildpack_name": "string"
}
],
"stack": "string",
"image": "string"
}
400
Bad Request
Returns
BadRequest
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
401
Unauthorized
Returns
Unauthorized
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
403
Forbidden
Returns
Forbidden
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
404
Not Found
Returns
NotFound
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
409
Conflict
Returns
Conflict
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
422
Unprocessable Entity
Returns
Error
of type(s)
application/json
{
"code": 0,
"detail": "string",
"title": "string"
}
integer
code
Optional
A numeric code for this error
string
detail
Optional
Detailed description of the error
string
title
Optional
Name of the error
500
Internal Server Error
Returns
500
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
503
Service Unavailable
Returns
ServiceUnavailable
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"image":"string"}'