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

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 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.

Possible values:

  • "Ubuntu"
  • "Rocky Linux"
  • "FreeBSD"
  • "Fedora"
  • "CentOS"
  • "Arch Linux"
  • "Debian"
  • "CoreOS"
  • "Fedora Atomic"
  • "RancherOS"
  • "openSUSE"
  • "Unknown"
  • "Gentoo"
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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.