Images: Delete
Description
Remove an Image from the Environment. By default this does not delete the underlying machine image from the Cloud it resides in.
HTTP Request
DELETE /api/v1beta0/user/envId/images/imageId/Parameters
| Name | Required | Description | Location |
|---|---|---|---|
| envId integer |
Yes | The ID of the Environment scoping this request. |
path |
| imageId string |
Yes | The ID of a Image object. |
path |
| deleteFromCloud boolean |
No | Attempt to also delete this Image from the Cloud. |
query |
Request body
Do not supply a body with this request.
Successful Response (Status 204)
Successful deletion.
No body is returned with this response.
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 |