Skip to main content

Protocol Server Service API

The Protocol Server Service provides multi-protocol mock support beyond HTTP/REST.

Base URL (local): http://localhost:3008 Swagger UI: http://localhost:3008/api/docs

Endpoints​

TagDescription
protocol-configsProtocol configuration management
protocol-healthProtocol server health checks

Supported Protocols​

SureStage supports 30 protocol types organized into 8 groups:

File & Directory Protocols​

  • SMB (Server Message Block)
  • SFTP (SSH File Transfer Protocol)
  • S3 (Amazon S3-compatible object storage)
  • LDAP (Lightweight Directory Access Protocol)
  • JDBC (Java Database Connectivity)

Document Stores​

  • MongoDB
  • DynamoDB
  • Elasticsearch
  • VectorDB (vector similarity search)

Message Brokers​

  • Kafka
  • MQTT
  • AMQP (RabbitMQ-compatible)
  • SQS/SNS (Amazon queue and notification)

Identity & Authorization​

  • OAuth2
  • SAML (Security Assertion Markup Language)
  • SCIM 2.0 (System for Cross-domain Identity Management)

Schema-Driven APIs​

  • GraphQL
  • gRPC (with Protocol Buffers)
  • SOAP (with WSDL)
  • Thrift (Apache Thrift)

Streaming Protocols​

  • WebSocket
  • SSE (Server-Sent Events)

Infrastructure Protocols​

  • SMTP (email)
  • Redis
  • Syslog
  • StatsD/Prometheus (metrics)
  • OTLP (OpenTelemetry)
  • OPA (Open Policy Agent)

Agent & Webhook Protocols​

  • A2A (Agent-to-Agent)
  • ACP (Agent Communication Protocol)
  • Webhooks

Mock Definition Management​

Each protocol instance has a mock definition — a structured JSON object that configures the protocol server's behavior. Mock definitions can be managed via:

  • Visual editors in the web application (30 protocol-specific editors)
  • AI generation via the AI Mock Definition Generator
  • Direct JSON editing in the web application
  • API via PUT /protocol-configs/:id/definition
OpenAPI Spec

Auto-generated API docs from the OpenAPI spec will populate this section. Access the interactive Swagger UI at localhost:3008/api/docs.