SSP8GWM_12.1.1 - Documentation Index

Table of Contents

• Welcome
• DataPower Interact Gateway overview
  • What's new in the latest release (version 12.1.1.0)
  • Known limitations
  • Components
  • User roles
  • Packaging strategy and terminology
  • Support
  • Considerations for GDPR readiness
  • Legal information
    • Notices
    • Terms and conditions for information centers
• Installing DataPower Interact Gateway
  • Kubernetes
    • Planning your deployment
      • DataPower Interact Gateway architecture
      • Deployment profiles
      • Deployment overview for endpoints and certificates
      • Generating a Software Product Compatibility Report
      • DataPower Interact Gateway license information
    • Installing DataPower Interact Gateway
      • Obtaining product files
        • Verifying the integrity of IBM product files
      • Installing prerequisite components
      • Preparing the deployment environment
      • Installing operators
      • Deploying IDIG cluster
      • Accessing IDIG user interfaces
      • Troubleshooting installation
    • Customizing user-facing certificates
      • Customizing Analytics mTLS client authentication
      • Troubleshooting certificate customization
      • DataPower Interact Gateway TLS certificates
    • Admin password best practices
• Configuring DataPower Interact Gateway
  • Destinations
  • TLS profiles
    • Creating a TLS client profile
    • Updating a TLS server profile
    • Creating a keystore
    • Creating a truststore
    • Using OpenSSL to generate and format certificates
  • OAuth providers
    • Configuring OAuth provider
  • SMTP email server
• Administering users and roles
• Getting started
  • Creating, publishing, and consuming MCP servers
  • Registering, publishing, and consuming Watsonx.ai
  • Registering, publishing, and consuming OpenAI
  • Registering, publishing, and consuming Google Gemini
  • Registering, publishing, and consuming Azure OpenAI
  • Registering, publishing, and consuming OpenAI-compatible provider
• Managing MCP tools and LLM providers using IBM API Studio
  • Configuring IBM API Studio
    • Configuring projects folder
    • Configuring version control system
      • Connecting to VCS by using a Personal Access Token
  • Using IBM API Studio
    • Creating projects
    • Importing existing files
    • Importing existing API Studio project
    • Managing projects in VCS
      • Creating branches in a VCS repository
      • Deleting branches in VCS repositories
      • Managing changes in a VCS project
    • Defining kinds
    • Supporting asset types and lifecycle actions
    • Creating MCP tools
      • Creating MCP server in form view
      • Registering external MCP server in form view
      • Creating MCP server in code view
    • Registering LLM providers
      • Registering Watsonx.ai in form view
      • Registering OpenAI in form view
      • Registering Gemini in form view
      • Registering Azure OpenAI in form view
      • Registering Open AI-compatible in form view
      • Registering LLM providers in code view
      • Configuring LLM provider API key secrets
    • Configuring policies
      • Configuring policies to MCP servers
        • Configuring policies in existing policy sequence
        • Configuring policies in new policy sequence
        • MCP server policies
      • Configuring policies to LLM providers
        • LLM provider policies
      • Configuring policies in code view
      • DataPower Nano Gateway policies
        • Cache
        • Circuit Breaker
        • Count Limit
        • Invoke
        • MCPInvoke
        • AWS Lambda
        • Load Balancer
        • Lua Script
        • Rate Limit
        • Retry
        • Set
        • Validate
        • Authenticate
        • Authorize
        • Extract Identity
        • IBM Cloud Login
        • Set Authorization
        • SQL Injection Filter
        • Block
        • Handlebars Template
        • Parse
        • Redact
        • Remove
        • Telemetry
        • Transform
        • Invoke Watsonx Models
        • Invoke Watsonx Tokenize
        • Invoke Watsonx Text Gen
        • Invoke OpenAI Chat Completions
        • Invoke OpenAI Embeddings
        • Invoke OpenAI Models ID
        • Invoke OpenAI Models
        • Invoke Azure OpenAI Chat Completions
        • Invoke Azure OpenAI Embeddings
        • Invoke Azure OpenAI Models ID
        • Invoke Azure OpenAI Models
        • Invoke Gemini Batch Embed Contents
        • Invoke Gemini Count Tokens
        • Invoke Gemini Embed Content
        • Invoke Gemini Generate Content
        • Invoke Gemini Models ID
        • Invoke Gemini Models
        • If
        • Operation Switch
        • Return
        • Switch
        • Throw
        • Try
    • Working with products and plans
    • Publishing projects
    • Accessing published AI assets
      • Accessing the gateway endpoint
    • Using MCP servers in MCP hosts
      • Using MCP server in Visual Studio Code
• Bring your own coding assistant (BYOCA)
• Monitoring MCP tools and LLM APIs using Analytics
  • Key concepts
  • Accessing analytics in the DataPower Interact Gateway UI
  • Offloading analytics data
    • Offloading analytics data to Splunk HEC exporter
    • Offloading analytics data to AWS X-Ray exporter
    • Offloading analytics data to Langfuse exporter
    • Offloading analytics data to AWS S3 exporter
    • Offloading analytics data to Instana exporter
    • Troubleshooting offload
• Using Developer Portal
  • Tutorials
    • Tutorial - Accessing LLM provider APIs
    • Tutorial - Accessing MCP server from Developer Portal
  • Configuring
    • Configuring SMTP settings
    • Configuring password policy
    • Specifying Developer Portal URL for reference from external systems
    • Specifying Cross-Origin Resource Sharing (CORS) URLs
    • Updating Developer Portal license
    • Configuring default group and group and community for new users
    • Configuring the default language
    • Configuring personal profile settings
    • Externalizing configurations
    • Developer Portal security configuration
      • Securing Developer Portal and OpenSearch communication
      • Securing communication between Developer Portal nodes in a cluster
      • Securing Developer Portal and webMethods API Gateway communication
      • Securing Developer Portal and Federated API Management communication
  • Administering
    • Security settings
      • Specifying multi-factor authentication settings
      • Specifying advanced security settings
    • Specifying user session settings
    • Specifying email notification templates
      • Email notification templates in Developer Portal
    • Configuring webhooks
      • Events for webhooks
    • Configuring webhooks to notify user requests to external approval systems
      • External approval system configuration
    • Configuring Federated API Management communication
    • Viewing audit log events
    • Configuring payment gateway
    • Adding payment details for consumers
    • Data backup and restore
      • Performing a data backup
        • Setting backup limit
      • Restoring data from a backup file
    • High availability configuration
      • Configuring high availability
    • Developer Portal ports configuration
      • Ports configuration
      • Configuring keystore
      • Disabling HTTPS port
      • Directing requests to HTTPS port
    • Configuring Developer Portal communication with secured webMethods API Gateway
    • Configuring access token signature validation
    • Restricting the HTTP port access
    • Docker support
      • Generating Docker image from installation
      • Running the Developer Portal Docker image
  • Customizing
    • Creating themes for customizing UI
    • Customize pages
      • Customizing blocks
        • Customization fields
      • Adding blocks and components
      • Moving blocks
      • Removing blocks
      • Adding pages
        • Assigning access to custom pages
    • Customize UI components
      • Adding new item to navigation bar
      • Customizing navigation bar
      • Customizing Sign up page
      • Customizing API grid
      • Customizing Package grid
      • Customizing API details pane
      • Customizing Plans grid
      • Adding language switcher icon
    • Customize labels
      • Adding new UI labels
    • Customize color schemes
      • Customizing color schemes
      • Customizing browser header text and icon
    • Customization by using web components
      • Registering web components
  • Managing
    • Managing users
      • User onboarding
      • Native registration
        • Adding users
        • Adding user groups
        • Inviting users to sign up
        • Assigning user privileges
        • Disabling user registration from the Sign up page
        • Onboarding strategy
          • Configuring user onboarding strategy
          • Configuring internal onboarding approval workflow
          • Approving user onboarding requests
      • Onboarding LDAP users and groups
        • Creating LDAP connections
        • Creating LDAP connection to a secured LDAP server
        • Specifying LDAP connection attributes
        • Importing users and user groups from LDAP server
      • Single sign-on users onboarding
        • SAML SSO onboarding
          • Onboarding SAML users
          • Configuring SAML users onboarding configurations
        • User onboarding using social media accounts
          • Onboarding users by using social media credentials
      • User preferences
        • Modifying user details
        • Changing your password
        • Viewing communities
        • Configuring notification preference
        • Scheduling usage reports
      • Data anonymization
        • Enabling or disabling automatic anonymization from UI
        • Anonymizing deleted user data by using REST API
      • Configuring consumer visibility
    • Managing providers
      • Creating providers
      • Mapping API or Callback URL to providers
      • API partner isolation
        • Onboarding API partners
        • Assigning asset ownership
    • Managing communities
      • Creating communities
      • Mapping users, groups, or APIs to communities
      • Configuring visibility of users based on communities
    • Managing AI assets
      • Editing an AI asset
      • Editing the attributes of AI assets
      • Trying out AI assets
        • Trying MCP servers
        • Trying LLM provider APIs
        • Authorization fields
    • Managing applications
      • Configuring application or subscription onboarding strategy
      • Creating applications
        • Creating applications from Manage applications screen
        • Creating applications from API details page
        • Creating applications from Try API page
        • Approving application or package subscription requests
    • Managing custom assets
      • Configuring asset types
        • Property types
      • Adding custom assets to publish to webMethods Developer Portal
      • Adding custom asset gallery to UI
    • Managing lifecycle of APIs and packages
      • Lifecycle feature considerations
      • Customizing API lifecycle states
        • Customizing API lifecycle states - sample
      • Enabling lifecycle feature for APIs and packages
      • Modifying state of APIs
        • Changing the state of an API to expose it to consumers
        • Changing the state of a Live API
        • Changing an API's state to retire it from usage
      • Modifying the state of API products
        • Changing lifecycle state of packages
        • Changing lifecycle state of live packages
        • Change state of packages
    • Managing AI programs
      • Hackathons
        • Creating hackathons
        • Inviting participants for AI programs
        • Assigning owners for AI programs
        • Registering for hackathons
        • Adding team members for hackathons
        • Adding hackathon projects
      • Beta programs
        • Creating beta programs
        • Registering for beta programs
        • Adding tickets for beta programs
  • Analyzing
    • Viewing user analytics dashboard
    • Viewing API economy insights dashboard
    • Viewing API economy trends dashboard
    • Viewing Programs dashboard
    • Viewing API usage analytics dashboard
    • Viewing applications usage dashboard
  • Troubleshooting
    • Troubleshooting APIs published from IBM webMethods API Gateway – Error message appears when you test APIs
  • Reference
    • webMethods Developer Portal REST APIs
      • Analytics
      • APIs
      • Applications
      • Approvals
      • Data backup and restore
      • Collaboration
      • Communities
      • Configurations
      • Custom assets
      • Events
      • Developer Portal Health check
      • Notifications
      • OAuth tokens
      • Packages
      • Payment gateway
      • Programs
      • Plans
      • Providers
      • Search
      • Teams
      • Topics
      • User requests
      • Users
      • Webhooks
  • Glossary