Skip to content

Configuration

This page lists supported configuration settings for the service and SDKs.

Service configuration (client-side)

Base URL

  • Sandbox: https://sandbox.api.iron.example
  • Production: https://api.iron.example

Headers

Header Type Required Default Description
Authorization string yes Bearer <API_KEY>
Idempotency-Key string no (recommended for publish) Deduplicates retries for publish
Content-Type string yes (POST JSON) application/json

SDK configuration

Name Type Default Required Description
IRON_API_KEY string yes API key used for auth
IRON_BASE_URL string sandbox URL no Override API base URL
IRON_TIMEOUT_SECONDS int 30 no HTTP request timeout
IRON_MAX_RETRIES int 3 no Retry count for retryable errors
IRON_RETRY_BASE_DELAY_MS int 250 no Base delay for exponential backoff
  • Always send an Idempotency-Key for publish.
  • Use IRON_MAX_RETRIES=3 with exponential backoff for 429 and transient 5xx.
  • Set consumer processing to be idempotent (at-least-once delivery).

Next: Getting Started · Reference · Changelog · Support