Insites Docs Instance APIAPI EndpointsCreating an API Endpoint

Creating an API Endpoint

Last updated on August 14, 2025.

To add an API endpoint:

  1. Navigate to API from the main menu.
  2. Select API Endpoints.
  3. Select CREATE API ENDPOINT.
  4. Fill out the forms across the following tabs sequentially:
    • Details
    • Body
    • Security
    Select NEXT when you are done filling out a form. Input requirements and descriptions are discussed in a corresponding section in this article
  5. Select CREATE API ENDPOINT.

Details

Use this tab to provide the basic details of your API endpoint.

Input Label Type Required Description
API Endpoint Name Input Field Yes Name of your endpoint.
Slug Input Field Yes Slug assigned to the endpoint.
File Path Input Field Yes File path generated for the endpoint.
Request Method Dropdown Field Yes Request method used by the endpoint. The following options are available:
  • GET
  • PUT
  • POST
  • PATCH
  • DELETE
Redirect to Input Field No Slug to which API users are redirected.
Redirect Code Dropdown Field No Redirect code used by the endpoint. The following options are available:
  • 301 - Moved Permanently
  • 302 - Moved Temporarily

Body

Use this tab to provide the content of your API endpoint.

Input Label Type Required Description
Body Code Editor Yes The main content of your endpoint.

Security

Use this tab to configure the security settings of your API endpoint.

Input Label Type Required Description
Security Type Radio Group No The type of security used by your endpoint. The following options are available:
  • None
  • API Keys
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.