Validate a cloud provider :: TigerGraph Savanna

Checks whether a Bring Your Own Cloud (BYOC) registration would succeed, without creating anything.

POST /controller/v4/v2/cloud-providers/validate

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

Body

# account_id string

Cloud account identifier to validate.

# platform string required

Cloud platform to validate.

# region string required

Cloud region to validate.

# role_arn string required

Amazon Resource Name of the IAM role TigerGraph will assume.

# role_external_id string

External identifier used when TigerGraph assumes the IAM role.

# secure_connection boolean

Whether to validate a private, secure connection.

Response

200 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.

Validate a cloud provider

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/cloud-providers/validate' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "account_id": "<string>",
    "platform": "<string>",
    "region": "<string>",
    "role_arn": "<string>",
    "role_external_id": "<string>",
    "secure_connection": false
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/cloud-providers/validate"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "account_id": "<string>",
  "platform": "<string>",
  "region": "<string>",
  "role_arn": "<string>",
  "role_external_id": "<string>",
  "secure_connection": False
}

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

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/validate",
  {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "account_id": "<string>",
      "platform": "<string>",
      "region": "<string>",
      "role_arn": "<string>",
      "role_external_id": "<string>",
      "secure_connection": false
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/validate"
);
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, '{
    "account_id": "<string>",
    "platform": "<string>",
    "region": "<string>",
    "role_arn": "<string>",
    "role_external_id": "<string>",
    "secure_connection": false
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "account_id": "<string>",
    "platform": "<string>",
    "region": "<string>",
    "role_arn": "<string>",
    "role_external_id": "<string>",
    "secure_connection": false
  }`)

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/validate",
  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/cloud-providers/validate"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("POST", HttpRequest.BodyPublishers.ofString("""
{
      "account_id": "<string>",
      "platform": "<string>",
      "region": "<string>",
      "role_arn": "<string>",
      "role_external_id": "<string>",
      "secure_connection": false
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/validate"
)
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "account_id": "<string>",
    "platform": "<string>",
    "region": "<string>",
    "role_arn": "<string>",
    "role_external_id": "<string>",
    "secure_connection": false
  }
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>"
}