Services

A service represents an upstream application or API to which the gateway sends traffic. In simple terms, a service tells the gateway where the upstream system is located.

When to use Services

Use Services when you need to:

• view the services configured for your entity;
• create a new service;
• update an existing service;
• check which host, protocol, and port a service uses;
• add a route or plugin to an existing service;
• delete a service that is no longer required, if your role allows it.

Services page

The Services page displays your latest incomplete service workflow at the top, followed by the services you are allowed to view.

Latest service workflow

The Your Service Work Flows section shows the most recent workflow that has not yet reached 100% completion. It displays the completed and outstanding setup stages so that you can see where to continue. Select Complete Set-Up to resume the workflow.

To view all workflows, select View all Workflows Created. For more information about creating and managing workflows, see Workflows.

Services list

The Your Services section typically includes each service's health, status, name, URL, entity, and creation date. Use the search, filter, list, grid, and pagination controls to find a service.

From this section, you can:

• select Add New Service to open the service creation form; or
• select Add New Service Workflow to open the workflow creation screen.

Screenshot note: This should show the latest incomplete workflow, service creation options, and services list.

Create a service

1. Open Gateway Configuration.
2. Select Services.
3. Select Add New Service.
4. Choose Basic Service Configuration or Advanced Configuration.
5. Complete the required fields.
6. Confirm that the connection details are correct.
7. Select Create Service.

Basic Service Configuration

Use the basic configuration when you want to create a service from its upstream URL. Enter the service name, select the entity to which it belongs, and enter the URL.

The URL (shorthand) field is a shortcut that automatically fills the relevant connection fields. Enter the complete upstream URL, including:

• the protocol, such as http:// or https://;
• the host, such as api.example.com; and
• the path, if one is required, such as /v1/orders.

For example, entering https://api.example.com/v1/orders populates the protocol and host and applies the default HTTPS port. Review the automatically populated protocol, host, and port before creating the service.

Important

Always include the protocol in the shorthand URL. An incomplete URL may populate the connection fields incorrectly.

Screenshot note: This should show the Basic Service Configuration form before the service is created.

Advanced Configuration

Use the advanced configuration when you need more control over the service settings. Instead of relying only on the shorthand URL, review and configure the individual connection fields, including the protocol, host, port, and path where applicable.

Field guide

Field	Required	What to enter	Notes
Enabled	If shown	Whether the service should be active.	Disable the service only when it should not receive traffic.
Entity	Yes	The entity to which the service belongs.	Confirm the entity before creating the service.
Name	Yes	The friendly name used to identify the service.	Keep it short and recognisable.
Description	No	A short explanation of what the service is used for.	Useful for support and handover.
URL	If used	The complete upstream URL.	In basic mode, this can populate the protocol, host, port, and path.
Protocol	Yes	HTTP or HTTPS.	Use HTTPS when the upstream service supports it.
Host	Yes	The upstream host to which traffic should be sent.	Do not include http:// or https:// when entering the host separately.
Port	Yes	The port used by the upstream service.	Common defaults are 80 for HTTP and 443 for HTTPS.
Path	No	The upstream base path.	Leave this blank if the service is reached from the root path.
Tags	No	Optional labels.	Tags make services easier to search and group.

After saving, return to the Services list and confirm that the new service appears.

View or edit a service

To open a service, select its name or the available view or edit action in its row. Review the connection details carefully before making any changes.

Add a route or plugin

A service must be created before you can add routes or plugins to it. Saving the service creates its ID and makes these options available on the Edit Service page; they are not available on the Create Service page.

Add a route

A route is required for reverse billing because it defines which incoming requests the gateway sends to the service. Open the saved service, add or link the route from the Edit Service page, and save your changes.

The route fields and creation process are the same as those described in Routes.

Screenshot note: This should show the Edit Service screen where a route can be added or linked.

Add a plugin

Add plugins when the service requires authentication, logging, rate limiting, or other gateway behaviour. Open the saved service, add the plugin from the Edit Service page, complete its configuration, and save your changes.

The plugin fields and creation process are the same as those described in Plugins.

Screenshot note: This should show the Edit Service screen where a plugin can be added or linked.