API Documentation

Welcome to the API documentation for services hosted at api.cameronmichelis.com. Below are the available API endpoints, their functionality, and the authentication requirements. If you’re interested in accessing a protected APIs, feel free to contact me to request an API key.

Public Endpoints (No Authentication Required) Link to heading

1. GET /v1/echo Link to heading

https://api.cameronmichelis.com/v1/echo

Description: The Echo service risk scores the request details sent by the client, including the HTTP method, headers, query parameters, and body (if present). This is useful for testing and debugging API requests.

Endpoint:
GET /v1/echo

Request Example: curl -X GET "https://api.cameronmichelis.com/v1/echo?param=value"

2. GET /v1/status Link to heading

https://api.cameronmichelis.com/v1/status

Description: Returns the current status of the API services, including uptime and the operational state of the security, geolocation, and MISP services.

Endpoint: GET /v1/status

Request Example: curl -X GET "https://api.cameronmichelis.com/v1/status"

Protected Endpoints (Authentication Required) Link to heading

3. GET /v1/geolocation Link to heading

Description: Provides geolocation data based on an IP address.

4. GET /v1/misp/threat-intelligence Link to heading

Description: Fetches threat intelligence data from the MISP platform, including information on IOCs (Indicators of Compromise).

5. POST /v1/misp/iocs Link to heading

Description: Submits a new Indicator of Compromise (IOC) to the MISP platform. This service requires authentication via an API key.

6. GET /v1/misp/events Link to heading

Description: Allows searching for events in the MISP platform using query parameters. This service requires authentication via an API key.

7. POST /v1/misp/sync Link to heading

Description: Initiates synchronization of threat intelligence data between MISP instances. This service requires authentication via an API key.