Add an allowed IP :: TigerGraph Savanna

Adds an IP address or CIDR range to a workgroup allow list.

POST /controller/v4/v2/workgroups/{workgroupID}/allow_list

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

# workgroupID string path required

Workgroup ID

Body

# cidr string required

IP address or range in CIDR notation, such as 192.168.1.0/24 for a range or 192.168.1.2/32 for a single address.

# id string

Unique identifier of the allow list entry.

# note string

Note recording why the address was allowed.

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.

Show child attributes Hide child attributes

cidrstringrequired

IP address or range in CIDR notation, such as 192.168.1.0/24 for a range or 192.168.1.2/32 for a single address.

idstring

Unique identifier of the allow list entry.

notestring

Note recording why the address was allowed.

Add an allowed IP

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "cidr": "<string>",
    "id": "<string>",
    "note": "<string>"
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "cidr": "<string>",
  "id": "<string>",
  "note": "<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}/allow_list",
  {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "cidr": "<string>",
      "id": "<string>",
      "note": "<string>"
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list"
);
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, '{
    "cidr": "<string>",
    "id": "<string>",
    "note": "<string>"
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "cidr": "<string>",
    "id": "<string>",
    "note": "<string>"
  }`)

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list",
  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}/allow_list"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("POST", HttpRequest.BodyPublishers.ofString("""
{
      "cidr": "<string>",
      "id": "<string>",
      "note": "<string>"
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list"
)
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "cidr": "<string>",
    "id": "<string>",
    "note": "<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": {
    "cidr": "<string>",
    "id": "<string>",
    "note": "<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>"
}