Set backup schedule :: TigerGraph Savanna

Creates or replaces the backup schedule for a workspace.

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

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

# max_backup_files integer

Maximum number of backups to keep.

# max_reserved_days integer

Number of days a backup is kept before it is removed.

# max_retry integer

Number of times a failed backup is retried.

# pause boolean

Whether the schedule is paused.

# schedule string required

Cron expression that sets when the backup runs.

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 object

Payload returned by the request.

Set backup schedule

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "max_backup_files": 0,
    "max_reserved_days": 0,
    "max_retry": 0,
    "pause": false,
    "schedule": "<string>"
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "max_backup_files": 0,
  "max_reserved_days": 0,
  "max_retry": 0,
  "pause": False,
  "schedule": "<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/schedule",
  {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "max_backup_files": 0,
      "max_reserved_days": 0,
      "max_retry": 0,
      "pause": false,
      "schedule": "<string>"
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule"
);
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, '{
    "max_backup_files": 0,
    "max_reserved_days": 0,
    "max_retry": 0,
    "pause": false,
    "schedule": "<string>"
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "max_backup_files": 0,
    "max_reserved_days": 0,
    "max_retry": 0,
    "pause": false,
    "schedule": "<string>"
  }`)

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule",
  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/schedule"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("POST", HttpRequest.BodyPublishers.ofString("""
{
      "max_backup_files": 0,
      "max_reserved_days": 0,
      "max_retry": 0,
      "pause": false,
      "schedule": "<string>"
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule"
)
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "max_backup_files": 0,
    "max_reserved_days": 0,
    "max_retry": 0,
    "pause": false,
    "schedule": "<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>"
}