> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.xapi.to/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.xapi.to/_mcp/server.

# 恢复实例

POST https://sandbox.xapi.to/v1/sandboxes/{id}/resume
Content-Type: application/json

提交恢复操作后轮询实例，直到 observedState 为 RUNNING。

Reference: https://docs.xapi.to/sandbox/api-reference/lifecycle/resume-sandbox

## Authentication

- `XAPI-Key` header (required) — 在 xAPI Console 创建的 API Key。只会发送给 *.xapi.to。

## Servers

- `https://sandbox.xapi.to` (Production, default)
- `https://sandbox.test.xapi.to` (Test)

## Request

### Path parameters

- `id` (string, required) — xAPI Sandbox 实例 UUID。

### Body (application/json)

This endpoint expects an object.

- `idempotencyKey` (string, optional) — 当前状态操作的幂等键；同一动作在响应不确定时复用原值，新动作使用新值。

## Response

### 201

恢复操作

- `id` (string, optional) — 操作记录 UUID，用于日志关联，不是实例 ID。
- `idempotencyKey` (string, optional) — 此操作的幂等键；重复请求是否属于同一操作由实例 ID 和该值共同确定。
- `type` (enum, optional) — 操作类型。生命周期操作改变状态；EXEC/FILE/PORT/EXTENSION 是实例内的数据面调用。
  - Allowed values: `CREATE`, `SUSPEND`, `RESUME`, `TERMINATE`, `EXEC`, `EXTENSION`, `FILE_READ`, `FILE_WRITE`, `FILE_LIST`, `PORT_OPEN`
- `status` (enum, optional) — 操作执行状态；HTTP 已接受不代表这里已经 SUCCEEDED。
  - Allowed values: `PENDING`, `RUNNING`, `SUCCEEDED`, `FAILED`, `TIMED_OUT`, `CANCELLED`
- `expectedState` (enum, optional, nullable) — 生命周期操作期望实例最终达到的状态；数据面操作通常为 null。
  - Allowed values: `PROVISIONING`, `RUNNING`, `SUSPENDED`, `TERMINATED`, `FAILED`, `UNKNOWN`
- `error` (string, optional, nullable) — 操作失败、超时或取消时的诊断信息；成功时为 null。
- `input` (map from string to any, optional) — 已脱敏/裁剪的操作输入摘要；文件写入只记录路径、编码和大小，不保存文件内容。
- `requestedAt` (datetime, optional) — Gateway 接受操作请求的时间。
- `startedAt` (datetime, optional, nullable) — 适配器实际开始处理的时间；尚未开始时为 null。
- `completedAt` (datetime, optional, nullable) — 操作进入终态的时间；仍在执行时为 null。
- `durationMs` (integer, optional) — 操作实际执行耗时，单位毫秒；并非实例总运行时长。
- `exitCode` (integer, optional) — EXEC 操作的远端进程退出码；0 通常表示成功，非零表示命令失败但 HTTP 请求可能仍成功。
- `stdoutPreview` (string, optional) — 为审计保存的标准输出前缀，不保证是完整 stdout。
- `stderrPreview` (string, optional) — 为审计保存的标准错误前缀，不保证是完整 stderr。
- `outputTruncated` (boolean, optional) — stdoutPreview 或 stderrPreview 是否因日志大小限制被截断。

## Errors

### 409 Conflict Error

实例状态不允许当前操作，或已有状态变更正在执行

- `statusCode` (integer, optional) — HTTP 状态码的数值形式，例如 400、401、402、404、409 或 429。
- `message` (ErrorMessage, optional) — 面向调用方的错误原因；校验失败时可能是多条消息数组。
- `error` (string, optional) — HTTP 错误类别，例如 Bad Request、Unauthorized 或 Conflict。

## Types

### ErrorMessage

面向调用方的错误原因；校验失败时可能是多条消息数组。

- string
- list of string

## Examples

**Request**

```json
{
  "idempotencyKey": "docs-resume-example"
}
```

**Response**

```json
{
  "id": "22222222-2222-4222-8222-222222222223",
  "idempotencyKey": "docs-resume-example",
  "type": "RESUME",
  "status": "SUCCEEDED",
  "expectedState": "RUNNING"
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume"

payload = { "idempotencyKey": "docs-resume-example" }
headers = {
    "XAPI-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume';
const options = {
  method: 'POST',
  headers: {'XAPI-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"idempotencyKey":"docs-resume-example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"docs-resume-example\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("XAPI-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["XAPI-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"docs-resume-example\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume")
  .header("XAPI-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"docs-resume-example\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume', [
  'body' => '{
  "idempotencyKey": "docs-resume-example"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'XAPI-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume");
var request = new RestRequest(Method.POST);
request.AddHeader("XAPI-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"idempotencyKey\": \"docs-resume-example\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "XAPI-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["idempotencyKey": "docs-resume-example"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/resume")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```