Roles / Images / Actions: Replace
Description
Replace an Image in-place in a given Role. This allows to replace an Image without having to dis-associate it and then associate a new one, which may not be possible if a Farm Role is currently using this Image.
HTTP Request
POST /api/v1beta0/account/accountId/roles/roleId/images/imageId/actions/replace/
Parameters
Name | Required | Description | Location |
---|---|---|---|
accountId integer |
Yes | The ID of the Account scoping this request. |
path |
roleId integer |
Yes | The ID of a Role object. |
path |
imageId string |
Yes | The ID of a Image object. |
path |
Request body
The JSON representation of a RoleImage object.
The body must be a valid RoleImage object. Example value:
{
"image": {
"id": "string"
},
"role": {
"id": 1
}
}
Successful Response (Status 200)
The JSON representation of a RoleImage object.
The API replies with a RoleImageDetailsResponse object. Example response body:
{
"data": {
"image": {
"id": "string"
},
"role": {
"id": 1
}
},
"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 |