Creating Endpoints

This guide will walk you through the process of creating an endpoint using the provided interface. Endpoints are essential for integrating specific functionalities into your workflows, such as scanning files or triggering automated processes.

Steps to Create an Endpoint

1. Access the Create Endpoint Page

Navigate to the Create Endpoint page from the dashboard by clicking on Endpoints > Create .

2. Fill Out Endpoint Details

a. Endpoint Name

• Enter a unique and descriptive name for your endpoint.
• This name will help you identify the endpoint in your system.

b. Location

• Select the geographical location for your endpoint from the dropdown menu.
• Choose from multiple hosting providers and regions (e.g., EU - Hetzner , US - AWS ).
• The location affects latency and data residency requirements.
• Consider selecting a location closest to your primary user base for optimal performance.

c. Credentials

• Choose the credentials you wish to associate with this endpoint.
• Select from the list of available credentials (e.g., AWS Access Key #1 ).
• Click the + button to add new credentials if necessary.

d. Scan Engines

• Specify the scan engines to be used by the endpoint.

  Examples of scan engines:

  • clamav (for antivirus scans)
  • nsfw_image (for detecting inappropriate content)
• You can select one or more scan engines.

e .NSFW Threshold

• When using the nsfw_image scan engine, adjust the confidence threshold using the slider.
• The threshold is expressed as a percentage (0-93%).
• Lower values increase detection sensitivity but may lead to more false positives.
• Higher values make the detection more conservative but might miss borderline content.
• The system will flag content as NSFW only when confidence exceeds your chosen threshold.

f. Callback URL

• This is an optional step.
• Enter the URL where you want to receive notifications or results.
• Callback URLs are recommended when using the Async mode.

g. Async

• Choose whether the endpoint will operate in asynchronous mode.
• When selected, operations will execute in the background, and results will be sent to the specified callback URL.

h. Description

• Provide an optional description of the endpoint to document its purpose or use case.