Delete a cloud provider :: TigerGraph Savanna

Unregisters a Bring Your Own Cloud (BYOC) provider and removes the Savanna components from that cloud account. Delete its workgroups first.

DELETE /controller/v4/v2/cloud-providers/{cloudProviderID}

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

# cloudProviderID string path required

Cloud Provider ID

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 object

Payload returned by the request.

Delete a cloud provider

curl --request DELETE \
  --url 'https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}' \
  --header 'x-api-key: <your-api-key>'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}"
headers = {"x-api-key": "<your-api-key>"}
response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}",
  {
    method: "DELETE",
    headers: { "x-api-key": "<your-api-key>" },
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>"
]);
curl_exec($request);

request, _ := http.NewRequest(
  "DELETE",
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}",
  nil,
)
request.Header.Add("x-api-key", "<your-api-key>")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}"
  ))
  .header("x-api-key", "<your-api-key>")
  .DELETE()
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}"
)
request = Net::HTTP::Delete.new(uri)
request["x-api-key"] = "<your-api-key>"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

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