Skip to main content
POST
cURL

Body

application/json
CID
string

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

action
string

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

add
enum<string>

Add gateway_to_tag or filter pass through.

Available options:
pass_through,
tag_gw
attach
enum<string>

Attach/detach user.

Available options:
yes,
no
cache_rule
enum<string>

Cache_rule:enabled/disabled.

Available options:
disabled,
enabled
compress
boolean

Compressing the export string.

delete
enum<string>

Delete tag or gateway_from_tag.

Available options:
tag,
tag_gw
exact_match
enum<string>

Exact_match:enabled/disabled.

Available options:
disabled,
enabled
export
enum<string>

Export existing tag config.

Available options:
tag
gw
string

Gateway name.

import_path
string

User config filepath.

is_discovery
boolean

Discovery mode started.

mode
enum<string>

White/Black mode.

Available options:
black,
white
modify_policy
enum<string>

Add/Delete rules instead of replace.

Available options:
add_rules,
delete_rules
policies
string

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

private_sub_filter
boolean

Include private subnet into the FQDN filter.

show
enum<string>

Display current config.

Available options:
all_gws,
cache_rule,
exact_match,
exception_rule,
pass_through,
private_sub_filter,
protocols_supported,
source_ip_filters,
tag_gws,
tag_policies,
tags
source_ips
string

Source ip/cidr for filtering.

state
enum<string>

Tag_state:enabled/disabled.

Available options:
disabled,
enabled
tag
string

Tag name.

update_now
boolean

Update policy directly after import.

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