Images: Edit

Description

Modify the attributes of an Image. Currently only the name of the Image can be changed.

HTTP Request

PATCH /api/v1beta0/global/images/imageId/

Parameters

Name Required Description Location
imageId
string
Yes

The ID of a Image object.

path

Request body

The updated definition.

The body must be a valid Image object. Example value:

{
  "deprecated": true, 
  "name": "string"
}

Successful Response (Status 200)

The JSON representation of a Image object.

The API replies with a ImageDetailsResponse object. Example response body:

{
  "data": {
    "added": "2013-01-01T12:34:56.789Z", 
    "architecture": "i386", 
    "cloudFeatures": {
      "type": "ImageCloudFeatures"
    }, 
    "cloudImageId": "string", 
    "cloudInitInstalled": true, 
    "cloudLocation": "string", 
    "cloudPlatform": "ec2", 
    "deprecated": true, 
    "id": "string", 
    "lastUsed": "2013-01-01T12:34:56.789Z", 
    "name": "string", 
    "os": {
      "id": "string"
    }, 
    "scalrAgentInstalled": true, 
    "scope": "scalr", 
    "size": 1, 
    "source": "Manual", 
    "status": "active", 
    "statusError": "string", 
    "type": "string"
  }, 
  "errors": [
    {
      "code": "string", 
      "message": "string"
    }
  ], 
  "meta": {
    "sample": "string"
  }, 
  "warnings": [
    {
      "code": "string", 
      "message": "string"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

An ApiErrorResponse object
401

The request was not authenticated.

An ApiErrorResponse object
403

Insufficient permissions.

An ApiErrorResponse object
404

Resource not found.

An ApiErrorResponse object
409

Conflict with current state.

An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

An ApiErrorResponse object
500

A server-side error occurred.

An ApiErrorResponse object
501

This feature is not implemented in Scalr.

An ApiErrorResponse object
503

The service is currently unavailable.

An ApiErrorResponse object

Try it out!

Parameter Value Description
imageId

The ID of a Image object.

body

The updated definition.