# Request ID Configuration

The `request-id` plugin adds a unique ID to each request proxied through the API gateway, facilitating effective tracking of API requests for better API management.<!-- --> <!-- -->Configuration covers plugin parameters.

## Parameters[​](#parameters "Direct link to Parameters")

See plugin [common configurations](https://docs.api7.ai/apisix/reference/plugin-common-configurations.md) for configuration options available to all plugins.

* header\_name

  string

  default: `X-Request-Id`

  ***

  Specify the name of the header that carries the request unique ID. Note that if a request carries an ID in the `header_name` header, the plugin will use the header value as the unique ID and will not overwrite it with the generated ID.

* include\_in\_response

  boolean

  default: `true`

  ***

  If true, include the generated request ID in the response header, where the name of the header is the `header_name` value.

* algorithm

  string

  default: `uuid`

  valid value:

  `uuid`, `nanoid`, `range_id`, `ksuid`, or `uuidv7`

  ***

  Specify the algorithm used for generating the unique ID.

  When set to `uuid`, the plugin generates a universally unique identifier. When set to `nanoid`, the plugin generates a compact, URL-safe ID. When set to `range_id`, the plugin randomly selects each character from the configured character set. When set to `ksuid`, the plugin generates a time-sortable, globally unique ID. KSUID support was introduced in API7 Enterprise 3.9.0 and APISIX 3.14.0. When set to `uuidv7`, the plugin generates an RFC 9562 UUID v7 identifier with a millisecond timestamp, a worker-local sequence, and random bits. UUID v7 values are monotonic within one worker, but ordering is not coordinated across workers or gateway instances. UUID v7 support was introduced in API7 Enterprise 3.9.8 and APISIX 3.17.0.

* range\_id

  object

  ***

  Define the configuration for generating a request ID using the `range_id` algorithm.

  * char\_set

    string

    default: `abcdefghijklmnopqrstuvwxyzABCDEFGHIGKLMNOPQRSTUVWXYZ0123456789`

    valid value:

    minimum length 6

    ***

    Specify the character set used for the `range_id` algorithm.

  * length

    integer

    default: `16`

    valid value:

    greater than or equal to 6

    ***

    Set the length of the generated ID for the `range_id` algorithm.
