Response Headers

Headers added by the Rapid Runtime to API responses.


For Enterprise Hub customers, this page only applies if you are using the Rapid Runtime in your requests to API endpoints.


Headers sent to API providers

See Additional Request Headers for a list of headers sent from the Rapid Runtime to the API.


Depending on the API's configuration, API consumers will receive the following headers from the Rapid Runtime:

See the MDN docs.

See the MDN docs.

The format of the body returned in the response.

The date and time of the response.

The version of the Rapid Runtime.

Set to true when the Rapid Runtime generates the response (i.e. the response is not generated from the provider).

The AWS region that hosts the Rapid Runtime.

The version of the Rapid Runtime.

This is a static value indicating the number of requests the plan you are currently subscribed to allows you to make before incurring overages.

The number of requests remaining (from your plan) before you reach the limit of requests your application is allowed to make. When this reaches zero, you will begin experiencing overage charges. This will reset each day or each month, depending on how the API pricing plan is configured. You can view these limits and quotas on the pricing page of the API in the API Hub.

Indicates the number of seconds until the quota resets. This number of seconds would at most be as long as either a day or a month, depending on how the plan was configured.

Additionally, for every billing object defined by the API provider that is attached to a plan and a set of endpoints in it, there will be three response headers that are similar in purpose to the three x-ratelimit headers described above. For example, if you have a billing object named My-Object-1, the following three response headers would be sent:

  • x-ratelimit-my-object-1-limit
  • x-ratelimit-my-object-1-remaining
  • x-ratelimit-my-object-1-reset

For free plans on only, three additional response headers are sent:

  • x-rate-limit-rapid-free-plans-hard-limit-limit
    Indicates the number of requests allowed per month on a free plan.
  • x-rate-limit-rapid-free-plans-hard-limit-remaining
    Indicates the number of remaining free plan requests ( only) for the month.
  • x-rate-limit-rapid-free-plans-hard-limit-reset
    Indicates the number of seconds remaining in the month.