Servers: Edit
Description
Modify the Instance type of the Server. Server status before this action depends on CloudPlatform: - For EC2 and OpenStack instance type change requires server status "suspended". - For VMware instance type change requires server status "running" or "suspended".
HTTP Request
PATCH /api/v1beta0/user/envId/servers/serverId/Parameters
| Name | Required | Description | Location |
|---|---|---|---|
| envId integer |
Yes | The ID of the Environment scoping this request. |
path |
| serverId string |
Yes | The ID of a Server object. |
path |
Request body
The JSON representation of a Server object.
The body must be a valid Server object. Example value:
{
"instanceType": {
"id": "string"
}
}Successful Response (Status 202)
The JSON representation of a ServerSummary object.
The API replies with a ServerSummaryDetailsResponse object. Example response body:
{
"data": {
"alerts": [
{
"message": "string",
"occurred": "2013-01-01T12:34:56.789Z",
"status": "failed",
"type": "SCALARIZR_CONNECT"
}
],
"cloudLocation": "string",
"cloudPlatform": "ec2",
"cloudServerId": "string",
"farm": {
"id": 1
},
"farmRole": {
"id": 1
},
"hostname": "string",
"id": "string",
"index": 1,
"instanceType": {
"id": "string"
},
"launchReason": "string",
"launched": "2013-01-01T12:34:56.789Z",
"launchedBy": {
"email": "string",
"id": 1
},
"operations": [
{
"name": "resizing"
}
],
"privateIp": [
"string"
],
"publicIp": [
"string"
],
"scalrAgent": {
"deployCommand": "string",
"initializationStatus": {
"message": "string",
"status": "insufficient-data"
},
"reachabilityStatus": {
"message": "string",
"status": "insufficient-data"
},
"version": "string"
},
"status": "temporary",
"suspended": "2013-01-01T12:34:56.789Z"
},
"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 |