Skip to main content

Custom API Headers

When using Data Equity Studio, you can customize your API with specific headers for controlling various behaviors. These headers are used when making requests to your API.

1. apikey Header​

  • Purpose: This header is required if the API Key policy is enabled in the Policy Editor.
  • Usage: Include the apikey header with a valid API key value to authenticate the request.
  • Example: 
    apikey: your-api-key-here

2. x-response-count Header​

  • Purpose: This header controls how many mock responses will be returned for the API request. Maximum limit is set to 25.
  • Usage: Specify the number of mock responses you want in the request.
  • Example: 
    x-response-count: 5
  • This would return 5 mock responses.

3. x-fake-response Header​

  • Purpose: This header determines whether the responses should be freshly generated or return a previously generated mock response.
  • Usage:
  • true: The system will generate a new response each time the request is made.
  • false: The system will return a previously generated response.
  • Example: 
    x-fake-response: true
  • This would return new responses everytime.