ExternalAppService

Represents an External Service in the Application Designer.

Overview

associatedServiceEgressGroupID string filterable   orderable  
associatedServiceEgressRedirectID string filterable   orderable  
associatedServiceIngressGroupID string filterable   orderable  
associatedServiceIngressRedirectID string filterable   orderable  
description string filterable   orderable  
destinationNATAddress string filterable   orderable  
destinationNATEnabled boolean filterable   orderable  
destinationNATMask string filterable   orderable  
egressType enum (REDIRECT | ROUTE) filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
ingressType enum (REDIRECT | ROUTE) filterable   orderable  
lastUpdatedBy string autogenerated  
metadata string filterable   orderable  
name string required   filterable   orderable  
sourceNATAddress string filterable   orderable  
sourceNATEnabled boolean filterable   orderable  
virtualIP string filterable   orderable  
virtualIPRequired boolean filterable   orderable  

API Resource

/externalappservices/id
delete get put

Parents

/enterprises/id/externalappservices
get post
/domains/id/externalappservices
get post
/externalappservices
get post

Children

/externalappservices/id/metadatas
get post
/externalappservices/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedServiceEgressGroupID string filterable   orderable  
Discussion

ID of service port group identifying the output ports


Charateristics

Format: free
SDK attribute: associatedServiceEgressGroupID

associatedServiceEgressRedirectID string filterable   orderable  
Discussion

the redirect target ID that identifies the output ports


Charateristics

Format: free
SDK attribute: associatedServiceEgressRedirectID

associatedServiceIngressGroupID string filterable   orderable  
Discussion

ID of service port group identifying the input ports


Charateristics

Format: free
SDK attribute: associatedServiceIngressGroupID

associatedServiceIngressRedirectID string filterable   orderable  
Discussion

the redirect target ID that identifies the input ports


Charateristics

Format: free
SDK attribute: associatedServiceIngressRedirectID

description string filterable   orderable  
Discussion

Description of the flow.


Charateristics

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

destinationNATAddress string filterable   orderable  
Discussion

Destination NAT Address


Charateristics

Format: free
SDK attribute: destinationNATAddress

destinationNATEnabled boolean filterable   orderable  
Discussion

Boolean flag to indicate whether source NAT is enabled


Charateristics

Format: free
SDK attribute: destinationNATEnabled

destinationNATMask string filterable   orderable  
Discussion

netmask of the Destination NAT


Charateristics

Format: free
SDK attribute: destinationNATMask

egressType enum filterable   orderable  
Discussion

Egress type.


Charateristics

Allowed values: REDIRECT, ROUTE
SDK attribute: egressType

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

ingressType enum filterable   orderable  
Discussion

Ingress type.


Charateristics

Allowed values: REDIRECT, ROUTE
SDK attribute: ingressType

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


Charateristics

Format: free
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

sourceNATAddress string filterable   orderable  
Discussion

Source NAT Address


Charateristics

Format: free
SDK attribute: sourceNATAddress

sourceNATEnabled boolean filterable   orderable  
Discussion

Boolean flag to indicate whether source NAT is enabled


Charateristics

Format: free
SDK attribute: sourceNATEnabled

virtualIP string filterable   orderable  
Discussion

Virtual IP Address


Charateristics

Format: free
SDK attribute: virtualIP

virtualIPRequired boolean filterable   orderable  
Discussion

Boolean flag to indicate whether we require a VIP


Charateristics

Format: free
SDK attribute: virtualIPRequired