cvm · 2017-03-12

RebootInstances

POST

Restart instances.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/RebootInstances path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cvm.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cvm.api3.convergecloud.com' \
  -H 'X-TC-Action: RebootInstances' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"InstanceIds":["<InstanceId>"]}'

Request parameters

Field	Type	Required	Description
InstanceIds	string[]	Yes	Instance IDs. To obtain the instance IDs, you can call `DescribeInstances` and look for `InstanceId` in the response. You can operate up to 100 instances in each request.
ForceReboot	boolean	No	Whether to forcibly restart an instance after a normal restart fails. Valid values: `TRUE`: yes; `FALSE`: no Default value: `FALSE`. This parameter has been disused. We recommend using `StopType` instead. Note that `ForceReboot` and `StopType` parameters cannot be specified at the same time.
StopType	string	No	Shutdown type. Valid values: SOFT: soft shutdown HARD: hard shutdown SOFT_FIRST: perform a soft shutdown first, and perform a hard shutdown if the soft shutdown fails Default value: SOFT.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    // action-specific fields,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.

SecretIdSecretKey

Request bodyvalid JSONPOST cvm.api3.convergecloud.com · RebootInstances

{
  "InstanceIds": [
    "<InstanceId>"
  ]
}

This action changes resources in my own account and may create a charge. I understand.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "RequestId": "42cc64f6-f154-7abe-11a8-c472040482bb"
  }
}