• webMethods API Gateway Documentation
•  About this Documentation
  • Document Conventions
  • Online Information and Support
  • Data Protection
•  Configuring API Gateway
  •  API Gateway Architecture
    • API Gateway Editions
    • API Gateway Deployment Scenarios
  •  API Gateway Configuration
    •  API Gateway Cluster Configuration
      • Nodes and Clusters
      • Configuring an API Gateway Cluster
    • Accessing the API Gateway User Interface
    •  Secure Internal Data Store for API Gateway
      • Securing Internal Data Store
      • Preparing the Clients
      • Verifying API Gateway and Browsers
    • Connecting to an External Elasticsearch
    • Connecting to an External Kibana
    • Configuring Multiple Instances of API Gateway in a Single Installation
  •  Docker Configuration
    • Overview
    • Building the Docker Image for an API Gateway Instance
    • Retrieving Port Information of the API Gateway Image
    • Running the API Gateway Container
    • Load Balancer Configuration with the Docker Host
    • Stopping the API Gateway Container
    • Managing API Gateway Images
    • Configuring an API Gateway Docker Container Cluster
  •  Configuration Properties
    •  Configuration Types and Properties
      • Web-app Configuration Properties
      • API Gateway Package Configuration Properties
      • Configuration Properties to Secure Elasticsearch
  •  API Gateway Data Management
    • Data Backup and Restore
    • Data Backup and Restore Commands
    • Backing up API Gateway Configuration Data
    • Restoring API Gateway Configuration Data
  •  API Gateway Staging and Promotion
    • Introduction
    • Asset Promotion in API Gateway
    • DevOps Usecase in API Gateway
  •  Mediator Migration to API Gateway
    • Migrating Mediator to API Gateway
•  Using API Gateway
  •  webMethods API Gateway
    • Introduction to webMethods API Gateway
    • Searching Data in API Gateway
    • Configuring the Number of APIs listed on a Page
    • Using Help in API Gateway
  •  API Gateway Administration
    • Overview of Administration Tasks
    •  General Configuration
      •  Clusters and Load Balancers
        • Configuring Load Balancer URLs
      • Configuring Extended Settings
      • Configuring API Fault Settings
      •  Approval Configuration
        • Configuring Approvals for Creating an Application
        • Configuring Approvals for Registering Application
        • Configuring Approvals for Updating Application
        • Configuring Approvals for Subscribing Package
        •  Managing Pending Requests
          • Deleting Requests
      •  Outbound Proxy
        • Configuring Proxy Server Alias
        • Modifying a Proxy Server Alias
        • Deleting a Proxy Server Alias
      •  URL Aliases
        •  Creating URL Alias
          • Using Port Mappings with URL Alias
          • Adding Port Mapping to URL Alias
          • Deleting Port Mapping for URL Alias
        • Enabling Partial Matching of URL Aliases
        • Modifying a URL Alias
        • Deleting a URL Alias
        • Example: Usage Scenarios of URL Aliases
      •  Custom Content-types
        • Configure Custom Content-types
      •  Cache Configuration
        • Configuring Cache to Improve Performance
      •  Application Logs
        • Configuring Log Levels
        • Downloading the Log Files
        • Configuring Log Aggregation
      •  License Configuration
        • Viewing Licensing Information
        • Configuring Licenses
      • Enabling Clustering for API Gateway
      • Configuring API Callback Processor Settings
      •  Messaging
        • Creating a JNDI Provider Alias
        • Creating a JMS Connection Alias
      •  Web Services Endpoint Alias
        • Creating an Endpoint Alias for a Provider Web Service Descriptor
        • Creating an Endpoint Alias for a Consumer Web Service Descriptor
      •  JMS Triggers
        • Updating JMS triggers
      •  Transaction Alerts
        • Configuring Criteria for Transaction Alert Notification
        • Modifying License Alert Configurations
        • Deleting a Transaction Alert Configuration
    •  Security Configuration
      •  Keystore and Truststore
        • Configuring Keystore Information
        • Configuring Truststore Information
        • Configuring Keystore and Truststore Information
        • Modifying Keystore Information
        • Deleting Keystore Information
        • Modifying Truststore Information
        • Deleting Truststore Information
      •  Ports
        • Adding an HTTP Port
        • Adding an HTTPS Port
        • Adding an API Gateway External Port
        • Configuring the API Gateway Internal listener
        • Configuring the WebSocket Listener
      • SAML Issuer
      •  Custom Assertions
        • Creating a Custom Assertion
        • Viewing Custom Assertion List and Assertion Configuration
        • Modifying Custom Assertion
        • Deleting Custom Assertion
        • Example: Custom Assertions
      •  Kerberos Settings
        • Configuring API Gateway to Use Kerberos
      •  Master Password Management
        • Backing up the Password and Master Password Files
        • Updating the Master Password
        • Managing Master Password Expiry Interval
        • Advanced Configuration to Manage Master Password
        • Restoring the Password and Master Password Files
        • Resetting the Master Password
      •  OAuth, JWT, and OpenID Configuration
        •  OAuth Authentication Use case and Workflow
          • Retrieving OAuth Token
        •  JWT Authentication Use case and Workflow
          • Retrieving JWT Token
          • Retrieving JWT Token with Claim
        • OpenID Authentication Use case and Workflow
        • Configuring the Internal Authorization Server
        • Adding a Provider
        • Adding an External Authorization Server
        • Mapping OAuth or OpenID Scopes
        • Viewing Scope Mapping Details
        • Viewing Provider List and Provider Configuration
        • Modifying the Provider Configuration
        • Viewing Authorization Server List and Server Configuration
        • Modifying Authorization Server Configuration
        • Deleting an Authorization Server
        • Deleting a Provider
    •  Destination Configuration
      • Configuring Events for API Gateway Destination
      • Configuring API Portal Destination
      • Configuring Events for API Portal Destination
      • Configuring Transaction Logger Destination
      • Configuring CentraSite Destination
      • Configuring Events for CentraSite Destination
      • Configuring Events for Database Destination
      • Configuring Events for Digital Events Destination
      • Configuring Elasticsearch Destination
      • Configuring Events for Elasticsearch Destination
      •  Configuring Email Destination
        • Configuring Email Templates
      • Configuring SNMP Destination
      • Configuring Events for SNMP Destination
    •  Audit Logging
      • Configuring Audit Logs
      • Viewing Audit Logs
      • Downloading Audit Logs
    •  Data Management
      •  Archive and Purge
        • Archiving Data
        • Purging Data
      •  Restore
        • Restoring Data
    •  System Settings
      • Modifying API Gateway Configuration Parameters
      • Configuring SAML Settings for Single Sign-on
    •  Service Registries
      • Adding a Service Registry
      • Removing a Service Registry
  •  User Management
    •  Manage Users, Groups, and Access profiles
      • Adding a User
      • Modifying User Details
      • Deleting a User
      •  User Groups
        • Adding a Group
        • Modifying a Group
        • Deleting a Group
      •  Access Profiles
        • Adding an Access Profile
        • Modifying an Access Profile
        • Deleting an Access Profile
      • Setting Password Restrictions
      • Setting Password Expiry Restrictions
      • Configuring Account Locking Settings
      • Unlocking User Accounts
      • Configuring API Gateway to Use LDAP
      • Managing LDAP Directories
    •  Manage Your User Settings and Preferences
      • Changing Your Account Settings
      • Changing Your Password
      • Changing Your Display Language
      • Viewing Your Roles and Permissions
  •  APIs
    • Overview
    • Creating an API by Importing an API from a File
    • Creating an API by Importing an API from a URL
    •  Creating an API from Scratch
      • Overview of Creating a REST API from Scratch
      • Creating a REST API
      • Creating a WebSocket API
    •  API Mashups
      • Creating an API Mashup
    •  Viewing API List and API Details
      • REST API Details
      • SOAP API Details
      • OData API Details
    • Filtering APIs
    • Activating an API
    • Deactivating an API
    •  Publishing APIs
      •  Publishing APIs to API Portal
        • Publishing a Single API to API Portal
        • Publishing Multiple APIs to API Portal in a Single Operation
      •  Publishing APIs to Service Registries
        • Publishing a Single API to Service Registries
        • Publishing Multiple APIs to Service Registries in a Single Operation
    •  Unpublishing APIs
      •  Unpublishing APIs from API Portal
        • Unpublishing a Single API from API Portal
        • Unpublishing Multiple APIs from API Portal in a Single Operation
      •  Unpublishing APIs from a Service Registry
        • Unpublishing a Single API from Service Registries
        • Unpublishing Multiple APIs from Service Registries in a Single Operation
    • Modifying API Details
    •  Updating APIs
      • Updating an API by Importing an API from a File
      • Updating an API by Importing an API from a URL
    •  API Mocking
      • Enabling API Mocking
      • Modifying API Mocking Details
      • Custom Replacer
    • Attaching Documents to an API
    •  SOAP to REST Transformation
      • Activating SOAP to Rest Transformation
      • Modifying the REST Definitions for SOAP Operations
      • Supported Content-types and Accept Headers
      • REST API Endpoints
      • Samples for REST Request
      • Limitations
    •  Versioning APIs
      • Creating New API Version
    •  API Scopes
      • Creating an API Scope
      • Viewing List of API Scopes and Scope Details
      • Modifying API Scope Details
      • Deleting an API Scope
      • Example: Usage Scenarios of API Scopes
    • Exposing a REST API to Applications
    • Exposing a SOAP API to Applications
    • API Grouping
    •  API Tagging
      • Adding Tags to an API
    • Exporting APIs
    • Exporting Specifications
    •  Deleting APIs
      • Deleting a Single API
      • Deleting Multiple APIs in a Single Operation
    • Example: Managing an API
  •  Policies
    • Overview
    • Policy Validation and Dependencies
    •  Managing Threat Protection Policies
      • Configuring Global Denial of Service Policy
      • Configuring Denial of Service by IP Policy
      • Managing Denied IP List
      • Configuring Rules
      • Registering a Mobile Device or Application
      • Configuring Alert Settings
    •  System-defined Stages and Policies
      •  Transport
        • Enable HTTP/HTTPS
        •  Enable JMS/AMQP
          • Configuring API Gateway for JMS with AMQP Protocol
          • Using Enable JMS/AMQP for a SOAP API
          • Using Enable JMS/AMQP for a REST API
        • Set Media Type
      •  Identify and Access
        • Inbound Authentication - Message
        • Authorize User
        • Identify and Authorize Application
      •  Request Processing
        • Invoke webMethods IS
        • Request Transformation
        • Validate API Specification
        • Data Masking
      •  Routing
        • Content-based Routing
        • Context-based Routing
        • Dynamic Routing
        • Load Balancer Routing
        • Straight Through Routing
        • Custom HTTP Header
        • Outbound Authentication - Transport
        • Outbound Authentication - Message
        •  JMS/AMQP Policies
          • Using JMS/AMQP Policy for a SOAP API
          • Using JMS/AMQP Policy for a REST API
          • JMS/AMQP Properties
      •  Traffic Monitoring
        • Log Invocation
        • Monitor Service Performance
        • Monitor Service Level Agreement
        • Throttling Traffic Optimization
        • Service Result Cache
      •  Response Processing
        • Invoke webMethods IS
        • Response Transformation
        • Validate API Specification
        • Data Masking
        • CORS
      •  Error Handling
        • Conditional Error Processing
        • Data Masking
      • The API for Context Variables
    •  Managing Global Policies
      • Creating a Global Policy
      • Modifying the Scope of a Global Policy
      • Refining the Scope of a Global Policy
      • Associating Policies to a Global Policy
      • Configuring Properties for a Global Policy
      • Viewing List of Global Policies and Policy Details
      • Modifying Global Policy Details
      • Activating a Global Policy
      • Deactivating a Global Policy
      • Deleting a Global Policy
      • Copying a Global Policy
      • Exporting Global Policies
    •  Managing API-level Policies
      • Assigning a Policy to an API
      • Viewing API Policy Details
      • Modifying API Policy Details
    •  Managing Scope-level Policies
      • Creating a Scope-level Policy
      • Viewing List of Scope-level Policies and Policy Details
      • Modifying Scope-level Policy Details
      • Deleting a Scope-level Policy
    •  Managing Policy Templates
      • Creating a Policy Template
      • Associating Policies with a Policy Template
      • Configuring Properties for a Policy Template
      • Viewing List of Policy Templates and Template Details
      • Modifying Policy Template Details
      • Deleting a Policy Template
      • Copying a Policy Template
      • Applying a Policy Template on the API Details Page
      • Modifying a Policy Template on the API Details Page
      • Saving Policy Definition of an API as Policy Template
    • Supported Alias and Policy Combinations
  •  Aliases
    • Overview
    • Creating a Simple Alias
    • Creating an Endpoint Alias
    • Creating an HTTP Transport Security Alias
    • Creating a SOAP Message Security Alias
    • Creating a webMethods Integration Server Service Alias
    • Creating an XSLT Transformation Alias
  •  Applications
    • Overview
    • Creating an Application
    • Viewing List of Applications and Application Details
    • Regenerating API Access Key
    • Modifying Application Details
    • Registering an API with Consumer Applications from API Details Page
    • Registering APIs with Consumer Applications from Application Details Page
    • Suspending an Application
    • Activating a Suspended Application
  •  API Packages and Plans
    • Overview
    • Creating a Package
    • Creating a Plan
    • Viewing List of Packages and Package Details
    • Modifying a Package
    • Deleting a Package
    • Activating a Package
    • Publishing a Package
    • Viewing List of Plans and Plan Details
    • Modifying a Plan
    • Deleting a Plan
  •  Import Archives
    • Importing Exported Files
  •  Asset Promotions
    •  Manage Stages, Promotions, and Rollbacks
      •  Stages
        • Adding a Stage
        • Viewing Stage List and Stage Details
        • Modifying Stage Details
        • Deleting a Stage
      •  Promotions
        • Promoting Assets
        • Viewing Promotion List and Promotion Details
        • Repromoting Assets
      •  Rollbacks
        • Rollback Asset Promotions
        • Viewing Rollback List and Rollback Details
  •  API Gateway Analytics
    •  Analytics Dashboards
      • API Gateway Dashboard
      • API-specific Dashboard
    •  Runtime Events and Metrics Data Model
      • API Gateway
      • API Portal
      • Audit Log
      • CentraSite
      • Elasticsearch
      • Email
      • JDBC
      • Local Log
  •  REST APIs in API Gateway
    • API Gateway Administration
    • Alias Management
    • Application Management
    • API Gateway Archive
    • Policy Management
    • API Gateway Search
    • Service Management
    • Transaction Data
    • User Management
    • Backward compatibility support for REST APIs
  •  Remove User Data from API Gateway
    • Removing User Data
• Copyright

webMethods API Gateway Documentation

Copyright

gtw_introduction

gtw_search

gtw_administration

gtw_gen_config

gtw_configure_load_balancer

gtw_configure_extended_settings

gtw_configure_fault_settings

gtw_configure_approvals

gtw_configure_approvals_create

gtw_configure_approvals_register

gtw_configure_approvals_update

gtw_configure_approvals_subscribe

ta_pending_request

gtw_configure_outbound_proxy

gtw_configure_url_aliases

gtw_custom_content_type

gtw_configure_cache

gtw_configure_loglevels

gtw_download_logfiles

gtw_configure_log_aggregation

gtw_license_info

gtw_configure_license

gtw_configure_cluster

gtw_configure_callback_settings

gtw_configure_license_alerts

gtw_sec_config

gtw_configure_keystore

gtw_configure_truststore

gtw_configure_keystore_truststore

gtw_configure_ports

gtw_configure_saml_issuer

gtw_policy_assertions

gtw_configure_policy_assertion

gtw_configure_kerberos

gtw_manage_master_password

gtw_configure_auth_server_int

gtw_configure_provider

gtw_configure_auth_server_ext

gtw_map_oauth_scope

gtw_configure_gateway

gtw_configure_portal

gtw_configure_audit_logger

gtw_configure_cs

gtw_configure_cs_events

gtw_configure_database

gtw_configure_des

gtw_configure_es

gtw_configure_es_events

gtw_configure_email

ta_configure_email_template

gtw_configure_snmp

gtw_configure_snmp_events

gtw_archive_purge

gtw_restore

gtw_configure_system_settings

gtw_configure_saml_sso

gtw_service_registries

gtw_manage_users_groups_profiles

gtw_add_user

ta_modify_user

co_user_groups

gtw_add_group

ta_modify_group

co_users_groups_profiles

gtw_add_profile

ta_gtw_modify_profile

gtw_manage_pwd_restrictions

gtw_manage_pwd_expiry_settings

gtw_manage_account_lock_settings

gtw_manage_locked_users

gtw_manage_provider_configuration

gtw_manage_ldap_directories

gtw_manage_user_accounts_settings

gtw_manage_apis

gtw_create_api_file

gtw_create_api_url

gtw_create_api_scratch

gtw_create_rest_api_scratch

gtw_create_websockets_api_scratch

gtw_add_api_mashup

gtw_view_api_details

updating_apis

updating_apis_file

updating_apis_url

api_mocking

ta_modifying_api_mocking

soap_rest_transformation

modifying_rest_definitions

content_type

endpoint

sample_rest_request

limitations

versioning_apis

create_new_versioning_apis

exporting_apis

exporting_specifications

gtw_manage_policies

gtw_manage_threat_protection_policies

gtw_transport_policies

gtw_iam_policies

gtw_payload_request

gtw_transformation_request

gtw_routing_policies

gtw_lmt_policies

gtw_payload_response

gtw_transformation_response

gtw_error_handling

gtw_manage_global_policies

gtw_create_global_policy

gtw_view_global_policy

gtw_modify_global_policy

exporting_global_policies

gtw_manage_policy_templates

gtw_create_policy_template

gtw_view_policy_template

gtw_modify_policy_template

gtw_apply_policy_template

gtw_manage_aliases

create_is_alias

create_transformation_alias

gtw_manage_applications

gtw_create_application

gtw_view_application_details

ta-modify_appln_ui

gtw_manage_packages

gtw_create_package

gtw_create_plan

ta-modify_package

ta-modify_plan

exporting_importing_files

gtw_manage_promotions

gtw_add_stage

ta_modify_stage

gtw_analytics