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.
Servers
- https://api.digitalocean.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
image_id |
Integer | Yes |
A unique number that can be used to identify and reference a specific image. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
distribution |
String | No |
The name of a custom image's distribution. Currently, the valid values are Possible values:
|
name |
String | No |
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. |
description |
String | No |
An optional free-form text field to describe an image. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.