Underlay

None

Overview

description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
underlayId float read only   autogenerated   filterable   orderable   locally unique  

API Resource

/underlays/id
delete get put

Parents

/underlays
get post
/uplinkconnections/id/underlays
get

Children

/underlays/id/metadatas
get post
/underlays/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description of the underlay

Charateristics

Format: free
SDK attribute: description

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the underlay

Charateristics

Format: free
SDK attribute: name

underlayId float read only   autogenerated   filterable   orderable   locally unique  
Discussion

Used to identify and make a distinction between different Underlays with an autogenerated integer.

Charateristics

Min value: 1
Max value: 65535
SDK attribute: underlayId