API Reference
The agent metrics API and the console REST API, with curl examples.
- AuthenticationAuthenticate to the agent metrics API with a Bearer osk_ key, or to the console REST API with the pl_session session cookie from login.
- EndpointsEvery verified endpoint on the OpenShield agent metrics API and the XDP.NETWORK console REST API, with curl examples for common tasks.
- WebhooksReceive attack events from the OpenShield agent's alerter and ticket notifications from the console, and verify delivery from the metrics payload.
- Rate limitsThe verified rate limits on the console auth endpoints, what a 429 response looks like, and how fast to poll the agent metrics API.
- ErrorsThe JSON error envelope, the status codes the agent and console APIs return with real example messages, and agent-specific failures.
- Request signingHow to sign console API requests with an API key: the XDP1 scheme — HMAC-SHA256 over timestamp, method, path and body, with a 5-minute freshness window and replay protection.