Admin API Reference

Overview

The Admin API provides the control plane for the SOAP-to-REST platform. It is a comprehensive REST API for all administrative and configuration tasks, including importing WSDLs, creating and managing services, configuring backends, editing mappings, generating OpenAPI specifications, and querying observability data. All actions available in the no-code UI are performed by calling this API.

The API is intended for programmatic management and automation by API publishers. It operates on a role-based access control (RBAC) model, where the caller's identity and permissions are resolved from forwarded identity provider (IdP) headers.

• Base Path: /admin/v1
• Authentication: All endpoints are protected by RBAC.
• Error Handling: Errors are returned using a standard error envelope, with error codes prefixed by S2R-ADM-* or S2R-VAL-*.

You can retrieve the current caller's identity and assigned application role by making a request to GET /admin/v1/me.

How it works

The Admin API enables a structured workflow for onboarding and managing a SOAP service as a REST API. The typical process involves importing a contract, configuring the service, and activating it for runtime traffic.

flowchart TD
    subgraph "1. Onboarding"
        A[Import WSDL] --> B{Generate Draft Service};
    end

    subgraph "2. Configuration & Testing"
        B --> C[Configure Operations & Mappings];
        C --> D[Define Backend Profile];
        D --> E[Test Backend Connection & Mappings];
    end

    subgraph "3. Activation"
        E --> F[Check Publish Readiness];
        F --> G{Activate Service Version};
    end

    subgraph "4. Operation"
        G --> H[Expose REST API via Runtime];
        H --> I[Monitor via Observability API];
    end

    style G fill:#d4edda,stroke:#c3e6cb

1. Import WSDL: The process begins by importing a WSDL file, which serves as the source contract. The API provides endpoints to import from a file, a URL, or pasted XML content. The platform validates, parses, and persists the WSDL, creating an import artifact.
2. Generate Service: From a persisted import artifact, a draft service, its version, and its operations are generated. An "autopilot" feature can combine the import and generation steps into a single call.
3. Configure and Test: The draft service is not yet active and can be configured. This includes editing REST path and method, setting timeouts, defining backend connection details (URL, credentials), and customizing field-level transformation rules. The API provides testing endpoints to validate backend connectivity and preview the request/response transformations.
4. Activate Version: Once configured and tested, a service version's readiness is assessed. If it passes all checks, it can be activated. Activation makes the service version immutable and available to the runtime for processing live traffic. Attempting to modify an active version will result in an error.
5. Manage and Monitor: After activation, the service can be monitored using the observability endpoints. For updates, a new draft version must be created by cloning an existing version. This new draft can be modified and then activated, which replaces the previously active version. The platform supports rollback to a previous version if needed.

WSDL Import & Onboarding

These endpoints manage the ingestion of WSDL contracts, which is the first step in creating a service. The API supports import from a file, a URL, or raw XML, and provides tools for diagnosing and repairing WSDLs before import.

Autopilot Endpoints

The :autopilot variants streamline onboarding by combining WSDL import and draft service generation into a single atomic operation. The response includes an import preview, a draft service suggestion, the generated objects, and a readiness assessment.

Services & Operations

These endpoints are used to manage the lifecycle of services and their constituent operations.

Services

A service is a logical grouping for a set of related operations.

Operations & Mappings

Operations represent the individual API methods. Mappings define the transformation between the REST and SOAP message formats.

Backend Profiles & Credentials

A backend profile stores the configuration for connecting to the downstream SOAP service, including its endpoint URL, authentication method, and credentials.

Supported authType values for backend profiles are none, basic, bearer, api_key_header, and oauth2_client_credentials. Mutual TLS can be enabled via the mtlsEnabled=true flag and is configured independently of the authType.

This functional area also includes endpoints for managing synthetic monitors (/admin/v1/services/{serviceId}/synthetic-monitor) and reusable test datasets (/admin/v1/services/{serviceId}/test-datasets).

Versioning, Activation & Rollback

The platform uses a versioning system to manage changes. A service version is a snapshot of its operations and their mappings. Only draft versions can be edited. Activating a draft makes it immutable and deploys it to the runtime.

OpenAPI Export

These endpoints generate and provide access to OpenAPI v3 specifications for activated service versions.

Settings & Roles

These endpoints manage global platform settings and user access control.

All changes to settings or roles generate an audit event.

Observability, Metrics & Audit

These endpoints provide access to aggregated metrics, logs, and audit trails. To ensure query performance, most endpoints read from pre-computed aggregation tables rather than raw log data.

Troubleshooting

API errors are returned in a standard envelope containing a machine-readable error code. Codes related to the Admin API are prefixed with S2R-ADM-* or S2R-VAL-* for validation errors.

See Also

• API Reference Overview
• Runtime API Reference
• Error Codes Reference
• Zero-touch Autopilot
• Publish & Version a Service
• Role-Based Access Control (RBAC)
• Observability Overview

All SOAP-to-REST docs