Parameters and wildcards use in the base path field

API endpoints are unique URLs that host API resources. You specify an API endpoint URL by providing a hostname and, optionally, a base path. You can associate multiple hostnames with your API.

The base path is case-sensitive. This means that, for example, /basePath and /BasePath denote two different API configurations.

🚧

To avoid conflicts with other web resources, each API endpoint URL must be unique.

Parameters

When entering a base path, you can use curly brackets ({}) to define path parameters (for example, /basePath/{pathparam1}). If desired, you can also define multiple path parameters (for example, /basePath/{pathparam1},{pathparam2},{pathparam3}). All path parameters that you define this way automatically appear in the methods that you select for each resource.

Wildcards

You can use the wildcard (*) sign to indicate a single component between two forward slashes in a base path. Do NOT use wildcards to indicate the following:

  • One or more forward slashes
  • A path component and a forward slash
  • Multiple path components
  • Two separate path components by entering two wildcard signs (**)
  • A path parameter (use curly brackets ({}) instead)

🚧

If you don’t specify a base path, your API will serve content directly from the host and all API resource paths will start at the host root.

Additionally, the settings and security policies associated with the API configuration with an unspecified base path will apply to all requests to any associated hostname(s), and all settings in the API configuration apart from CORS and GZIP compression will override any corresponding property settings you defined in Property Manager for those hostnames. Unless you use the associated property only for traffic to this API, we recommend you specify a base path.

A sample API endpoint details configuration may look like this:


Did this page help you?