Skip to main content

API Overview

The CyberSecFeed API provides comprehensive vulnerability intelligence through a RESTful interface.

Base URL​

All API requests should be made to:

https://api.cybersecfeed.com

API Version​

The current API version is v1.3. All endpoints are prefixed with /api/v1/.

Authentication​

All API requests require authentication using an API key provided in the request headers.

Required Header​

X-API-Key: your-api-key-here

Example Request with Authentication​

curl -H "X-API-Key: your-api-key-here" \
     https://api.cybersecfeed.com/api/v1/ping

Requests without a valid API key will receive a 401 Unauthorized response.

Response Format​

All API responses follow a consistent JSON structure:

{
	"data": {
		// Response data specific to the endpoint
	},
	"meta": {
		"timestamp": "2024-01-25T12:00:00Z",
		"version": "v1",
		"correlationId": "unique-request-id"
	}
}

Success Responses​

Success responses will have HTTP status codes in the 2xx range and include the requested data in the data field.

Error Responses​

Error responses will have appropriate HTTP status codes (4xx or 5xx) and include error details:

{
	"error": {
		"code": "ERROR_CODE",
		"message": "Human-readable error message",
		"details": {
			// Additional error context
		}
	},
	"meta": {
		"timestamp": "2024-01-25T12:00:00Z",
		"version": "v1",
		"correlationId": "req-12345"
	}
}

Content Type​

All requests and responses use JSON format. Include the following header in your requests:

Content-Type: application/json

HTTP Methods​

The API uses standard HTTP methods:

  • GET: Retrieve data
  • POST: Not currently used
  • PUT: Not currently used
  • DELETE: Not currently used

Compression​

Responses are automatically compressed using gzip when supported by the client. Include the following header to enable compression:

Accept-Encoding: gzip

CORS Support​

The API supports Cross-Origin Resource Sharing (CORS) for browser-based applications. Allowed origins must be configured in your account settings.