HTTP API keyReference for the HTTP API key connection in Runtara: what it is used for, its capabilities, connection types and the data it handles.AgentsdocsAgentsdocsagentscustom api

Custom API

HTTP API key

The HTTP API key connection stores an API key, the header it is sent in, and the API's base URL, which must be HTTPS. HTTP steps that use the connection get the header added for them and can only call URLs under that base URL.

For plans and availability, see the HTTP API key integration.

Common use cases

  1. Read and update records in a system that has no built-in agent.
  2. Send orders or status updates to a partner's REST API.
  3. Pull prices or stock levels from a supplier API.

Capabilities

  • API key sent in the header you name
  • Requests pinned to one HTTPS base URL
  • Credentials kept out of workflow definitions

Connection types

http_api_key

Data handled

  • Request and response bodies
  • Response status and headers