Restore a backup :: TigerGraph Savanna

Restores a workspace from a backup.

POST /controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore

Authorizations

x-api-key string header required

Authorization for TigerGraph Savanna. Send the key in the x-api-key request header.

Create an API key

Path parameters

# workspaceID string path required

Workspace ID

# workgroupID string path required

Workgroup ID

Body

# backup_id string required

Unique identifier of the backup to restore.

Response

application/json

# Error boolean

Indicates whether the request returned an error.

# ErrorDetails object[]

Details about each error returned by the request.

Show child attributes Hide child attributes

FieldNamestring

Field associated with the error.

Reasonstring

Explanation of why the error occurred.

Typestring

Category of the error.

Available options: Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown

# Message string

Human-readable summary of the request result.

# RequestID string

Unique identifier for tracing the request.

# Result string

Payload returned by the request.

Restore a backup

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "backup_id": "<string>"
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "backup_id": "<string>"
}

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

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore",
  {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "backup_id": "<string>"
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>",
  "Content-Type: application/json"
]);
curl_setopt($request, CURLOPT_POSTFIELDS, '{
    "backup_id": "<string>"
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "backup_id": "<string>"
  }`)

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore",
  payload,
)
request.Header.Add("x-api-key", "<your-api-key>")
request.Header.Add("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("POST", HttpRequest.BodyPublishers.ofString("""
{
      "backup_id": "<string>"
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore"
)
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "backup_id": "<string>"
  }
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "Error": false,
  "ErrorDetails": [],
  "Message": "<string>",
  "RequestID": "<string>",
  "Result": "<string>"
}

{
  "Error": true,
  "ErrorDetails": [
    {
      "FieldName": "<string>",
      "Reason": "<string>",
      "Type": "Internal-Error"
    }
  ],
  "Message": "<string>",
  "RequestID": "<string>"
}

{
  "Error": true,
  "ErrorDetails": [
    {
      "FieldName": "<string>",
      "Reason": "<string>",
      "Type": "Internal-Error"
    }
  ],
  "Message": "<string>",
  "RequestID": "<string>"
}