Authentication

Authentication serves as a critical security measure for any REST API. It verifies the legitimacy of requests, ensuring that only authorized users and applications can access and manipulate data. This approach protects sensitive information within the API from unauthorized access or modification.

Our API necessitates authentication for every request you submit. This ensures that all interactions with the API are traceable and accountable, fostering a secure environment for data processing. The API employs an API key-based authentication mechanism. Each API key functions as a unique identifier associated with your account. To authenticate your requests, you must include this API key within the x-api-key header of every API call. You can obtain a valid API key through a paid subscription plan.

Benefits of API Key Authentication

Implementing API key-based authentication offers several advantages:

• Enhanced Security: API keys restrict access to authorized users and applications, minimizing the risk of unauthorized data breaches.
• Improved Accountability: Each API request can be linked back to the corresponding API key, enabling efficient tracking and auditing of API usage.
• Optimized Resource Management: API keys can be used to establish rate limiting mechanisms, preventing excessive API calls that could negatively impact performance.

By adhering to these authentication guidelines, you contribute to a secure and well-managed API ecosystem, ensuring the integrity of data and optimizing the overall API experience for all users.

Example: Authenticated request

The following example demonstrates how to make a GET request to the / endpoint using the curl command, incorporating the required x-api-key header for authentication:

curl "https://api.vigil.sh/" \
  -H 'x-api-key: {api-key}'

Important Note: While the provided example serves as a helpful reference for structure, the actual endpoint may differ. Please refer to the official API documentation for the correct endpoint URL. You need to replace {api-key} with your actual API key obtained through your active subscription. All values within {curly-braces} shown in documentation and examples need to be replaced with real values.

Obtaining a Valid API Key

Valid API keys are exclusively available through paid subscription plans. The specific subscription tier you choose will determine the functionalities and usage limits associated with your API key.