| POST | /restore/{sessionId}/{imageName}/{datacenterLocation} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| imageName | path | string | No | |
| StartVM | body | bool | No | |
| UserId | body | Guid | No | |
| JobId | body | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| sessionId | form | string | No | |
| datacenterLocation | form | string | No | |
| orgName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | BackupResponse | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | TypeBackup | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| virtualsize | form | double | No | |
| originalbackupid | form | long | No | |
| modifydate | form | DateTime | No | |
| jobclass | form | string | No | |
| flags | form | long | No | |
| sourceuds | form | double | No | |
| status | form | string | No | |
| expiration | form | DateTime | No | |
| hostname | form | string | No | |
| appid | form | long | No | |
| label | form | string | No | |
| policyname | form | string | No | |
| consistencydate | form | DateTime | No | |
| id | form | long | No | |
| backupdate | form | DateTime | No | |
| mountedhost | form | long | No | |
| username | form | string | No | |
| backupname | form | string | No | |
| sltname | form | string | No | |
| sourceimage | form | string | No | |
| prepdate | form | DateTime | No | |
| slpname | form | string | No | |
| appname | form | string | No | |
| apptype | form | string | No | |
| datastore | form | string | No | |
| vmpath | form | string | No | |
| sla | form | TypeSLA | No | |
| systemstateOSType | form | string | No | |
| systemstateNIC | form | string | No | |
| logtruncated | form | string | No | |
| restorelock | form | string | No | |
| volumelabel | form | string | No | |
| nasstaging | form | string | No | |
| preserved | form | string | No | |
| dnsname | form | string | No | |
| nvolumes | form | string | No | |
| sourcecluster | form | string | No | |
| volumekey | form | string | No | |
| originatingcluster | form | string | No | |
| systemstateCPU | form | string | No | |
| mappedhost | form | string | No | |
| catalogstate | form | string | No | |
| uniquehostname | form | string | No | |
| restorableobject | form | string | No | |
| backuplock | form | string | No | |
| filename | form | string | No | |
| isbootvolume | form | string | No | |
| backuphost | form | string | No | |
| sensitivity | form | string | No | |
| consistencymode | form | string | No | |
| modifiedbytes | form | string | No | |
| originatinguds | form | string | No | |
| hostconsistencydate | form | string | No | |
| systemstateMemory | form | string | No | |
| expirytries | form | string | No | |
| vmname | form | string | No | |
| characteristic | form | string | No | |
| capacity | form | string | No | |
| policyid | form | string | No | |
| poolid | form | string | No | |
| targetcluster | form | string | No | |
| uniqueid | form | string | No | |
| systemstateBootDiskSize | form | string | No | |
| transport | form | string | No | |
| esxhost | form | string | No | |
| target | form | string | No | |
| targetuds | form | string | No | |
| depth | form | string | No | |
| componenttype | form | string | No | |
| readyvm | form | string | No | |
| isbootvmdk | form | string | No | |
| logicalname | form | string | No | |
| originalappid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | form | int | No | |
| modifydate | form | DateTime | No | |
| expirationoff | form | bool | No | |
| slpid | form | int | No | |
| description | form | string | No | |
| createdate | form | DateTime | No | |
| dedupasyncoff | form | bool | No | |
| appid | form | int | No | |
| scheduleoff | form | bool | No | |
| sltid | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /restore/{sessionId}/{imageName}/{datacenterLocation} HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Restore xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
<datacenterLocation>String</datacenterLocation>
<orgName>String</orgName>
<sessionId>String</sessionId>
<JobId>00000000-0000-0000-0000-000000000000</JobId>
<StartVM>false</StartVM>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<imageName>String</imageName>
</Restore>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RestoreResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
<d2p1:_x003C_Content_x003E_k__BackingField>String</d2p1:_x003C_Content_x003E_k__BackingField>
<d2p1:_x003C_errorCode_x003E_k__BackingField>0</d2p1:_x003C_errorCode_x003E_k__BackingField>
<d2p1:_x003C_errorMessage_x003E_k__BackingField>String</d2p1:_x003C_errorMessage_x003E_k__BackingField>
<d2p1:_x003C_errorStatus_x003E_k__BackingField>false</d2p1:_x003C_errorStatus_x003E_k__BackingField>
<d2p1:_x003C_StatusCode_x003E_k__BackingField>String</d2p1:_x003C_StatusCode_x003E_k__BackingField>
<d2p1:_x003C_jobid_x003E_k__BackingField>String</d2p1:_x003C_jobid_x003E_k__BackingField>
</Result>
</RestoreResponse>