Using Plutora-Info HTTP Header

Users should add a Plutora-Info HTTP header to all Plutora API requests so that Plutora can monitor API usage per script.

Plutora-Info can be added to any HTTP request, such as GET, PUT, PUSH, PATCH, DELETE, and so on.

Why is the Plutora-Info Header Required?

The Plutora-Info HTTP header helps to:

  • Provide a greater understanding of who, what, and why APIs are being called.
  • Identify areas for improvement.

Plutora’s Support staff can use the information provided to optimize and provide advice for scripts. When a customer has multiple scripts, having Plutora-Info headers helps Support identify and resolve issues faster.

What Scripts Should Use Plutora-Info?

All the scripts calling the Plutora APIs, both internal or external. This means custom UI scripts, integration hub scripts, and any application calling Plutora’s APIs.

The more scripts that include this information the more useful our data is for all teams. Please retrofit when maintaining your existing scripts.

Single Attribute

key=value

Multiple Attributes

key1=value1;key2=value2;...

Examples

PLUTORA-INFO script.name=jirasync

PLUTORA-INFO script.name=jirasync;script.runid=12321

Valid Characters

The header value is validated with this regex: /^[-a-z0-9_.:;,= ]*$/i

Note the limited character set. Use underscore instead of spaces.

@ was excluded to prevent PII emails from being logged.

Script Attributes

Attribute Description
script.name A unique identifier per script. No spaces are allowed. Refer to Valid Characters above.
script.runid A unique identifier per script invocation.
script.correlationid A unique identifier per API call. This allows logs to be correlated, or individual call details to be examined “Request id xyz took 20seconds, what does New Relic say about it?”
script.version The version number for the script.

 

Back to the top arrow

Be the first to find out about new features. Subscribe to the Release Notes email. Subscribe Now
Updated on April 19, 2021

Was this article helpful?

Related Articles