Skip to main content
GET
cURL

Query Parameters

gateway_name
string
required

Gateway name.

add
enum<string>

Add gateway_to_tag or filter pass through.

Available options:
pass_through,
tag_gw
delete
enum<string>

Delete tag or gateway_from_tag.

Available options:
tag,
tag_gw
update
enum<string>

Update tag params.

Available options:
cache_rule,
exact_match,
exception_rule,
mode,
policies,
private_sub_filter,
tag_state
import_path
string

User config filepath.

export
enum<string>

Export existing tag config.

Available options:
tag
compress
boolean

Compressing the export string.

tag
string

Tag name.

attach
enum<string>

Attach/detach user. A boolean choice expressed as a string

Available options:
yes,
no
mode
enum<string>

White/Black mode.

Available options:
black,
white
policies
string

Policy list of dictionaries: [{fqdn:, proto:, port:}].

source_ips
string

Source ip/cidr for filtering.

state
enum<string>

Tag_state:enabled/disabled.

Available options:
disabled,
enabled
exception_rule
enum<string>

Exception_rule:enabled/disabled.

Available options:
disabled,
enabled
cache_rule
enum<string>

Cache_rule:enabled/disabled.

Available options:
disabled,
enabled
exact_match
enum<string>

Exact_match:enabled/disabled.

Available options:
disabled,
enabled
private_sub_filter
boolean

Include private subnet into the FQDN filter.

is_discovery
boolean

Discovery mode started.

update_now
boolean

Update policy directly after import.

modify_policy
enum<string>

Add/Delete rules instead of replace.

Available options:
add_rules,
delete_rules
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