documentation /api provider

Request Headers

API provider

Connection to an API authenticated by fixed request headers, given as one Name:value line per header. Every request carries all of them verbatim, so this covers a session that is a cookie jar plus a CSRF token, a vendor that wants a key and a secret in two headers, or a key beside a protocol version header. For a single header the API Key provider is the simpler spelling.

  • API category: Generic
  • Needs login: No, two-legged: no end-user interaction is required

Configuration parameters

Required

  • headers : string; required
    The request headers, one per line as Name:value with no space after the colon; a value may itself contain colons. $VAR references anywhere in the text are substituted from environment variables at call time, so a secret need not be written into the spec; write $$ for a literal $.

What components can use this API

Concepts:

Ingredients: