Tagged “reference”

Explains how the Admin API authorization service resolves user roles, determines required permissions for endpoints, and manages special access modes.

Configure database connection pools for the Admin API, including IAM and password authentication, connection hygiene, and row-level security settings.

Technical reference for the Alert Evaluation Service, which monitors service health, evaluates against thresholds, and sends notifications for failures.

Manage individual API operations, including their REST endpoints, execution modes, schemas, and runtime route synchronization. For platform engineers.

Defines the configuration for a single API operation, including SOAP-to-REST mapping, timeout, retries, callback settings, and execution mode.

Apply field name casing overrides for an API operation. Set a default casing mode (e.g., camelCase) and define per-field overrides using SOAP XPath

Replay, reprocess, and manually resolve failed or expired asynchronous API executions. Includes details on previewing changes and forcing completion or

Execute tests against backend SOAP services to validate connectivity, authentication, and request/response transformations. Run individual or bulk tests.

A backend profile defines how the platform connects to an upstream API, including endpoint, authentication, timeouts, and retries. Learn how to manage

Manage and test backend profiles for API services. Includes endpoints for CRUD operations, connectivity tests, application tests, and synthetic monitoring.

Configure per-operation and per-field binary encoding overrides, including modes and data URL MIME types, for API responses in the runtime.

Explains how the system periodically calculates and stores converted and discovered services capacity metrics for licensing and reporting.

Discover and synchronize Citrix NetScaler virtual servers and their backend members into the platform using the NITRO API. Learn how the discovery process

Configure how single-element arrays are handled in SOAP responses for a specific API operation. Set an operation-level override and per-field overrides.

Configure how xsd:duration values are formatted in SOAP responses on a per-operation and per-field basis. Set override modes and field-specific XPath

Explains the Connector Instance Bridge Service, which synchronizes DataPower gateway and cluster records into the generic connector instance table for

A complete reference to all conversion options for transforming SOAP payloads to REST, including data types, field names, error shapes, and validation.

Manage DataPower instance configurations, including connection details, credentials, and auto-scan settings, via the underlying database repository.

Manages and persists the synchronization state for DataPower instances, tracking connection status, scan progress, and scan results in a database.

Manages the persistence of service mappings from DataPower instances. Explains how to create, read, update, and delete service-to-backend mappings.

Manage pinned SSH host key fingerprints for DataPower instances to prevent man-in-the-middle attacks. Learn how to find, pin, and clear keys.

Manages static DNS host entries from DataPower appliances. Stores and retrieves hostname-to-IP mappings for use in traffic enrichment processes.

Explains how the platform generates compressed diagnostic debug bundles containing masked API traffic samples, topology, and telemetry for troubleshooting.

Calculates deployment capacity from cloud provider data and configuration, and compares it to discovered demand from traffic logs to estimate system load.

Provides explicit tenant binding for background tasks like schedulers and startup hooks to prevent unbound tenant errors in a multi-tenant environment.

Manages the lifecycle, health, and configuration of cloud-agnostic relay VMs used for API discovery ingest, including auto-healing and monitoring.

Set a custom error response shape for a specific API operation. This override is configured at the operation level and can only be applied to draft

Explains the automatic F5 catalog snapshot, policy scan, and relay VM warmup process that runs when the Admin API service starts. Details the triggers and

Manages the lifecycle and configuration of F5 BIG-IP instance records, including tenancy, credential encryption, and data validation for the API platform.

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

Manages and persists the synchronization state for F5 BIG-IP instances, including scan results, catalog snapshots, WSDL probes, and traffic relay status.

Provides read-only access to F5 traffic logs for suggesting potential operation mappings. Fetches traffic candidates for a service version within a time

Automatically discovers and imports WSDL-based SOAP services from F5 BIG-IP instances, creating new API services or updating existing auto-discovered

Explains the scheduled background service that aggregates raw F5, runtime, and generic traffic logs into hourly summaries for observability dashboards.

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

Explains how the platform verifies X-Goog-IAP-JWT-Assertion headers using JWKS public keys to authenticate administrative users.

Manage per-tenant Identity Provider (IdP) configurations for OIDC, SAML, and IAP. Store and retrieve IdP settings, including client credentials and

Configure the platform's active feature set using the install_profile system setting. Enable F5 modernization, generic SOAP-to-REST, or both.

Describes the JDBC-based cache for platform settings, which persists the last-known-good configuration to a database table for resilience and auditing.

Explains how the runtime's License Enforcement Probe periodically reads and caches the license state from the database for fast, per-request checks.

Explains how the platform validates and enforces license terms from signed JWTs, including capacity limits, bootstrap licenses, and feature entitlements.

Use the Admin API to configure REST-to-SOAP operations, including timeouts, retries, validation rules, transformation rules, and example payloads.

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

API endpoints for detailed analysis of aggregated service data from the master discovery table, including traffic, consumers, failures, and alerting.

API reference for querying traffic metrics, logs, SLOs, and operational dashboards. Provides endpoints for unified observability across all traffic

A deep dive into the OpenAPI Repository, which stores and retrieves generated OpenAPI specifications and the metadata required for their generation.

Describes how OpenAPI specification imports are persisted, deduplicated by content hash, and retrieved. Explains the data model and repository API.

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

An internal event published to invalidate per-tenant role binding caches. This ensures role changes are reflected immediately, preventing stale

Manage the lifecycle of SaaS relay agents, including creation, rotation, revocation, and versioning. This repository provides tenant-scoped database

Documents the repository for relay authentication, heartbeat recording, dispatch selection, and self-update state management in multi-tenant deployments.

Manages asynchronous job dispatching between the gateway and backend relays using a database table. Defines the lifecycle for enqueuing, claiming, and

The Relay Heartbeat API receives periodic liveness signals from relay agents. This endpoint authenticates agents and records their status and version.

A reference of HTTP headers that are not allowed in backend profiles. These headers are restricted to prevent bypassing virtual host selection and

Prevents route conflicts when publishing APIs by checking if a route is already in use by another service, ensuring routing stability across the platform.

Explains how the platform normalizes incoming request paths for security authorization checks to prevent allow-list bypass vulnerabilities.

Technical reference for the Runtime API, the live data plane for request conversion. Details the publish (REST-to-SOAP) and consume (SOAP-to-REST)

Technical documentation for the Runtime Controller, which processes all inbound API traffic, including REST-to-SOAP, SOAP-to-REST, and SOAP passthrough

Configure the runtime service's database connection pool, including IAM and password authentication, multi-tenancy, and row-level security (RLS).

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

Explains the mechanism of the runtime route cache, including resolution logic, TTL configuration, multi-tenancy, and SOAPAction disambiguation.

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

Describes the caching repository for runtime system settings, which uses a time-to-live (TTL) cache to reduce database load during request processing.

Exports aggregated hourly API request counts for SaaS tenants to the central billing platform. This client runs on a schedule to report usage data.

API reference for the SAML 2.0 Assertion Consumer Service (ACS) and Service Provider (SP) metadata endpoints for IdP-initiated single sign-on.

Explains how the system identifies services that share common backend infrastructure, such as servers, web servers, or specific endpoint URLs.

Manages the lifecycle and persistence of service entities, including creation, updates, deletion, and configuration for routing and enforcement.

Compares two versions of a service to produce a detailed report of added, removed, and modified operations, including field-level differences.

Detailed technical documentation on creating, activating, and managing service versions, including draft creation, activation, rollback, and route

Handles SOAP-to-SOAP passthrough requests, preserving byte-for-byte fidelity of the SOAP body while managing HTTP headers for security and tracing.

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

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.

A complete reference to the S2R-AREA-NNNN error codes returned by the SOAP-2-REST Admin and Runtime APIs, including their meaning and HTTP status codes.

Release notes for the inaugural General Availability (v1.0) of the SOAP-2-REST platform. Details features, capabilities, and known limitations.

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

Technical reference for the Specaria Heartbeat Client, which sends periodic liveness and telemetry data to the Specaria platform for license validation.

Explains how the Synthetic Monitor Service automatically probes SOAP backend endpoints to check for availability and correctness. Covers configuration

Describes the automatic, one-time process that encrypts plaintext system setting secrets at rest. Explains the trigger, scope, and fail-soft behavior.

A technical reference for the administrative API endpoints used to manage system-wide settings, F5 integration, permissions, and installation profiles.

Manage system-wide configuration settings. Provides an interface to read, write, and validate settings, with support for tenant-specific overrides and

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

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.

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

Describes how the platform secures worker job trigger endpoints using an authentication interceptor for all POST requests to /worker/v1/run-* paths.

API reference for the Worker Service. Includes endpoints for health checks, data cleanup, log archiving, alert evaluation, and F5 traffic ingestion.

Configure the worker service's database connection pool, including IAM and password authentication, multi-tenancy, resilience, and performance tuning.

Explains how the platform persists and manages WSDL artifacts, operations, and their linkage to service versions. Covers creation, retrieval, and

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.

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

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

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

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