Skip to main content

Manage Headers

Instance-Level Headers

Some APIs require custom non-auth related HTTP headers—such as a static cookie, or a unique value like x-base-directory: /foo/bar—on every request. Previously, you had two work-arounds:

  • Attach the header to each authentication.
  • Not ideal, because our automated tests can override or remove authentication values.
  • Add the header to every endpoint.
  • Manageable for a handful of endpoints, but painful (and error-prone) for APIs with hundreds or thousands of endpoints.

Instance-level headers eliminate that overhead.

Define a header once at the instance level and it’s automatically sent with all/selected endpoints, independent of authentication. You can also enable the “Enable for Reachability Tests” option for a header. This ensures it’s included in the very first “base path” check (for example https://api.example.com)—before any endpoint or authentication is used. This is helpful when infrastructure such as load balancers requires a specific header to respond correctly.


Open your browser and visit: https://<your-tenant>.apisecapps.com


Add Header

  • From the Applications window, click on the See More.

Click See More

  • Click on the App Config

Click See More

  • From the drop down list select the Manage Headers option

Click See More

  • From the Applications window, click on the Add Headers.

Click See More

  • Add Header, value and select Enable for Reachability to "Yes"

Click See More

  • select any one or more endpoints from the dropdown

Click See More

  • Click on save headers

Click See More

  • The new headers now appears in the headers list.

Click See More

  • Search the added endpoint in endpoint search field

Click See More

  • Click on added endpoint from the search result will go to endpoint details

Click See More

  • You will find the created header in the endpoint details

Click See More

  • Click on Edit instance icon view the create header

Click See More

  • You will find the created header if Enable for reachability is yes in the edit instance list

Click See More


Edit header

Open your browser and visit: https://<your-tenant>.apisecapps.com

  • From the Applications window, click on the See More.

Click See More

  • Click on the App Config

Click See More

  • From the drop down list select the Manage Headers option

Click See More

  • Now you will see list of headers.

    Manage headers

  • Click on the Pencil icon from desired header from the list to edit.

Manage headers

  • Now you will see the header form with all the details.

Manage headers

  • You can change the Display Name and Role for the selected header and click on the Update header button.

Manage headers


Delete header

Open your browser and visit: https://<your-tenant>.apisecapps.com

  • From the Applications window, click on the See More.

Click See More

  • Click on the App Config

Click See More

  • From the drop down list select the Manage Headers option

Click See More

  • Now you will see list of headers.

    Click See More

  • Click on the Delete icon from desired header from the list to delete.

Click See More

  • This will take more confirmation

    Click See More

note

user role with View permissions can not add,edit and delete headers in shared application.