Flow

Flow represents the traffic between two different application tiers.

Overview

description string filterable   orderable  
destinationTierID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
metadata string filterable   orderable  
name string required   filterable   orderable  
originTierID string

API Resource

/flows/id
delete get put

Parents

This object has no parents.

Children

/flows/id/metadatas
get post
/flows/id/globalmetadatas
get post put
/flows/id/flowforwardingpolicies
get post
/flows/id/flowsecuritypolicies
get post
/flows/id/eventlogs
get

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description of the flow.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: description

destinationTierID string
Discussion

Flow destination tier id.

Charateristics

Format: free
SDK attribute: destinationTierID

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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

metadata string filterable   orderable  
Discussion

Metadata field to store flow related data.

Charateristics

Format: free
Max length: 255
SDK attribute: metadata

name string required   filterable   orderable  
Discussion

Name of the flow.

Charateristics

Format: free
Min length: 1
Max length: 60
SDK attribute: name

originTierID string
Discussion

Flow origin tier id.

Charateristics

Format: free
SDK attribute: originTierID