Images / Actions: Replace

Description

Replace the current Image with a specified one for all Roles which use this Image.

HTTP Request

POST /api/v1beta0/global/images/imageId/actions/replace/

Parameters

Name Required Description Location
imageId
string
Yes

The identifier of the old Image object.

path

Request body

Replace image options.

Example value:

{
  "deprecateOldImage": true, 
  "newImage": {
    "id": "string"
  }, 
  "scope": [
    "scalr"
  ]
}

Fields description:

Name Required Description
newImage
ImageForeignKey
Yes

The identifier of a new Image object.

deprecateOldImage
boolean
No

If the value is true Scalr will mark source Image as deprecated.

scope
array
No

Make a replacement for all Roles from the selected scopes. If you choose to make a replacement including lower scope you must also choose higher scope values.

Successful Response (Status 200)

A list of RoleScopeIdentity objects.

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

{
  "data": [
    {
      "accountId": 1, 
      "envId": 1, 
      "id": 1, 
      "scope": "scalr"
    }
  ], 
  "errors": [
    {
      "code": "string", 
      "message": "string"
    }
  ], 
  "meta": {
    "sample": "string"
  }, 
  "pagination": {
    "first": "string", 
    "last": "string", 
    "next": "string", 
    "prev": "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 identifier of the old Image object.

body

Replace image options.