Header Image

Gateway API

Programmatic Access to Layer 7 API Gateways


Organizations with existing investments in provisioning, management and/or configuration systems can utilize the Layer 7 Management API to provision and manage policies and associated services directly on any Layer 7 Gateway.

Existing operational support and network management systems (OSS/NMS) can interface through Layer 7’s APIs to publish new services on the Gateway by updating a policy template with parameters that define the specific service’s implementation. Using the Management API, organizations can also update/modify existing policies and services or enable/disable them, as well as collect logs, audits, alerts and performance statistics.


Learn More About Layer 7 API Gateways

  • Remote Gateway Management – allows organizations to programmatically integrate existing OSS/NMS systems and processes with any Layer 7 Gateway
  • Centralized Service Provisioning – support for externally authored policies/policy push, as well as policy reconfiguration based on events, SLAs, etc
  • Headless Operation – gain control over systems, policies and services directly through APIs, simplifying administration
  • Automate Repetitive Tasks – support for a command line interface allows administrators to create scripts or batch files to execute menial, repetitive tasks quickly

The Layer 7 Management API is available as either:

  • WS-Management compliant SOAP service that can be used for development by integrators and end users, or
  • Java library for users that do not wish to directly use the SOAP API, or
  • Command line interface for scripting and batch files

The Management API supports:

  • Create, Read, Update and Delete for:
    • Cluster properties
    • Services
    • JMS queues
    • Policies and policy fragments
  • Read access to:
    • Identity providers
    • Global XML Schemas
    • JDBC connection
    • Private key/trusted certificate
  • Import/Export of policies
  • Policy validation for services and policies


  • XML
  • SOAP
  • AJAX
  • XPath
  • XSLT
  • WSDL
  • XML Schema
  • LDAP
  • SAML
  • PKCS
  • X.509 Certificates
  • FIPS 140
  • Kerberos
  • W3C XML Signature
  • W3C XML Encryption
  • SNMP
  • SMTP
  • POP3
  • IMAP4
  • IPv6
  • WCF
  • JMS
  • MQ Series
  • REST
  • Tibco EMS
  • FTP
  • WS-Security
  • WS-Trust
  • WS-Federation
  • WS-Addressing
  • WSSecureConversation
  • WS-MetadataExchange
  • WS-Policy
  • WS-SecurityPolicy
  • WS-PolicyAttachment
  • WS-SecureExchange
  • WSIL
  • WS-I
  • WS-I BSP
  • UDDI
  • WSRR
  • MTOM