What are APIs and how to add API Endpoints

What are APIs and how to add API Endpoints

What is an API Endpoint?

API endpoints are the points through which APIs (Application Programming Interface) communicate with the site visitors. These usually involve requests to and from the site visitors and can contain malicious content if not properly filtered.

This setting can be found under the "API Security" tab in the settings section of your site. With it, you will be able to add various API Endpoints to your site. This will allow Polaris to protect them from malicious attackers.

Adding your API Endpoints

This setting can be found under the API Security tab in your website settings.

To access "Settings", click the drop-down menu on the selected site: 

Under 'SITES', select your domain and click on 'Settings'.
On the horizontal menu bar, click 'API Security'.

To add a new endpoint, click the blue Add Endpoint button. This will expand the interface and allow you to type in the relevant information. There are three fields:
  1. API Host: Your site name
  2. Prefix: Already filled in with "/", cannot be edited
  3. Specification: Please enter your API's OpenAPI 3.0 Specification. This would usually be found in your API's FAQ/knowledge base

You are also allowed to import your specifications. This can only be done with YAML files.
Once you have filled in or imported all the fields, please click the Save button to add your API Endpoint.

Once the Endpoint has been added, incoming requests to the endpoint will be filtered to ensure that only those with correct query or response formats will be allowed through.

At any time you are able to enable or disable this protection via the slider on the Enabled column. You are also able to edit with the pen button on the Actions column and remove the Endpoint with the bin button.

It is recommended that you update this section whenever you add a new API to your site and enable protection for all APIs.

    • Related Articles

    • API Security

      Why are APIs Important? ​ API endpoints are the points through which APIs (Application Programming Interface) communicate with site visitors. APIs serve as the connections between different platforms and systems, allowing them to share information ...
    • 3. Zero Trust Access (ZTA) - Add Groups

      GENERAL Creating Groups allows you to sort your users so that you don't have to individually add them to applications and can instead add them by roles or departments.  All your groups will be shown under the Groups menu under Zero Trust Access. This ...
    • 5. Zero Trust Access (ZTA) - Add Applications

      GENERAL When utilizing Polaris' Zero Trust Access features, any added applications will be located under the Zero Trust Access tab under your organization.  ADD A NEW APPLICATION Prerequisite Have at least 1 Provider and 1 Group  Click Add ...
    • 2. Zero Trust Access (ZTA) - Add Providers (SSO)

      General Providers are 3rd parties that have authentication and authorization services such as Google or Microsoft. Most all organization emails belong to these 3rd parties so we can utilize those already existing logins for any applications that you ...
    • Service Monitor

      Polaris allows you to monitor your resources and ensure that key resources are always available and accessible at all times. This function is compatible with any resource that can be accessed through a URL and is highly customizable to suit your ...