Service settings

When a service is created some default settings are applied. These settings can be changed by clicking the cog icon in the toolbar when inside a service.



A descriptive name. The name is shown in the API explorer and logs.


A longer description of the service. It may be helpful to describe how and why this service operates. This description is shown in the API explorer.

Alias Slug

A string that will be used when generating endpoint URLs for this service. The slug must be unique across the services in your solution.

For example, in the following endpoint URL the alias slug is events:

A slug is particularly useful when third-party systems are integrating with a service. Setting an alias slug allows you to switch out the service with another in the future.

Previously the service ID was used instead of a slug. A service is reachable on URLs that use either the slug or the ID. You can see the ID by opening an endpoint in the API explorer and looking for Legacy URL.


An icon to represent the service. This is to help you quickly identify a service and is only shown in Appfarm Create.

Default Time Zone

The time zone that will be used when formatting time. This can be overridden in an API call by adding an x-time-zone header to the request.

Enable Rate Limiter

You may set restrictions on how many parallel connections ("Rate Limit Points") a single IP may have towards endpoints of this service, within a given time window ("Rate Limit Window"). Note that you may also control this per endpoint.

Last updated