Back to Dashboard

API Documentation

Complete reference for the PlatPhorm Keys API. All endpoints support JSON and include OpenTelemetry trace headers.

OpenAPI Spec

Authentication

Most endpoints require authentication via Bearer token or X-API-Key header:

Authorization: Bearer your-api-key
or
X-API-Key: your-api-key

Endpoints

POST/api/v1/keys/provisionPublic

Self-service key provisioning (no auth required)

GET/api/v1/keysAuth Required

List all API keys

POST/api/v1/keysAuth Required

Create a new API key

GET/api/v1/keys/{id}Auth Required

Get API key details

DELETE/api/v1/keys/{id}Auth Required

Revoke an API key

GET/api/v1/healthPublic

System health check

GET/api/v1/telemetryPublic

OpenTelemetry metrics and spans

GET/api/docsPublic

OpenAPI 3.0 specification (JSON)

Quick Start

Provision a new API key
No authentication required for initial key creation
curl -X POST https://keys.platphorm.com/api/v1/keys/provision \
  -H "Content-Type: application/json" \
  -d '{"name": "My First Key", "scopes": ["read", "write"]}'

Response Headers

All API responses include OpenTelemetry headers for observability:

X-Request-IdUnique request identifier
X-Trace-IdOpenTelemetry trace ID
X-Client-UUIDYour client identifier
X-FingerprintDevice fingerprint