Endpoint
Guide for configuring API endpoints.
Create new API endpoint
To create a new API endpoint configuration, click (+) in the lefthand menu.
The following properties can be configured:
- Name (logical name of this configuration, mandatory)
- Description (optional)
- HTTP Listener (the HTTP listener to use, mandatory)
- Tenant (The tenant that applies for this endpoint, mandatory)
Edit existing API endpoint
To edit an existing endpoint configuration, expand endpoints list and select the configuration in the left hand menu.
An endpoint configuration is divided three tabs; General, Execution flow and Advanced. General is displayed by default.
General
On the General tab you can see/change:
- Name
- Description
- HTTP Listener
- Tenant (select existing or create new by entering the name)
You can also view:
- End point path
- Internal id
- Created timestamp
Execution flow
The execution flow is the pipe providing the functionality of the API.
You can add, enable/disable, remove and reorder the valves of the pipe.
Advanced
In the advanced tab you can change the pipe of your API to an already existing pipe.
Use this function to convert old manually created API configurations to guide configuration.
If you check Convert selected pipe, the selected pipe will be converted to a format that can be managed by guides.
If you check Remove previous pipe, the current pipe will be removed from the configuration when you save.
