Add API Backend form help text

This page contains a section for each field on the Add API Backend form. Within each section is existing or suggested help text.

Name

• Current: API's name
• Proposed: Name of API

Backend

• Umbrella: Define the server where the API is hosted. Multiple servers can be defined to perform load balancing.
• Current:
• Proposed:

Backend protocol

• Current:
• Proposed:

Servers

• Current:
• Proposed:

Host

• Umbrella: Define the host that we will listen for, and then the host the API backend is listening for.
• Current:
• Proposed:

Port

• Current:
• Proposed:

Host

• Current:
• Proposed:

Frontend host

• Current:
• Proposed:

Backend host

• Current:
• Proposed:

Matching URL Prefixes

• Umbrella: What URL prefixes should be routed to this backend?
• Current:
• Proposed:

Url matches

Matching URL Prefixes in API Umbrella

• Umbrella: Tip: We recommend using trailing slashes when configuring these URL prefixes when possible (for example, using /wind/ instead of /wind). While not necessary, this helps prevent future overlapping conflicts (for example, if someone later wants to set up /windmill/). Example: Incoming Frontend Request: http://api.data.govexample.json?param=value Outgoing Backend Request: http://api.data.govexample.json?param=value
• Current:
• Proposed:

Frontend prefix

• Current:
• Proposed:

Backend prefix

• Current:
• Proposed:

Documentation

• Current:
• Proposed:

Documentation link

• Current:
• Proposed:

Upload documentation

• Current:
• Proposed:

Documentation Configuration File

• Current:
• Proposed:

Create new documentation

• Current:
• Proposed:

Global Request Settings

• Current:
• Proposed:

Append query string parameters

• Current:
• Proposed:

Set headers

• Current:
• Proposed:

HTTP basic authentication

• Current:
• Proposed:

HTTPS requirements

• Current:
• Proposed:

API Key Checks

• Current:
• Proposed:

Required roles

• Current:
• Proposed:

Via HTTP header

• Current:
• Proposed:

Via GET query parameter

• Current:
• Proposed:

Rate limit mode

• Current:
• Proposed:

Advanced Requests Rewriting

• Current:
• Proposed:

Rewrite

• Current:
• Proposed:

Matcher type

• Current:
• Proposed:

HTTP method

• Current:
• Proposed:

Frontend matcher

• Current:
• Proposed:

Backend replacement

• Current:
• Proposed:

Advanced Settings

• Current:
• Proposed:

Balance algorithm

• Current:
• Proposed:

Error templates

• Current:
• Proposed:

JSON

• Current:
• Proposed:

XML

• Current:
• Proposed:

CSV

• Current:
• Proposed: