Skip to main content
PATCH
Update Image
Changes the image’s name and/or description. Nothing is built or restarted: the image keeps its ID and versions, and the applications created from it keep running. Send only the fields you want to change; at least one is required. Platform images (owner: "system") cannot be changed. Needs the images:write scope when called with an API key. In a workspace, you need permission to manage the workspace’s apps.
string
required
The image ID.
string
If the image belongs to a workspace, the workspace’s ID.
string
The new name: 1 to 50 characters, unique among the owner’s images. Sending the current name is not an error. A name already used by another of your images fails with VALIDATION_ERROR, with path set to name.
string | null
The new description, up to 128 characters (free text). null or an empty string removes it.

Response

object
The updated image.

Error Responses

string
The error code indicating the reason for the failure. Possible values:
  • API_KEY_SCOPE_DENIED: The API key does not have the required scope (403).
  • VALIDATION_ERROR: The body is empty, the name is not 1 to 50 characters, the name is already used by another of your images (path is name), the description is longer than 128 characters, or the name or description has control characters (400).
  • ACCESS_DENIED: The image is a platform image, which cannot be changed (403).
  • IMAGE_NOT_FOUND: The image does not exist or you cannot access it (404).
  • INTERNAL_SERVER_ERROR: Unexpected failure (500).