Developer Documentation


Tier-1 instance configuration.


Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _protection string

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.

optional _revision integer

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional default_rule_logging boolean

Indicates if logging should be enabled for the default whitelisting rule. This filed is deprecated and recommended to change Rule logging filed. Note that this filed is not synchornied with default logging field.

optional description string

Description of this resource

optional dhcp_config_paths array of string

DHCP configuration for Segments connected to Tier-1. DHCP service is enabled in relay mode.

optional disable_firewall boolean

Disable or enable gateway fiewall.

optional display_name string

Defaults to ID if not set

optional enable_standby_relocation boolean

Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.

optional failover_mode string

Determines the behavior when a Tier-1 instance restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. Only applicable when edge cluster is configured in Tier1 locale-service.

optional force_whitelisting boolean

This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.

optional id string

Unique identifier of this resource

optional ipv6_profile_paths array of string

Configuration IPv6 NDRA and DAD profiles. Either or both NDRA and/or DAD profiles can be configured.

optional marked_for_delete boolean

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.

optional parent_path string

Path of its parent

optional path string

Absolute path of this object

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional route_advertisement_rules array of RouteAdvertisementRule

Route advertisement rules and filtering

optional route_advertisement_types array of string

Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.

optional tags array of Tag

Opaque identifiers meaningful to the API user

optional tier0_path string

Specify Tier-1 connectivity to Tier-0 instance.

optional type string

Tier1 connectivity type for reference. Property value is not validated with Tier1 configuration. ROUTED: Tier1 is connected to Tier0 gateway and routing is enabled. ISOLATED: Tier1 is not connected to any Tier0 gateway. NATTED: Tier1 is in ROUTED type with NAT configured locally.

Property of


Parameter To

Create Tier1
Update Tier1

Returned By

Get Tier1
Create Tier1



Was this page helpful?