SSCL05_12.1.0 - Documentation Index

Table of Contents

• Welcome
• IBM API Connect Enterprise as a Service overview
  • What's new in API Connect Enterprise as a Service
  • API Connect Enterprise as a Service Version 12 product compatibility requirements
  • Purchase, subscription, and upgrade information
    • FAQ: Premium subscription
  • Understanding API Connect
    • API Connect overview
    • Packaging strategy and terminology in API Connect
      • Understanding rate limits for APIs and Plans
    • API Connect components
      • Gateway types
      • How to choose the right gateway service
    • API Connect glossary
    • Essential reading
  • Getting started
    • Who does what in API Connect?
      • API Connect user roles
  • Known limitations
  • Getting help from IBM support
  • Accessibility features for IBM API Connect
  • Legal information
    • Notices
    • Terms and conditions for information centers
  • IBM API Connect Considerations for GDPR Readiness
• Creating, deploying, and publishing APIs using API Agent
  • API Agent overview
  • API Agent user roles
  • Configuring
    • Watsonx.ai settings
    • API Agent settings
    • API Agent sources
      • API Connect catalogs and drafts
      • Application sources
      • Documentation files
    • Configuring MCP tools
    • MTLS for connectivity pack applications
  • Getting started
    • Installing API Agent in Visual Studio Code
    • Logging in to API Agent in Visual Studio Code
    • Configuring API Manager connection
    • Uninstalling API Agent
  • Best practices
    • Starting a new session
    • Debugging process
    • Attaching and downloading files
  • Using API Agent
    • Searching APIs and tables
    • Creating an OpenAPI document from an existing source
    • Generating python code from an OpenAPI
    • Deploying application to IBM Code Engine
    • Creating, publishing, and validating an API
    • Using API Agent in IBM API Studio
  • Creating MCP server
    • Configuring MCP servers
    • Enabling the MCP server
  • API Agent tools
    • Tools compatibility
    • Management MCP
      • Project-related operations
      • API Manager operations
      • Consumer-related operations
      • List operations
      • Plans with multiple tool operations
    • Artifacts searcher
    • OAS Creator
    • OpenAPI to Python
    • Code deployment
    • Documentation searcher
    • Analytics
    • API discovery and rationalization
    • MCP server and client
    • Governance MCP
    • Management AI MCP
    • IBM API Studio
    • Help
  • Troubleshooting
  • Known limitations
  • Frequently Asked Questions
• Creating, deploying, and publishing APIs using IBM API Studio
  • Getting started
    • Understanding user roles and permissions in IBM API Studio
  • Installing IBM API Studio
    • Using IBM API Studio with self-signed certificates
  • Configuring IBM API Studio
    • Configuring projects folder
    • Configuring version control system
      • Connecting to VCS by using GitHub credentials
      • Connecting to VCS by using a Personal Access Token
      • Configuring GitHub Personal Access Token permissions for IBM API Studio VCS
      • Configuring multiple repositories
      • Disconnecting from repositories
      • Troubleshooting VCS connection errors
    • Configuring webMethods API Gateway
    • Connecting IBM API Studio to API Manager
    • Configuring rulesets in IBM API Studio
    • Auto-subscribing to a plan of a published product
  • Using IBM API Studio
    • Creating API projects
    • Importing existing files
    • Importing existing API Studio project
    • Exporting API projects
    • Managing API projects in VCS
      • Creating branches in a VCS repository
      • Deleting branches in VCS repositories
      • Managing changes in a VCS API project
    • Defining kinds in IBM API Studio
    • Supporting asset types and lifecycle actions
    • Creating APIs
      • Creating APIs in code view
      • Creating API in form view
        • Creating REST API from scratch
        • Creating REST API by importing from file
        • Creating REST API by importing from URL
        • Creating a REST API by using API proxy
        • Creating SOAP API for DataPower API Gateway
        • Importing API from API Connect v10
        • Updating API specification
        • API outline overview
    • Creating policies
      • Creating policies in code view
        • Working with policy sequence
      • Creating policies in form view
        • Creating a policy sequence
          • Adding policies to an API
      • Working with global policies
        • Creating global policies in form view
      • DataPower API policies
      • DataPower Nano Gateway API policies
        • Built-in policies
          • Cache
          • Circuit Breaker
          • Count Limit
          • Invoke
          • Invoke AWS Lambda
          • Load Balancer
          • Lua Script
          • Rate Limit
          • Retry
          • Set
          • Validate
          • Authenticate
          • Authorize
          • CORS
          • 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
        • Logic constructs
          • If
          • Operation Switch
          • Return
          • Switch
          • Throw
          • Try
      • webMethods API Gateway policies
        • Transport
          • Inbound bulkhead
          • Set media type
          • Inbound messaging
          • URI Schemes
        • Identify and authorize
          • Identify and authorize
          • Authorize user
          • Set context variable
          • Messaging
          • External endpoint
        • Request processing
          • Request transformation
          • Data masking
          • Invoke webMethods IS
          • Set context variable
          • Validate API specification
          • Messaging
          • External endpoint
        • Traffic Monitoring
          • Log
          • Monitor traffic
          • Service result cache
          • Rate limiter
        • Routing
          • Invoke
          • Conditional routing
          • Content based routing
          • Dynamic routing
          • JMS/AMQP REST routing
          • Load balancer
          • Invoke webMethods IS
          • Set context variable
          • Set authorization
          • Outbound anonymous
          • Outbound Alias
          • Outbound NTLM Auth
          • Custom HTTP header
          • Messaging
          • External endpoint
          • AWS Lambda
        • Error Handling
          • Conditional error processing
          • Data masking
          • Invoke webMethods IS
          • Set context variable
          • Messaging
          • External endpoint
          • AWS Lambda
        • Response Processing
          • Response transformation
          • Validate API specification
          • Data masking
          • External endpoint
          • CORS
    • Working with API products and plans
      • Creating API products and plans in code view
      • Creating API products and plans in form view
        • Creating products in form view
        • Importing products in form view
        • Creating plans in form view
    • Creating asset versions
    • Staging projects
    • Publishing projects
    • Trying out an API
      • Trying out an API without a project
    • Mocking APIs
    • Testing published APIs
      • Authoring tests in code view
        • Defining validation criteria using assertions in code view
        • Defining an environment configuration in code view
        • Supported assertions and syntax
      • Authoring tests from scratch in form view
        • Adding environment variables
        • Adding assertions
      • Authoring tests from OpenAPI specification
      • Running authored tests
        • Running authored tests by using UI
    • Using linting in IBM API Studio
      • AI linting support for API specifications
    • Viewing audit events
    • Using APIM CLI with IBM API Studio
      • Viewing commands in API Manager CLI
      • Building projects
      • Deploying projects
      • Testing projects
      • Linting assets
      • Loading sample projects
      • Importing and exporting projects
      • Getting help
• Developing APIs using Toolkit CLI
  • API development checklist
  • API discovery
    • Configuring a GitHub collector for API discovery
    • Configuring a DataPower API Gateway proxy collector for API discovery
    • Configuring Noname collector for API discovery
    • Configuring an OpenTelemetry collector for API discovery
    • Reviewing your discovered APIs
    • The API discovery lifecycle in API Manager
  • OpenAPI 3.1 support in IBM API Connect
  • Working with the toolkit
    • Setting up the API Connect toolkit
    • Using the developer toolkit command-line tool
      • Overview of the command-line tool
      • Logging in to a management server
      • API development and management commands
        • Configure user limit and invitation resend interval for Consumer organization
      • Creating APIs and applications
      • Publishing APIs and applications
      • Publishing a project
      • Reading input from the command line
      • Scripting with the toolkit commands
      • Working with OpenAPI extensions
      • Using the toolkit CLI to execute API tests
        • Test definition syntax
        • Variable assignment in YAML configuration
  • Managing platform REST API keys
  • Working with API definitions
    • Securing your APIs
    • Defining security scheme components
      • Defining basic authentication security scheme components
      • Defining API key security scheme components
        • Client ID behavior in API key security definitions
      • Defining OAuth2 security scheme components
      • Defining OIDC security scheme components
      • Defining an HTTP bearer security scheme
    • Enforcing security requirements on an API
    • Defining rate limits for an API operation
  • API properties
  • Variable references in API Connect
  • DataPower API policies and logic constructs
    • Built-in policies
      • Activity Log
      • Client Security
      • Extract
        • Constructing JSONata expressions to extract and transform data
      • GatewayScript
        • GatewayScript code examples
      • Gemini invoke
      • Generate JWT
      • GraphQL Cost Analysis
      • GraphQL Execute
      • GraphQL Introspect
      • IBM Cloud Authentication
      • Invoke
        • Configuring the Invoke policy for DataPower API Gateway
        • Configuring the Invoke policy for DataPower Gateway (v5 compatible)
      • JSON to XML
        • Configuring the JSON to XML policy for DataPower API Gateway
        • Configuring the JSON to XML policy for DataPower Gateway (v5 compatible)
      • Lambda
      • Log
      • Map
        • The Map policy structure
        • Configuring the Map policy in the user interface
        • Map policy examples
      • Message template
      • OAuth
        • Example - using multiple OAuth policies in an OAuth provider assembly
      • openai invoke
      • Azure openai invoke
      • Parse
      • Proxy
      • Rate Limit
      • Rate Limit Info
      • Redaction - DataPower API Gateway
        • Constructing JSONata expressions to redact fields
      • Redaction - DataPower Gateway (v5 compatible)
        • Constructing XPath expressions to redact fields
      • Set Variable
        • Configuring the Set Variable policy for DataPower API Gateway
        • Configuring the Set Variable policy for DataPower Gateway (v5 compatible)
      • Token Mediation
      • User Security
      • Validate - DataPower API Gateway
      • Validate - DataPower Gateway (v5 compatible)
      • Validate JWT
      • Validate Username Token
      • watsonx.ai invoke
      • Websocket Upgrade
        • Configuring the Websocket Upgrade policy for DataPower API Gateway
        • Configuring the Websocket Upgrade policy for DataPower Gateway (v5 compatible)
      • XML to JSON
        • Configuring the XML to JSON policy for DataPower API Gateway
        • Configuring the XML to JSON policy for DataPower Gateway (v5 compatible)
      • XSLT
        • Configuring the XSLT policy for DataPower API Gateway
        • Configuring the XSLT policy for DataPower Gateway (v5 compatible)
        • XSLT policy examples
        • Implementation code examples
    • Logic Constructs
      • if
      • operation-switch
      • switch
        • Using the switch policy condition editor
      • throw
    • Using context variables in GatewayScript and XSLT policies with the DataPower API Gateway
      • Manipulating attachments in a message object
    • User-defined policies
  • Including elements in your API assembly
    • The assembly editor
    • Adding elements to your assembly
    • Handling errors in the assembly
  • Creating and validating API and Product definitions by using the CLI
    • Creating an OpenAPI definition file
      • IBM extensions to the OpenAPI specification
        • execute
          • activity-log
          • client-security
          • extract
          • gatewayscript
          • gemini-invoke
          • graphql-cost-analysis
          • graphql-execute
          • graphql-introspect
          • ibm-cloud-authentication
          • if
          • invoke
          • json-to-xml
          • jwt-generate
          • jwt-validate
          • Lambda
          • log
          • map
          • message-template
          • operation-switch
          • oauth
            • Example - using multiple OAuth policies in an OAuth provider assembly
          • openai-invoke
          • Azure openai-invoke
          • parse
          • proxy
          • ratelimit
          • ratelimitinfo
          • redact - DataPower API Gateway
          • redact - DataPower Gateway (v5 compatible)
          • set-variable
          • switch
            • Writing switch condition scripts - DataPower API Gateway
            • Writing switch condition scripts - DataPower Gateway (v5 compatible)
          • throw
          • token-mediation
          • user-security
          • validate - DataPower API Gateway
          • validate - DataPower Gateway (v5 compatible)
          • validate-usernametoken
          • watsonx-ai-invoke
          • websocket-upgrade
          • xml-to-json
          • xslt
        • catch
        • properties
        • catalogs
        • activity-log
        • finally
    • Specifying a gateway type for an API definition
    • Referring to an extension in an API definition
    • Using $ref to reuse code fragments in your OpenAPI files
    • Creating a Product definition file
      • Product definition schema
      • Completing the information section of your Product description
      • Specifying a gateway type for your Product
      • Converting a Product YAML file to use DataPower API Gateway
      • Specifying the visibility of your Product
      • Referencing the APIs for your Product
      • Describing Plans in your Product
      • An example YAML representation of a Product
    • Using x-ibm-languages to create multilingual API and Product documentation
    • Using x-example to control the examples displayed in the CMS Portal
    • Using x-embedded-doc to add additional documentation to products and APIs
    • Using x-pathalias to give consistent URLs for products and APIs
    • Validating the YAML or JSON definition of an API or Product
    • Creating and using API and Product definitions templates
  • Working with global policies
    • Customizing the preflow policies
  • Adding an IBM managed gateway to your API Connect Enterprise as a Service instance
  • Configuring TLS profile for gateways
    • Accessing TLS configuration
    • Creating a TLS server profile
    • Creating a TLS client profile
    • Creating a keystore
    • Creating a truststore
  • Configuring Server Name Indication (SNI)
  • Reference
    • API Connect outbound IP addresses
    • API Connect context variables
    • OAuth context variables
    • Error cases supported by assembly catches
  • FAQs for designing and developing APIs
  • FAQs for gateways
• Managing AI services using IBM DataPower Interact Gateway
  • Using the AI view in API Studio
  • Getting started tutorials
    • Tutorial: Creating, publishing, and consuming MCP servers
    • Tutorial: Registering, publishing, and consuming Watsonx.ai
    • Tutorial: Registering, publishing, and consuming OpenAI
    • Tutorial: Registering, publishing, and consuming Google Gemini
    • Tutorial: Registering, publishing, and consuming Azure OpenAI
    • Tutorial: Registering, publishing, and consuming OpenAI-compatible provider
  • 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 secrets for LLM provider API keys
  • 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 for published assets
  • Using MCP servers in MCP hosts
    • Using MCP server in Visual Studio Code
• Managing your APIs
  • API management checklist
  • Using Engagement to automate notification tasks
    • Creating a notification task
    • Create scheduled reports
    • Engagement datasource
      • API events
      • Audit events
      • API summary
      • Config sync
      • Hearbeat
      • Metrics
  • Working with Catalogs
    • Creating and configuring catalogs
      • Additional catalog options
    • Managing simple aliases
      • Creating a simple alias at the catalog level
      • Creating a simple alias at the space level
      • Updating a simple alias
      • Deleting a simple alias
    • Configuring a private connection to AWS
    • Configuring Product visibility at a Catalog or Space level
    • Managing Catalog membership
    • Importing a user-defined policy into a Catalog
    • How to choose the right portal option
    • Importing an OpenAPI extension into a Catalog
    • Integrating with Postman
      • Configuring Postman settings at the provider organization level
      • Enabling Postman integration for a catalog
      • Managing Postman collections through the product lifecycle
  • Adding a remote gateway
    • Registering a remote DataPower API gateway
    • Registering a remote DataPower Nano Gateway
    • Deploying a remote DataPower API gateway
    • Deploying a remote Nano Gateway
  • Using Governance enforcement for validation
    • Configuring rulesets and enforcement type
    • Enabling governance enforcement to validate APIs and Products before publishing to a Catalog
  • Using syndication in API Connect
    • Enabling Spaces in a Catalog
    • Creating, modifying, and deleting Spaces
    • Working with Spaces
      • Managing Products in a Space
      • Managing subscription requests in a Space
      • Managing application subscriptions in a Space
      • Managing Space membership
      • Managing user access in a Space
  • Working with products
    • The product lifecycle
    • Managing your Products
      • Considerations when changing a product lifecycle with billing integration
      • Publishing a Product
        • Publishing a new Product
        • Replacing a Product with another Product
        • Superseding a Product with another Product
      • Migrating application subscriptions to another Product
      • Migrating application subscribers to new Product versions
      • Changing the availability of a Product
      • Deprecating a Product
      • Retiring a Product
      • Restaging a Product
      • Working with the subscriptions in a Product
      • Updating the gateway services for a Product
      • Removing a Product from a Catalog
      • Approving Product lifecycle and subscription requests
  • Working with APIs
  • Working with Plans
  • Working with consumer organizations
    • Creating a consumer organization
    • Editing a consumer organization
    • Deleting a consumer organization
    • Working with the applications in a consumer organization
    • Working with the subscriptions in a consumer organization
    • Working with consumer organization groups
    • Sending messages to consumer organization owners
  • Working with developer applications
  • Working with application subscriptions
  • Security and authentication
    • Creating a TLS client profile
      • Creating a keystore
      • Creating a truststore
      • Using OpenSSL to generate and format certificates
      • Viewing certificate details and adding certificates to a keystore or truststore
      • Defining elliptic curve cryptographic schemes for a TLS client profile
    • Authenticating by using your enterprise user registry
      • Working with user registries
        • Creating an Authentication URL user registry
        • Creating an LDAP user registry in API Manager
          • Using the CLI to create an organization-specific LDAP user registry
        • Creating a Local User Registry
        • Creating an OIDC user registry in API Manager
      • Modifying the configuration details for a user registry
      • Password lockout criteria
    • Configuring a native OAuth provider
      • Configuring basic settings for a native OAuth provider
      • Configuring scopes for a native OAuth provider
      • Configuring user security for a native OAuth provider
      • Configuring tokens for a native OAuth provider
      • Configuring token management and revocation for a native OAuth provider
      • Configuring introspection for a native OAuth provider
      • Configuring metadata for a native OAuth provider
      • Configuring the OIDC parameters for a native OAuth provider
      • Editing a native OAuth provider by using the API Editor
    • Configuring a third-party OAuth provider
    • OAuth concepts for API Connect
      • OAuth user scenario
      • OAuth introspection for third-party OAuth providers
      • OAuth external URL and authentication URL
      • Scope
      • Tokens
        • Refresh tokens
        • Token revocation
        • Authenticating and authorizing through a redirect URL
      • Authentication URL user registry
      • Custom forms for user security
        • Creating a custom HTML login form for user security
        • Creating a custom HTML authorization form for user security
      • Securing an API with a JSON Web Token
      • Troubleshooting OAuth
  • API Analytics
    • Catalogs, spaces, and analytics
    • Accessing analytics
    • Analytics dashboards
  • Configuring governance in the API Manager
    • The governance ruleset lifecycle in the API Manager
    • Updating rulesets and rules with the toolkit CLI
    • Scanning your catalogs and spaces
      • Using the toolkit CLI to scan your catalogs and spaces
  • Administering user access
    • Setting the expiration for invitations
    • Configuring notifications
      • Configuring sender details for email notifications
    • Viewing your user information
    • Adding provider organization users and assigning roles
    • Creating custom roles
    • Removing a user from a provider organization
    • Configuring LDAP group mappings on API Manager user roles
    • User management
      • Adding users to your provider organization
        • Inviting users to your provider organization
        • Editing user roles in your provider organization
        • Viewing user profiles in your provider organization
      • Adding user groups to your provider organization
        • Editing user groups in your provider organization
        • Viewing user group profiles in your provider organization
        • Deleting user groups from your provider organization
      • Adding teams to your provider organization
        • Editing teams in your provider organization
        • Viewing team profiles in your provider organization
        • Deleting teams from your provider organization
    • Migrating users, groups, and teams from webMethods API Gateway
      • Configuring the local user registry for migration
      • Configuring the APIC Transition Helper for migration
      • Migrating assets with dependency resolution from webMethods API Gateway
      • Migrating individual assets from webMethods API Gateway
  • Changing your API Manager password
  • Reviewing processing status and downloading gateway logs
  • Enabling Customer-facing DataPower Logging
  • Reference
    • Context variables in the task payload
    • Troubleshooting your billing configuration
  • Using Config Sync to replicate catalog data
    • Downloading and extracting the API Connect Config Sync utility
    • Setting environment variables for Config Sync
    • Enabling encrypted LUR user data sync
    • Running Config Sync as a stand-alone binary
    • Running Config Sync as a cronjob on OpenShift
    • Running Config Sync as a cronjob on Kubernetes
• Socializing your APIs using Consumer Catalog
  • Consumer organization lifecycle flow
    • Creating a new consumer organization
    • Editing the title of the consumer organization
    • Deleting a Consumer organization
    • Transferring the ownership of the consumer organization
  • Managing the members and invitations in the Consumer organization
    • Inviting a member to your consumer organization
    • Changing the role of an active member in your consumer organization
    • Resending a pending invitation
    • Deleting a member or invitation from your consumer organization
  • Reviewing analytics data of the consumer organization
  • Accessing Consumer Catalog using multiple user registries
    • Accessing the Consumer Catalog using Auth URL
    • Accessing the Consumer Catalog using LDAP
    • Accessing the Consumer Catalog using Local User Registry
    • Accessing the Consumer Catalog using OIDC
• Using the API Connect Backstage plug-in
  • Enabling the API Connect plug-in on Backstage
  • Enabling the API Connect plug-in on Red Hat Developer Hub
• Monitoring your API usage by using Analytics
  • Key concepts of API Connect analytics
  • API event record field reference
  • Summary API event record field reference
  • Offloading analytics data
    • Offloading analytics data to S3
      • Using QuickSight to view analytics
    • Offloading analytics data to Splunk
    • Offloading analytics data to Noname Security
  • Customize your analytics data
    • Activity log policy
    • Customizing data with a gateway script or set-variable operation
  • Accessing analytics in the API Connect UI
    • API Connect UIs
      • Accessing analytics in the API Manager UI
      • Accessing analytics in the Consumer catalog
      • Accessing analytics in the Developer Portal
    • AI insights and analysis for analytics
    • Export your analytics data
    • Sharing analytics data for API discovery
    • Analytics CLI
    • Analytics REST API
      • Using the events scroll operation to export analytics data
  • Frequently Asked Questions
• Using the DataPower Nano Gateway
  • DataPower Nano Gateway API assembly policies
    • Authenticate
    • Authorize
    • AzureOpenAiChatCompletions
    • AzureOpenAiEmbeddings
    • AzureOpenAiModels
    • AzureOpenAiModelsId
    • Block
    • cache
    • CircuitBreaker
    • SetAuthorization
    • Cors
    • CountLimit
    • ExtractIdentity
    • HandlebarsTemplate
    • IbmCloudLogin
    • If
    • Invoke
    • InvokeAwsLambda
    • LoadBalancer
    • LuaScript
    • Lua Script extension functions
    • OpenAiChatCompletions
    • OpenAiEmbeddings
    • OpenAiModels
    • OpenAiModelsId
    • OperationSwitch
    • Or
    • Parse
    • RateLimit
    • RetryIterator
    • Return
    • Redact
    • Remove
    • Set
    • SqlInjectionFilter
    • Transform
    • Switch
    • Throw
    • Try
    • UserDefined
    • Validate
    • WatsonxModels
    • WatsonxTextGen
    • WatsonxTokenize
    • GeminiModels
    • GeminiModelsId
    • GeminiGenerateContent
    • GeminiEmbedContent
    • GeminiBatchEmbedContents
    • GeminiCountTokens
  • Built-in JSONata functions supported by DataPower Nano Gateway
  • Managing external secrets for DataPower Nano Gateway
    • Using Azure as a Secrets Manager
    • Using HashiCorp Vault as a Secrets Manager
    • Using AWS as a Secrets Manager
  • Nano Gateway telemetry fields reference
  • Configuring plan rate limits for DataPower Nano Gateway with IBM API Studio
  • Porting APIs to DataPower Nano Gateway Using Porting Advisor
• Using Federated API Management
  • Overview
  • Getting Started
    • Connecting Runtimes
      • Connecting Amazon API Gateway
        • AWS agents core implementation logic
        • Co-relation between Amazon API Gateway and federated API management terminologies
        • Deploying the AWS Agent in Docker
          • Authentication for AWS agent implementation
        • AWS Lambda Implementation Overview
          • Deploying AWS agent in AWS Lambda functions
            • Environment variables applicable for Lambda functions
      • Connecting Azure API Management Service
        • Azure agents core implementation logic
        • Co-relation between Azure API Management Service and federated API management terminologies
        • Deploying the Azure Agent in Docker
        • Deploying Java Function in Azure that uses Azure CLI
          • Environment variables applicable for Azure API Management Service
      • Connecting Apigee API Management
        • Co-relation between Apigee API Management and federated API Management terminologies
        • Deploying the Apigee Agent in Docker
      • Connecting Kong Gateway
        • Co-relation between Kong Gateway and federated API management terminologies
        • Deploying the Kong Gateway Agent in Docker
      • Connecting MCP ContextForge Gateway
      • Connecting Third-party Gateway
  • Administering
    • User Management
      • Manage Users
        • Assigning groups to a user
      • User Profile
        • Modifying Profile Settings
        • Generating API Keys
  • Managing runtimes
    • Runtimes overview
  • Managing data planes
    • Data planes overview
  • Managing APIs
  • Managing MCP servers
  • Managing LLM Provider APIs
  • Managing administration APIs
  • Monitoring
    • Monitoring overall performance of assets
    • Monitoring performance of data planes
      • Metrics of data planes
    • Monitoring performance of runtimes
      • Metrics of runtimes
    • Monitoring performance of APIs
      • Metrics of APIs
    • Monitoring performance of MCP servers
      • Metrics of MCP Servers
    • Setting display preferences and thresholds
  • Developing agents
    • Agent overview
    • Agent implementation approaches
    • Agent deployment modes
    • Implementing agents for third-party gateways
      • Accessing the Agent SDK
      • Agent SDK interfaces and classes
      • Creating agents by using SDK
      • Building Gradle projects
      • Deploying agents in Docker
  • Administration APIs
• Using Developer Portal for consuming API assets
  • Overview
  • Configuring
    • Configuring SMTP settings
    • Configuring password policy
    • Specifying Developer Portal URL for reference from external systems
    • Specifying Cross-Origin Resource Sharing (CORS) URLs
    • Configuring default group and community for new users
    • Configuring the default language
    • Configuring personal profile settings
    • 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
  • 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 Product 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
      • 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
      • Third-party API Gateway configuration
        • Integrating third-party gateways with Developer Portal
        • Publishing APIs from third-party gateways to Developer Portal
        • Creating and attaching webhooks
        • Requesting applications for third-party Gateway APIs
        • Publishing API analytics to Developer Portal
      • 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
    • APIs
      • Creating APIs
      • Editing an API
      • Enriching an API
      • Creating new versions of API
      • Viewing code snippets of REST APIs
      • Downloading client Software Development Kit (SDK) for REST API resources
      • Trying APIs
        • Trying REST APIs
        • Trying SOAP APIs
        • Trying OData 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 product 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 products
      • Lifecycle feature considerations
      • Enabling lifecycle feature for APIs and API products
      • Modifying state of APIs
        • Changing the state of an API to expose it to consumers
        • Changing the state of a Live API
        • Changing an LLM provider API's state to retire it from usage
      • Modifying the state of API products
        • Changing lifecycle state of products
        • Changing lifecycle state of live products
        • Change state of products
    • Managing API programs
      • Hackathons
        • Creating hackathons
        • Inviting participants for API programs
        • Assigning owners for API 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
    • 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
      • Products
      • Payment gateway
      • Programs
      • Plans
      • Providers
      • Search
      • Teams
      • Topics
      • User requests
      • Users
      • Webhooks
  • Glossary
• Using Developer Portal for consuming AI assets
  • Overview
  • 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
    • Configuring default group and community for new users
    • Configuring the default language
    • Configuring personal profile settings
  • 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
    • Viewing audit log events
  • 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 Product 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
      • 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 product 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 the LLM provider APIs
      • Lifecycle feature considerations
      • Enabling lifecycle feature for LLM provider APIs
      • Modifying state of APIs
        • Changing the state of a LLM provider API to expose it to consumers
        • Changing the state of a Live API
        • Changing an LLM provider API's state to retire it from usage
    • 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
  • Reference
    • 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
      • Products
      • Payment gateway
      • Programs
      • Plans
      • Providers
      • Search
      • Teams
      • Topics
      • User requests
      • Users
      • Webhooks
  • Glossary
• Reference
  • The API Connect REST APIs
    • Example: Using the platform REST APIs to publish a product containing a SOAP API
      • Example Product file: globalweatherproduct_1.0.0.yaml
      • Example API definition: globalweather_1.0.0.yaml
      • Example WSDL file: globalweather.wsdl
  • Understanding your responsibilities when using API Connect