SOAP-to-REST documentation

The complete technical documentation for the SOAP-2-REST platform, covering installation, configuration, API usage, operations, and core concepts.

An overview of the Getting Started documentation, guiding new users through the platform's model, concepts, requirements, and a quickstart tutorial.

An overview of SOAP-2-REST (S2R), a platform that converts between SOAP and REST to bridge legacy and modern services within your own VPC.

An overview of supported deployment topologies for the SOAP-2-REST platform, including Docker, Kubernetes, and cloud-native options, and its core service

Learn the no-code process for onboarding services, creating REST facades for SOAP backends (Publish) or SOAP facades for REST backends (Consume).

Explains how the platform automatically builds a service inventory from live traffic, including data sources, aggregation, and consumer attribution.

Explains the deterministic, full-field mapping model for converting between REST/JSON and SOAP, including request/response mapping and fault normalization.

An overview of the operational model for the API platform, including its four main services, core principles, capacity baseline, and common failure modes.

Learn how the API platform's built-in observability works. Covers dashboards, metrics, logs, and audit trails, all powered by pre-computed aggregations.

An overview of the platform's security principles, including in-VPC deployment, role-based access control (RBAC), credential encryption, and audit logging.

Explains how product entitlement works via signed licenses, capacity caps, online verification against platform keys, and offline grace periods.

Learn how to get support for the SOAP-2-REST platform, including self-service diagnostics, how to open a ticket, and what information to include.

Describes the main application class for the Admin API service, which integrates cloud provider adapters and database health monitoring.

Generates example string values that satisfy schema constraints such as pattern, minLength, and maxLength. Ensures API examples are valid against their

Describes the mechanism for extracting a service identity ({namespace}LocalName) from a SOAP request body or bare XML payload for service attribution.

Understand the core concepts of the API platform, including services, operations, mappings, and the Publish/Consume model for SOAP-to-REST transformation.

Deploy the standalone Docker Compose stack, import a WSDL, configure a SOAP backend, and publish a versioned REST API with a generated OpenAPI v3 spec.

Lists the required database, container runtime, network, and resource specifications for deploying and operating the SOAP-to-REST platform.

Deploy the platform on Google Cloud using managed services: Cloud Run, Cloud SQL for PostgreSQL with IAM DB auth, Cloud Storage, and Cloud IAP for

Install the platform on Red Hat OpenShift Container Platform (OCP) using the standard Helm chart, native Routes, and the default restricted-v2 SCC.

Deploy the full API platform on a single host using Docker Compose. This guide covers configuration, image building, and external database integration.

Install the platform on a Kubernetes or OpenShift cluster using the provided Helm chart. This guide covers prerequisites, configuration, and high

Install the SOAP-2-REST platform as a self-contained VM appliance (OVA/VHDX) for VMware or Hyper-V. Ideal for air-gapped or VM-only environments.

A comprehensive reference for deploy-time environment variables and in-app settings for the S2R platform, covering database, identity, and cloud providers.

Use the SOAP Broker direction to gain observability and access control for existing SOAP services without modifying the contract or message payload.

Learn how the Consume direction acts as a SOAP facade, converting inbound SOAP requests to REST for migrated backends while preserving legacy client

Learn how the platform generates an OpenAPI v3 specification for Publish services at publish time, reflecting conversion options and WSDL fault contracts.

Learn how to import a WSDL contract by file, URL, or pasted XML to generate a draft REST API. Covers parsed elements, inferred settings, and change

Use the zero-touch autopilot to automatically import a WSDL, create a draft service, generate operations, and create full-field mappings in one step.

Learn about the publish readiness gate for services, which checks operation mappings and backend connectivity. Understand how immutable mapping versions

Explains how the platform captures real request/response pairs from live traffic to create learned examples for service onboarding and mapping validation.

Integrate with CA Layer7, Software AG webMethods, Perforce Akana, TIBCO Mashery, and Oracle API Gateway for automated API discovery and traffic ingestion.

Ingest traffic logs from any HTTP-capable gateway or load balancer using a generic REST endpoint. Learn the JSON envelope format and how to send data.

Configure validation to enforce API contracts. Use shadow/monitor modes to preview and log potential rejections before enabling enforcement on requests or

A complete reference for all SOAP-to-REST conversion options, their modes, defaults, and resolution hierarchy for precise data transformation.

Configure exceptions to default SOAP-to-REST data conversion rules. Override date/time, numeric, boolean, null, and other formats for specific fields.

A deep reference on supported SOAP versions (1.1, 1.2), WSDL styles (document/literal, rpc/literal), XSD types, faults, namespaces, and nullability.

A symptom-first guide to diagnosing and resolving common platform errors, including timeouts, deployment failures, data ingest issues, and more.

Learn how to back up and restore platform configuration and state. The PostgreSQL database is the single source of truth for disaster recovery.

A guide for daily operational tasks, including monitoring the operations dashboard, checking ingest health, updating service catalogs, and managing

A runbook for deploying and upgrading the platform's services, covering deployment order, verification, release cadence, and rollback procedures.

Learn how the platform records all configuration changes as audit events. Query the audit trail via API to see who changed what, when, and from what to

Monitor API health with dashboards for request volume, error rate, and latency. Drill down from estate-wide views to individual services and operations.

Learn to use structured logs, payload traces, and correlation IDs to debug runtime requests. Search logs, analyze errors, and track asynchronous

Query aggregated API metrics and generate SLO reports for availability and latency. Learn about the available metrics, filters, and SLO targets.

Explains how the platform authenticates operators using an Identity-Aware Proxy (IAP) with OIDC or SAML, and the trusted headers it uses to establish

Explains how backend credentials for SOAP services are encrypted at rest using AES-256 and pgcrypto. Covers key management, data handling, and API

Describes the product's network architecture, including its in-VPC deployment, internal-only ingress, private database connectivity, and outbound traffic.

Explains the RBAC model for the control plane, including available roles, role resolution logic, and how to manage role bindings via the Admin API.

Details the platform's data retention policies, default periods, and configuration for runtime logs, audit trails, metrics, and raw traffic.

Defines required firewall egress rules for the product. Lists all outbound hosts, ports, and a strict manifest of what data is and is not sent.

Explains how the platform behaves during network outages, including the 14-day offline grace period, read-only degraded mode, and recovery steps.

Learn the standard procedure for upgrading the SOAP-2-REST platform, including the order of component deployment, rollback strategies, and schema

Learn about the support lifecycle for product releases and the policy for deprecating APIs, configuration, and other platform contracts to plan upgrades.

Technical reference for the Runtime API, the live data plane for SOAP-to-REST and REST-to-SOAP conversions. Details endpoints, headers, and errors.

Find answers to common questions about deployment, SOAP/XSD support, security, data residency, and troubleshooting for the SOAP-to-REST platform.

Learn about the available support tiers, from free community and trial options to paid plans with dedicated support and service-level agreements (SLAs).

Configure the Admin API's primary database connection, including authentication (IAM or password), pooling, timeouts, and SSL settings.

Learn how the RegexExampleGenerator creates representative example strings from XSD patterns, handling length constraints and common regex constructs.

Describes the automated F5 iRule reconciler, which keeps managed iRules on gateway appliances synchronized with the current product version to prevent

Explains how the Tenant Context Filter identifies the tenant for each API request, populates a security context, and handles authentication failures.

Configure the worker service's database connection pool, including IAM and password authentication modes, pool sizing, and socket resilience settings.

Detailed reference for the Admin API, the control plane for managing services, WSDL imports, mappings, backends, and observability in the SOAP-to-REST

A complete reference for all S2R error codes returned by the SOAP-2-REST Admin and Runtime APIs. Learn the error format, subsystems, and code meanings.

API endpoints for detailed analysis of aggregated service discovery data, including traffic timelines, consumers, failures, and alert configuration.

Proxies test execution requests to the runtime environment. Mints a short-lived JWT for authentication and records successful runs for readiness checks.

Import, repair, and manage WSDL documents via API. Use file uploads, URLs, or raw XML to create service drafts and automate SOAP API onboarding.

Configure database connection pools for the Admin API, including IAM and password authentication, and separate pools for application and migration tasks.

Documents the LicenseWatermarkFilter, which adds the X-S2R-License header and a customer_id log context value to Admin API requests.

Describes the license heartbeat client, which sends periodic telemetry to the Specaria platform. Details the payload, configuration, and operational

Defines the data structure returned after generating a new API service. Includes service and version IDs, configuration details, and any contract warnings.

Describes the data model for the result of a WSDL replacement draft operation. Includes service/version IDs, operation counts, and contract warnings.

Describes how the platform stores, retrieves, and updates OpenAPI specification artifacts for service versions, detailing the underlying data models and

Manage API operations, including REST endpoints, schemas, and asynchronous behavior. This reference details methods for finding, updating, and

Explains how the Version Repository manages the lifecycle of API service versions, including creation, activation, rollback, and route publishing.

Explains how to generate new API services and replacement drafts from imported WSDL artifacts, including automatic configuration and validation.

Explains how the platform generates import previews for WSDLs, including REST route suggestions, example SOAP/JSON payloads, and complexity analysis.

Explains how stored F5 BIG-IP instance records are mapped to connection settings for discovery services and log forwarding configurations.

Diagnose and regenerate SOAP-to-REST operation mappings. This service provides tools to assess mapping readiness and bulk-update them after WSDL changes.

Describes the aggregation process that collapses fine-grained traffic data into canonical service definitions for Master Discovery.

Describes the automated service that periodically refreshes the master discovery table from observed traffic for F5 and generic API gateways.

Technical reference for the OpenApiService, which generates and stores OpenAPI 3.0 specifications for PUBLISH services based on WSDL and platform

Describes the automated quality analysis service that lints OpenAPI specifications for issues like missing descriptions, naming drift, and invalid

Technical documentation for the Update Channel Service, which manages software update status, channels, and operator-approved updates via a release

Explains the WSDL import round-trip validator, which checks generated examples against their own constraints to prevent runtime validation failures.

Explains the S2R-ADM-0612 error, which occurs when a WSDL's example values fail validation against their own XSD constraints during import.

Explains how the WSDL parser processes WSDL and XSD documents, resolves external references, suggests backend configurations, and handles various SOAP

Configure the runtime service's connection to its PostgreSQL database, including authentication modes (IAM, user/password), timeouts, and SSL settings.

Technical reference for the Runtime service main application entry point. Details standard startup and the native self-check mode for validating data

Technical reference for the SOAP Message Mapper, which transforms JSON to SOAP and SOAP to JSON, with extensive data conversion and WS-Security options.

Configure the worker component's database connection, including authentication modes (IAM, user/password), timeouts, and SSL settings. Reference for all

Describes the SOAP payload parser that extracts and analyzes leaf field values from SOAP requests and responses to detect encoding formats and special

Resolves a canonical service URI for SOAP traffic when the request URL is generic, like '/'. Uses the SOAPAction header or SOAP body to attribute traffic.

Provides stateless helper functions for analyzing SOAP and REST traffic, including backend key generation, payload classification, and operation name

Describes the main entry point for the worker service, which initializes cloud adapters for AWS, GCP, and VMware, and enables externalized configuration.