GatewayProperties

  • Article

Describes properties of a gateway resource.

Properties

Name Type Required
description string No
sourceNetwork NetworkRef Yes
destinationNetwork NetworkRef Yes
tcp array of TcpConfig No
http array of HttpConfig No
status string (enum) No
statusDetails string No
ipAddress string No

description

Type: string
Required: No

User readable description of the gateway.

sourceNetwork

Type: NetworkRef
Required: Yes

Network the gateway should listen on for requests.

destinationNetwork

Type: NetworkRef
Required: Yes

Network that the Application is using.

tcp

Type: array of TcpConfig
Required: No

Configuration for tcp connectivity for this gateway.

http

Type: array of HttpConfig
Required: No

Configuration for http connectivity for this gateway.

status

Type: string (enum)
Required: No

Status of the resource.

Possible values are:

  • Unknown - Indicates the resource status is unknown. The value is zero.
  • Ready - Indicates the resource is ready. The value is 1.
  • Upgrading - Indicates the resource is upgrading. The value is 2.
  • Creating - Indicates the resource is being created. The value is 3.
  • Deleting - Indicates the resource is being deleted. The value is 4.
  • Failed - Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5.

statusDetails

Type: string
Required: No

Gives additional information about the current status of the gateway.

ipAddress

Type: string
Required: No

IP address of the gateway. This is populated in the response and is ignored for incoming requests.