Install an add-on :: TigerGraph Savanna

Installs an add-on for your organization, or enables or disables it.

POST /controller/v4/v2/addons/{addonsID}/install

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

# addonsID string path required

Add-on ID

Query parameters

# enable string query required

Enable or disable add-on

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.

Install an add-on

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/install' \
  --header 'x-api-key: <your-api-key>'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/install"
headers = {"x-api-key": "<your-api-key>"}
response = requests.post(url, headers=headers)
print(response.json())

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

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

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/install",
  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/addons/{addonsID}/install"
  ))
  .header("x-api-key", "<your-api-key>")
  .method("POST", HttpRequest.BodyPublishers.noBody()()
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/install"
)
request = Net::HTTP::Post.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>"
}

{
  "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>"
}