---
title: Sideband API Endpoint configuration properties
description: Configure Sideband API Endpoint properties to control how the Sideband API Endpoint handles requests and what information it provides to the PDP.
component: pingauthorize
version: 11.0
page_id: pingauthorize:pingauthorize_server_administration_guide:paz_sideband_api_endpoint_config
canonical_url: https://docs.pingidentity.com/pingauthorize/11.0/pingauthorize_server_administration_guide/paz_sideband_api_endpoint_config.html
revdate: March 30, 2026
---

# Sideband API Endpoint configuration properties

The following table identifies Sideband API Endpoint properties that might force the inclusion of additional attributes with the policy request:

| Property                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `base-path`                | Defines the URI path prefix that the Sideband API Endpoint uses to determine whether the endpoint handles a request.The `base-path` property value can include parameters. If parameters are found and matched, they're included as attributes to policy requests.The following configuration properties reference parameters that the `base-path` introduces:- `service`

- `resource-path`

- `policy-request-attribute` |
| `service`                  | Identifies the API service to the PDP. A policy can use this value to target requests.The `service` value appears in the policy request as the `service` attribute. If undefined, the `service` value defaults to the name of the Sideband API Endpoint.                                                                                                                                                                   |
| `resource-path`            | Identifies the REST resource to the PDP.The resource path value appears in the policy request as the `HttpRequest.ResourcePath` attribute. If undefined, the `resource-path` value defaults to the portion of the request that follows the base path, as defined by `base-path`.                                                                                                                                           |
| `policy-request-attribute` | Defines zero or more static, arbitrary key-value pairs. If specified, the pairs are always added as attributes to policy requests.These custom attributes appear in the policy request as fields of the `Gateway` attribute. For example, if a value of `policy-request-attribute` is `foo=bar`, the attribute `Gateway.foo` is added to the policy request with the value `bar`.                                          |