Public subnet filtering gateway details

GET

api

get_public_subnet_filtering_gateway_details

cURL

curl -sk -X GET "https://<controller>/v2/api/get_public_subnet_filtering_gateway_details" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_public_subnet_filtering_gateway_details"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/get_public_subnet_filtering_gateway_details", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Query Parameters

account

string

Account name.

region

string

AWS region name.

vpc_id

string

AWS VPC ID.

gateway_name

string

required

Gateway_name.

gateway_size

string

Gateway size.

tag

string

Gateway tag.

gateway_subnet_and_zone

string

Gateway_subnet_and_zone subnet.

enfored_route_tables

string

Enfored_route_tables.

guard_duty_enforced

enum<string>

Yes/no. A boolean choice expressed as a string

Available options:

yes,

no

cloud_type

string

Cloud type.

log_file

string

Full path of the progress log file.

action

string

The API action to perform. Required for 7.2 controllers only.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X GET "https://<controller>/v2/api/get_public_subnet_filtering_gateway_details" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_public_subnet_filtering_gateway_details"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/get_public_subnet_filtering_gateway_details", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Concepts & Architecture

Guides

Reference

Public subnet filtering gateway details

Query Parameters

Response