importGateway

Creates or updates a Logical Gateway on the API Platform Server.  It accepts a json file with the configuration of the Logical Gateway.  See below for examples.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Oracle API Platform Account

FDOAP_CLOUD_ACCOUNT_CODE

Y

The Oracle API Platform cloud account to use for this operation. 

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Gateway File

FDOAP_INP_GATEWAY_FILE

Y

Json file to use for gateway creation.  Can be absolute or relative to the artifacts directory.

Apply Node Grant

FDOAP_INP_APPLY_NODE_GRANT

Y

Should the NodeServiceAccount grant be applied to this gateway?  This grant is needed to provision nodes against this Logical Gateway.

Outputs

Output Name

Description

Output Name

Description

FDOAP_OUT_GATEWAY_ID

Logical Gateway Id after creation or updating.

Artifacts

This operation consumes artifacts from the artifacts repository.

Endpoint Selection

This operation will select all available endpoints associated to the Target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

Gateway File

Below is a sample json file to create a Logical Gateway.  The only required field is the 'name' field

{ "name": "Development", "description": "Development Gateway", "location": "http://example.com", "urls": [ "http://example.com:8001", "http://my.example.com:8001", "https://example.com:8002" ], "proxyUrls":[ "http://proxy.com:8001" ], "firewall": { "maxUnboundedItems": "1024", "maxChildElementDepth": "1024", "maxItemValueLength": "102400", "maxMessageSize": "1024000" } }
The following macros are not currently supported in the footer:
  • style