Tagged “guides”

Explains how the Admin API Authorization Filter secures endpoints by validating request paths, checking roles, and enforcing platform operator and data

Describes CSRF protection for the admin API. State-changing requests to /admin/ must include the X-Requested-With header to prevent cross-site attacks.

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

Explains how the Admin API's IdentityResolver component determines a caller's identity from tokens, headers, and request attributes in a strict order.

Documents the servlet filter that adds the X-S2R-License header and a customer_id MDC key to all Admin API requests for license tracking.

Technical reference for the Admin API control plane. Use these endpoints to import WSDLs, manage services, configure backends, and monitor performance.

Query aggregated API performance metrics and generate SLO reports. Monitor request counts, error rates, latency percentiles, and availability against

Discovers and synchronizes APIs and services from a Perforce Akana API Platform instance. Explains the discovery workflow, data mapping, and configuration.

Technical documentation on integrating legacy API gateways (Layer7, webMethods, Akana, Mashery, OAG) for API discovery and traffic log ingestion.

Explains the publish readiness assessment for an API version. Details the checks, statuses, and suggested actions to resolve issues before activation.

A health indicator that verifies Row-Level Security (RLS) is active for the application role in SaaS mode, reporting DOWN if RLS is inactive or

Apply an envelope wrap override to a specific API operation. This service updates the configuration for an operation if its service version is in a draft

Manages the persistent state of asynchronous API executions, including creation, status tracking, polling security, and finalization via callbacks.

Describes the repository for writing audit events to the s2r_audit_event table, including tenancy model, event structure, and secret redaction.

Learn how all platform configuration changes are recorded as audit events. Query the audit trail to see who changed what, when, and the before/after state.

Automatically discover and inventory your entire SOAP service estate by analyzing live traffic from your API gateway. See which services are active, their

Explains the automatic, one-time migration process that encrypts plaintext F5 and DataPower connector credentials in the database at application startup.

Describes the KnownChecksumVariantHealer, which automatically repairs specific database migration checksum mismatches to prevent application startup

Describes the automatic license acquisition service, which polls for and installs a license on an unlicensed deployment, automating the manual upload

Describes the client that automatically fetches an assigned license from the central platform for an unlicensed deployment, eliminating manual license

Explains the logic for matching a request's dialed endpoint against a backend profile's configured endpoint to authorize credential forwarding.

Learn how to back up and restore the platform's configuration and state. Covers PostgreSQL backups, credential key management, and recovery procedures.

Configure how boolean values are represented in API requests and responses. Set operation-level and per-field overrides for boolean-to-integer or

Technical reference for the immutable, hardcoded endpoint hosts the product uses for outbound calls to the central control plane for licensing, updates

Describes the configuration for pulling centralized platform settings, including data residency enforcement and behavior in SaaS vs. self-hosted

Configure backend endpoint URLs, authentication, timeouts, retries, and failover for services. Supports SOAP and REST backends with multiple auth types.

Set a JSON field ordering override for a specific API operation. This determines how fields are ordered in the response body for that operation.

Set how much detail from a backend SOAP fault is exposed in the REST response for a specific API operation. Configure 'safe' or 'full' exposure levels.

Use the Consume direction to create a SOAP facade for a modern REST backend. This allows legacy SOAP clients to continue working without modification.

Defines the core concepts and vocabulary for the API transformation platform, including services, operations, mappings, discovery, and connectors.

Prevents stored secrets from being sent to a different destination. Enforces that any change to a credential's target endpoint or user requires re-entry

Explains how the platform uses pgcrypto for symmetric AES-256 encryption of backend profile credentials. Covers configuration, data flow, and the storage

Describes the IngestXmlErrorHandler, which replaces the default JAXP handler to prevent log flooding and securely log XML parsing errors from untrusted

A guide for daily operational tasks, including monitoring dashboards, checking ingest health, updating service catalogs, and managing system settings.

Explains the logic for granting access to deployment-wide data, such as tables without tenant columns. Access is granted to the platform tenant or in

Explains the diagnostic telemetry collector, which gathers non-sensitive, numeric system health metrics for heartbeats and debug bundles.

Defines required firewall egress rules for the product. Lists all outbound hosts, ports, and protocols, and details exactly what metadata is sent.

The F5 Managed iRule Reconciler is a background process that automatically updates managed iRules on F5 BIG-IP appliances to match the running product

Describes the scheduled service for automatically importing WSDLs from F5 BIG-IP instances, including its configuration, execution flow, and concurrency

Configure per-field exceptions to the default SOAP-to-REST conversion rules. Override date/time formats, numeric handling, casing, and more for specific

Learn how the platform generates OpenAPI v3 specifications for Publish services. See how conversion options shape the schema and how to review and consume

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

Describes how the platform generates new services, REST operations, and backend profiles from imported WSDL artifacts, including automatic route inference

A guide to getting started with the SOAP-2-REST platform, from core concepts and system requirements to a quickstart for publishing your first service.

Documentation for the global exception handler, which provides a consistent, structured error response for all unhandled exceptions in the runtime service.

Discover and synchronize API services from an IBM DataPower Gateway using its REST Management Interface. Learn how the discovery process works and what

Explains how the IdP authentication filter validates Bearer tokens from OIDC providers like Azure AD, Okta, and Keycloak for API access.

Learn how to import a WSDL by file, URL, or pasted XML to automatically generate a draft REST API, including backend settings and sample payloads.

Deploy the platform to Google Cloud using a native topology with Cloud Run, Cloud SQL for PostgreSQL with IAM DB auth, Cloud Storage, and Cloud IAP.

Explains how the Install Profile Filter gates access to F5-specific API endpoints based on the system's installation profile. Details the mechanism and

Install the complete SOAP-2-REST platform on VMware or Hyper-V using a self-contained OVA or VHDX virtual machine appliance for air-gapped environments.

An overview of the SOAP-2-REST platform's architecture and supported deployment topologies, including Docker Compose, Kubernetes/Helm, and GCP-native.

Specaria S2R is a bidirectional SOAP-to-REST and REST-to-SOAP conversion platform that runs in your VPC to bridge legacy SOAP services and modern REST

Learn how real request/response pairs from production traffic are captured and curated into learned examples for service onboarding and mapping validation.

Explains how the platform measures usage against the two license capacity caps: discovered services (monotonic) and converted/active services (decaying).

Explains how the license enforcement state is evaluated, persisted, and used by the data plane, including configuration and troubleshooting.

Describes how the platform verifies entitlement using signed JWT licenses, fetches public keys from a JWKS endpoint, and handles periodic re-verification.

Periodically refreshes the Master Discovery materialized view from observed traffic for F5 and generic API gateways to ensure API discovery data is

Learn about the network architecture of the API platform. The product runs entirely within your network, has no public endpoints, and only sends minimal

An overview of the built-in observability features, including dashboards, metrics, SLOs, logs, tracing, and audit trails. Learn how data is aggregated for

Explains how the platform handles transient network failures when contacting the licensing service, including the offline grace period and staged degraded

Monitor the health of your API conversion estate. View request volume, error rates, latency, and other key performance indicators with drill-down

Describes how operator authentication works via an Identity-Aware Proxy (IAP), which forwards identity from providers like Google, Azure AD, OIDC, or SAML.

Technical documentation on the payload size limiting filter, which rejects HTTP requests with bodies larger than the configured maximum size.

Configure per-operation overrides for date/time formatting, time zones, and null value representation. Learn how to apply and validate these settings.

An overview of the platform's security design principles, including in-VPC data residency, role-based access control (RBAC), and encrypted credentials.

Technical documentation for the platform's update service, which manages update channels, automatic installations, and operator-approved updates via a

Describes pristine and protected authentication modes. Explains the race-safe, single-shot pro<customer>ion of the first user to admin on a new install.

Explore the available support tiers for the platform, including Trial, Community, and Paid options. Understand the support model and response targets for

Learn how to publish services, understand readiness checks, and manage immutable mapping versions. This guide covers activation, rollback, and handling

A step-by-step guide to deploy the standalone Docker Compose stack, import a WSDL, configure a backend, and publish a REST facade over a SOAP service.

Explains the automated service for archiving raw logs to object storage, pruning old data from the database, and managing data retention policies.

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

Configure validation to be off, in a non-enforcing preview mode (shadow/monitor), or to enforce contract compliance for requests and responses.

Explains the three user roles (admin, operator, reader) and how they are assigned to control access to the platform's admin API endpoints.

Understand and query structured runtime logs and full payload traces. Learn to search logs by correlation ID, result code, and other filters to debug API

Explains how the API runtime resolves incoming requests to configured routes and backend targets by querying the route repository.

Explains how the runtime component checks a cached database flag to determine if SaaS capabilities are enabled. This flag is written by the admin-api

Explains how the SaaS tenant resolver identifies and authenticates tenants for inbound API requests using a tenant slug and a dedicated API key.

Understand the required deployment order for the admin-api, runtime, and worker services to ensure database schema compatibility during deploys and

Learn the no-code process for onboarding SOAP and REST services. Covers Publish (REST facade), Consume (SOAP facade), and SOAP Broker directions.

Reference for supported SOAP versions, WSDL message styles, and XSD types for the SOAP-to-REST conversion engine, including fault handling and nullability.

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

Explains the consume data path handler, which transforms inbound SOAP requests into outbound REST calls, validates payloads, and maps REST responses back

A runbook for operating the SOAP-2-REST platform in production, covering deployment, daily checks, troubleshooting, and backup and restore procedures.

Learn the standard procedure for safely upgrading the SOAP-2-REST platform, including the order of operations, rollback steps, and zero-downtime

Answers to common technical questions about the SOAP-2-REST platform, covering product model, SOAP/XSD support, deployment, security, and troubleshooting.

Find release notes, versioning policies, and upgrade guides for SOAP-2-REST. This is the canonical record of all product releases.

Explains the deterministic, full-field mapping engine that converts between SOAP/XML and REST/JSON. Covers request/response mapping, faults, and generated

A complete reference for SOAP-to-REST conversion options. Control data types, field naming, error shapes, and validation with system, service, operation

Technical overview of the SOAP-to-REST conversion platform, covering its architecture, components, configuration, and operational behavior on Google Cloud

Provides a single, aggregated snapshot of system component health, including database connectivity, service status, and recent operational incidents.

Lists the required PostgreSQL database, container runtime, network access, and resource baselines for deploying the SOAP-2-REST platform.

Explains how the platform authenticates API requests using tenant-specific API keys in a multi-tenant environment, detailing the lookup and usage tracking

Explains how the platform handles requests missing tenant context, resulting in a 401 Unauthorized error with code S2R-AUTH-0401.

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

Describes the internal service that seeds the first administrator for a new SaaS tenant, ensuring tenant isolation and idempotent operation.

An in-process, short-TTL cache for multi-tenant systems. Caches values on a per-tenant basis, preventing data leakage between tenants.

Describes the scheduled service that calculates peak concurrent API calls from raw traffic logs and stores hourly aggregates for capacity analysis.

A symptom-first guide to troubleshooting common operational issues like large payloads, backend timeouts, credential errors, and ingest failures.

Explains the SPECARIA-MTLS-0001 error, a 401 response from the platform indicating a missing or invalid product client certificate during license-related

Manages persistence for software update checks and installation history. Tracks available updates, apply attempts, and notification status for each

Explains how the worker service decrypts backend profile credentials using the S2R_CREDENTIAL_KEY and pgcrypto for synthetic monitoring.

Automate the creation of REST services from WSDL files. The zero-touch autopilot imports, generates services and operations, and creates full-field