Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed formatting

Table of Contents
maxLevel3

...

  • PATH_INFO—The path elements after the Task part of the URL.
  • REMOTE_USER—The name of the user that invoked this request.
  • REMOTE_ADDR—The IP address of the host that invoked this request.
  • REQUEST_METHOD—The method used to invoke this request.
  • QUERY_STRING—The query string element of the URL that made the request.
  • REMOTE_PORT—The port of the client that made the request.
Info

We return the IP address of the client or last proxy that sent the request.

When referencing these arguments, they must be prefixed with an underscore like any other parameter.  When designing a Pipeline, you might find it easier to explicitly add these parameters with a default value.

...

  • The header must be capitalized in its entirety. Headers are case-sensitive.
  • Hyphens must be changed to underscores.
  • The HTTP custom headers override both the Task and Pipeline parameters, but the query string parameter has the highest precedence.
  • We support the x-snapi-pipeline-ruuid customer header in the HTTP response to Triggered Task requests.

For example, if you pass a tenant ID (X-TENANT-ID) in a header, add the parameter X_TENANT_ID and provide a default or leave it blank. When you configure the expression, refer to the Pipeline argument following standard convention:  _X_TENANT_ID.  In the HTTP request, you add the header X-TENANT-ID: 123abc, which results in the value 123abc being substituted for the Pipeline argument X_TENANT_ID.


Info

Custom response headers are supported for Ultra Task or Triggered tasks invoked using Ground URLs. They are not supported for Cloud invoked Triggered tasks.

Example

You can set an HTTP header in a Triggered Task by using the Mapper Snap.

To set the header, add a Mapper Snap to the end of the Pipeline.

...