Developer Documentation


Segment configuration to attach workloads.


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 advanced_config SegmentAdvancedConfig

Advanced configuration for Segment.

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional connectivity_path string

Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional domain_name string

DNS domain name

optional id string

Unique identifier of this resource

optional l2_extension L2Extension

Configuration for extending Segment through L2 VPN

optional ls_id string

This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.

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 overlay_id integer

Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point.

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 subnets array of SegmentSubnet

Subnet configuration. Max 1 subnet

optional tags array of Tag

Opaque identifiers meaningful to the API user

optional transport_zone_path string

Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. This field is required for VLAN backed Segments. Auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified.

optional type string

Segment type based on configuration.

optional vlan_ids array of string

VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with ‘-’ in between.


Was this page helpful?