Skip to content

Latest commit

 

History

History
86 lines (64 loc) · 3.03 KB

restore-server.md

File metadata and controls

86 lines (64 loc) · 3.03 KB
Raw

{{{ "title": "RestoreServer", "date": "2-7-2013", "author": "Troy Schneringer", "attachments": [] }}}

Restores an archived server.

V2 API Available

There is an equivalent V2 API that should be used instead. Please use the Server Actions | Restore Server API.

URL

REST: https://api.ctl.io/REST/Server/RestoreServer/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=RestoreServer

Request

Attributes

Name Type Description Req.
AccountAlias String The alias of the account that owns the server. If not provided it will assume the account to which the API user is mapped. Providing this value gives you the ability to access servers in your sub accounts. No
Name String The name of the archived Server. Yes
HardwareGroupUUID String The unique identifier of the hardware group to the restore the server to. Yes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Name": "SERVER01",
  "HardwareGroupUUID": "8a03fbae8ddfe311b05f00505682315a"
}

XML

<RestoreServerRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Name>SERVER01</Name>
    <HardwareGroupUUID>8a03fbae8ddfe311b05f00505682315a</HardwareGroupUUID>
</RestoreServerRequest>

Response

Attributes

Name Type Description
Success Boolean True if the request was successful, otherwise False.
Message String A description of the result. The contents of this field does not contain any actionable information, it is purely intended to provide a human readable description of the result.
StatusCode Int This value will help to identify any errors which were encountered while processing the request. The value of '0' indicates success, all non-zero StatusCodes indicate an error state.
RequestID Int The ID of the Queued request.Status of the request can be obtained by calling the Get Deployment Status method.

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Status Code Description
0 Request was successfully processed
2 Unknown Error. An application error occurred processing your request, contact support to resolve the issue.
3 Invalid Request Format. This value indicates that the XML or JSON requests do not match the expected format.
5 Resource Not Found. A Server with the specified Name cannot be found. - OR - A Group with the specified ID cannot be found.
6 Invalid Operation. Server must be in an archived state.
100 Authentication Failed. You must logon to the API prior to calling this method.
1410 Name required. The name parameter must be specified.