Key Features

• Comprehensive Metadata Extraction: Extract detailed file metadata, including timestamps, file signatures, embedded data, and more. This information is crucial for forensic analysis and security assessments.
• Security Risk Identification: Identify potential security risks, such as malicious code, suspicious file attributes, or anomalies that could indicate a compromised file.
• Multi-File Type Support: The API supports a wide range of file types, including documents (PDF, DOCX), images (JPEG, PNG), executables (EXE, DLL), and archives (ZIP, RAR).
• Real-Time Analysis: Perform real-time analysis of uploaded files and receive instant feedback in the form of structured metadata reports.
• Secure Authentication: All API requests are authenticated using API keys, ensuring that only authorized users can access the service.

Getting Started

To begin using the CysecInnovation Cybersecurity Metadata API, follow these steps:

• Sign Up or Log In: Create an account or log in to your existing account to retrieve your unique API keys.
• Authenticate Requests: Include your API key in the headers of every request to authenticate and authorize your API calls.
• Upload a File: Use the provided API endpoint to upload a file for analysis. The API accepts files up to a specified size limit (e.g., 100MB).
• Receive Metadata: Once the file is processed, you will receive a structured JSON response containing detailed metadata and security insights.

Authentication

All requests to the API must include an API key for authentication. The API key should be passed in the request headers as follows:

{ "x-api-key": "YOUR_API_KEY","x-app-username":"YOUR-API_USERNAME" }

Note: Keep your API keys secure and do not share them publicly. If your API key is compromised, you can regenerate it from your account dashboard.

API Endpoints

The primary endpoint for uploading files and retrieving metadata is:

{ "POST": "/file/file-metadata" }

Request Parameters:

• file: The file to be uploaded (required).
• apiKey: Your API key for authentication (required).

Response Example:

{ "filename": "example.pdf", "size": "2MB", "created_at": "2025-01-01T10:00:00Z" }

The response includes metadata such as file type, size, creation date, modification date, and any identified security risks.

Rate Limits

To ensure fair usage and maintain optimal performance, the API enforces rate limits. By default, each API key is allowed:

• 50 requests per minute: If you exceed this limit, you will receive a 429 Too Many Requests response.

If you require higher rate limits for your use case, please contact our support team to discuss upgrading your plan.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of a request. Below are some common errors you may encounter:

{ "error": "Invalid API key" }

Tips for Debugging:

• Ensure your API key is valid and included in the request headers.
• Verify that the file you are uploading meets the size and type requirements.
• Check the rate limits to ensure you are not exceeding the allowed number of requests.