API Overview

API Overview

SilentPulse provides a REST API for automation and custom integrations.

Base URL

https://your-instance.silentpulse.io/api/v1

Authentication

All API requests require authentication via Bearer token:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://your-instance.silentpulse.io/api/v1/flows

Generate API tokens in Settings → API Tokens.

Common Endpoints

Flows

Method	Endpoint	Description
GET	/flows	List all flows
GET	/flows/:id	Get flow details
POST	/flows	Create a flow
PUT	/flows/:id	Update a flow
DELETE	/flows/:id	Delete a flow

Alerts

Method	Endpoint	Description
GET	/alerts	List alerts (with filters)
GET	/alerts/:id	Get alert details
POST	/alerts/:id/acknowledge	Acknowledge alert
POST	/alerts/:id/resolve	Resolve alert

Assets

Method	Endpoint	Description
GET	/assets	List assets
GET	/assets/:id	Get asset details
GET	/assets/:id/observations	Get asset observations

Response Format

All responses are JSON:

{
  "data": { ... },
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 20
  }
}

Error Handling

Errors return appropriate HTTP status codes:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid flow configuration",
    "details": { ... }
  }
}

Rate Limiting

• 1000 requests per minute per API token
• Rate limit headers included in responses

SDKs

Official SDKs coming soon:

• Python
• Go
• JavaScript/TypeScript