POST /v2/images
To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB after being decompressed.
Servers
- https://api.digitalocean.com
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:
|
region |
String | Yes |
The slug identifier for the region where the resource will initially be available. Possible values:
|
name |
String | Yes |
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. |
url |
String | Yes |
A URL from which the custom Linux virtual machine image may be retrieved. The image it points to must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB after being decompressed. |
tags[] |
Array | No |
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. |
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.