Update
Update an Image
gpu_droplets.images.update(intimage_id, ImageUpdateParams**kwargs) -> imageImageImageUpdateResponse
put/v2/images/{image_id}
To update an image, send a PUT
request to /v2/images/$IMAGE_ID
.
Set the name
attribute to the new value you would like to use.
For custom images, the description
and distribution
attributes may also be updated.
Parameters
image_idint
descriptionstr
optional
An optional free-form text field to describe an image.
distributionliteral
optional
Literal["Arch Linux", "CentOS", "CoreOS", 10 more]
The name of a custom image's distribution. Currently, the valid values are Arch Linux
, CentOS
, CoreOS
, Debian
, Fedora
, Fedora Atomic
, FreeBSD
, Gentoo
, openSUSE
, RancherOS
, Rocky Linux
, Ubuntu
, and Unknown
. Any other value will be accepted but ignored, and Unknown
will be used in its place.
namestr
optional
The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
Returns
ImageUpdateResponseclass
from do_gradientai import GradientAI
client = GradientAI()
image = client.gpu_droplets.images.update(
image_id=62137902,
)
print(image.image)
200 Example
{
"image": {
"created_at": "2020-05-04T22:23:02Z",
"description": " ",
"distribution": "Ubuntu",
"error_message": " ",
"min_disk_size": 20,
"name": "Nifty New Snapshot",
"public": true,
"regions": [
"nyc1",
"nyc2"
],
"size_gigabytes": 2.34,
"slug": "nifty1",
"status": "NEW",
"tags": [
"base-image",
"prod"
],
"type": "snapshot"
}
}