---
title: Sideband API path parameters
description: Path parameters are dynamic values in the request URI that are extracted and included in policy requests as fields of the Gateway policy request attribute.
component: pingauthorize
version: 11.0
page_id: pingauthorize:pingauthorize_server_administration_guide:paz_sideband_path_parameters
canonical_url: https://docs.pingidentity.com/pingauthorize/11.0/pingauthorize_server_administration_guide/paz_sideband_path_parameters.html
revdate: April 13, 2026
section_ids:
  basic-example: Basic example
  advanced-example: Advanced example
---

# Sideband API path parameters

The `base-path` property value can include parameters. If parameters are found and matched, they're included in policy requests as fields of the `Gateway` policy request attribute.

Other configuration properties can use these parameters. Learn more in [Sideband API Endpoint configuration properties](paz_sideband_api_endpoint_config.html).

You must use the `base-path` property to introduce parameters. Other configuration properties cannot introduce new parameters.

## Basic example

The following example configuration demonstrates how request URIs alter policy requests:

| Sideband API Endpoint property | Example value                        |
| ------------------------------ | ------------------------------------ |
| `base-path`                    | `/accounts/{accountId}/transactions` |
| `policy-request-attribute`     | `foo=bar`                            |

A request URI with the path `/accounts/XYZ/transactions/1234` matches the example `base-path` value.

The following properties are added to the policy request:

* `HttpRequest.ResourcePath : 1234`

* `Gateway.accountId : XYZ`

* `Gateway.foo : bar`

## Advanced example

Unlike the basic example, which extracted a single path parameter, this example demonstrates how multiple parameters can be extracted from the request URI and referenced in other configuration properties.

Consider the following example configuration:

| Sideband API Endpoint property | Example value                     |
| ------------------------------ | --------------------------------- |
| `base-path`                    | `/health/{tenant}/{resourceType}` |
| `service`                      | `HealthAPI.{resourceType}`        |
| `resource-path`                | `{resourceType}/{_TrailingPath}`  |

A request URI with the path `/health/OmniCorp/patients/1234` matches the example `base-path` value.

The following properties are added to the policy request:

* `service : HealthAPI.patients`

* `HttpRequest.ResourcePath : patients/1234`

* `Gateway.tenant : OmniCorp`

* `Gateway.resourceType : patients`