SSMNED_v10cd - Documentation Index

Table of Contents

• Welcome
• API Connect overview
  • What's new in the latest release (version 10.0.11.0)
    • What's new in Version 10.0.10.0
    • What's new in Version 10.0.9.0
  • Language versions offered by API Connect
  • Known limitations
  • API Connect concepts
    • Who does what in API Connect?
      • API Connect user roles
    • Packaging strategy and terminology in API Connect
      • Understanding rate limits for APIs and Plans
    • API Connect components
      • Gateway types
    • API Connect support
  • API Connect glossary
  • Accessibility features for IBM API Connect
  • Legal information
    • Tracking API volume for auditing and compliance
    • Notices
    • Terms and conditions for information centers
  • IBM API Connect Considerations for GDPR Readiness
  • Essential reading
• Tutorials
• Installing and maintaining IBM API Connect
  • Kubernetes, OpenShift, and Cloud Pak for Integration
    • Planning your deployment
      • Prerequisite skills for administering API Connect
      • Key concepts: Custom Resources, Operators, and Operands
      • Deployment overview for endpoints and certificates
      • Deployment profiles, topologies, and strategies
        • Deployment and component profiles
          • API Connect deployment profiles for OpenShift and Cloud Pak for Integration
          • Component profiles, CPU limits, memory limits, and licensing
            • Management subsystem deployment profile limits
            • Portal component deployment profile limits
            • Analytics component deployment profile limits
            • DataPower gateway deployment profile limits
        • Multiple data center deployment strategies
          • Two data center warm-standby deployment on Kubernetes and OpenShift
          • Two data center deployment examples and diagrams
        • OpenShift: Deciding to use individual CRs, a top-level CR, or Cloud Pak for Integration
      • Network requirements for inter-subsystem communication
        • Enable JWT security instead of mTLS
        • In-cluster service communication between subsystems
      • Kubernetes ingress controller prerequisites
      • Persistent Volume (PV) requirements
      • Load balancer configuration
      • Firewall requirements
      • Planning your analytics deployment
      • Key Concepts: Cert-manager, Issuers, and Secrets
      • Webhooks deployed and managed by the API Connect Operator
      • Administering API Connect in your container environment
        • Namespaces in your container environment
        • Custom Resources and Custom Resource Definitions
        • Managing your API Connect CRs
    • Installing API Connect
      • Deployment requirements
        • IBM API Connect Version 10 software product compatibility requirements
        • API Connect licenses
      • Deployment procedures
        • Obtaining product files
          • Verifying the integrity of IBM product files
        • Deploying on Kubernetes
          • Deploying operators and cert-manager
            • Deploying operators in a single-namespace API Connect cluster
            • Deploying operators in a multi-namespace API Connect cluster
            • Installing cert-manager and certificates in a two data center deployment
            • Customizing certificates during installation on Kubernetes
              • Generating custom certificates using cert-manager
              • Generating custom certificates using cert-manager in a two data center deployment
              • Generating custom certificates manually
              • Deploying API Connect subsystems with custom certificates
          • Installing the API Connect subsystems
            • Installing the management subsystem
            • Installing the gateway subsystem
            • Installing the developer portal subsystem
              • Defining multiple portal endpoints for a Kubernetes environment
            • Installing the analytics subsystem
              • Creating the analytics CR
              • Installing analytics
          • Installing a two data center deployment on Kubernetes
            • Converting a single data center to a two data center deployment on Kubernetes
          • Troubleshooting installation on Kubernetes
        • Deploying on OpenShift and Cloud Pak for Integration
          • Configuring FIPS support on OpenShift
          • Preparing for installation
            • Operator, CASE, and platform requirements
            • API Connect configuration settings
              • Basic configuration settings
              • Management subsystem settings
              • Gateway subsystem settings
              • Developer Portal subsystem settings
              • Analytics subsystem settings
              • Additional Kubernetes settings
            • Configuring timeouts for management endpoints
          • Installation procedures with IBM Cloud Pak for Integration
          • Installing API Connect in a single namespace on OpenShift
            • Installing operators
            • Setting up a certificate issuer
            • Installing the management subsystem in a shared namespace
            • Installing the gateway subsystem in a shared namespace
            • Installing the portal subsystem in a shared namespace
            • Installing the analytics subsystem in a shared namespace
          • Installing API Connect subsystems in different namespaces or environments on OpenShift
            • Installing operators
            • Installing the management subsystem
            • Extracting the management ingress-ca certificates
            • Installing the gateway subsystem
            • Installing the portal subsystem
            • Installing the analytics subsystem
          • Installing with the top-level CR on OpenShift
            • Installing operators
            • Installing API Connect
          • Air-gapped installation
            • Installing with a bastion host
            • Installing with a portable computer or storage device
          • Installing a two data center deployment with Cloud Pak for Integration
            • Planning and initial preparation
            • Preparing your active data center
            • Preparing your warm-standby data center
            • Installing API Connect on the active data center
            • Installing API Connect on the warm-standby data center
          • Installing a two data center deployment on OpenShift
            • Planning and initial preparation
            • Preparing your active data center
            • Preparing your warm-standby data center
            • Installing API Connect on the active data center
            • Installing API Connect on the warm-standby data center
          • Enable additional features post-install
            • Enable management CA verification on REST API calls
            • Enable JWT security and disable mTLS between subsystems
          • Troubleshooting installation on OpenShift
    • Upgrading API Connect
      • Upgrading on Kubernetes
        • Planning your API Connect upgrade on Kubernetes
        • Pre-upgrade preparation and checks on Kubernetes
        • Upgrading DataPower Operator and Operand independently of the APIC
        • Upgrading API Connect on Kubernetes
          • Upgrading the management subsystem on Kubernetes
          • Upgrading the portal subsystem on Kubernetes
          • Upgrading the analytics subsystem on Kubernetes
          • Upgrading the gateway subsystem on Kubernetes
        • Troubleshooting upgrades on Kubernetes
          • Enabling gateway peering and verifying cluster status
      • Upgrading on OpenShift and Cloud Pak for Integration
        • Planning your API Connect upgrade on OpenShift
          • Operator, CASE, and platform requirements for upgrading
        • Pre-upgrade preparation and checks on OpenShift
          • Resolving duplicate users before upgrade on Cloud Pak for Integration
          • Pre-upgrade preparation for air-gapped environment using a bastion host
          • Pre-upgrade preparation for air-gapped environment using a portable storage device
        • Upgrading API Connect on OpenShift
        • Troubleshooting upgrade on OpenShift
      • Upgrading a 2DCDR deployment on Kubernetes and OpenShift from V10.0.7 or later
      • Upgrading a 2DCDR deployment on Kubernetes and OpenShift from V10.0.9
      • Upgrading a 2DCDR deployment on Cloud Pak for Integration from V10.0.7 or later
      • Upgrading a 2DCDR deployment on Cloud Pak for Integration from V10.0.9
    • Maintaining API Connect
      • Advanced configuration
        • Installing License Service
        • Installing the Automated API behavior testing application
        • Installing the toolkit
        • Customizing user-facing certificates
        • Changing deployment profiles on Kubernetes and OpenShift
        • Changing deployment profiles on OpenShift top-level CR
        • Changing the deployment profile on Cloud Pak for Integration
        • Replica override for microservices
        • Enabling Developer Portal feature flags on Kubernetes
        • Enabling Developer Portal feature flags on OpenShift and Cloud Pak for Integration
        • Enabling UI feature flags on Kubernetes
        • Enabling UI feature flags on OpenShift and Cloud Pak for Integration
        • Advanced configuration for the management subsystem
          • Updating management subsystem password, keys, and secrets
            • Changing the cloud administrator password
            • Changing the database encryption key
            • Changing the registration client_id and client_secret for applications
          • Configuring maximum size of client requests to the Management subsystem
          • Setting rate limits for public APIs on the management service for a Kubernetes environment
          • Enabling API discovery on Kubernetes
          • Enabling governance on Kubernetes
          • Enabling API Agent for the management subsystem
          • Configuring monetization on Kubernetes
          • Restarting the Management subsystem pods
          • Disabling the PodDisruptionBudget (PDB) for the management EDB database
          • Postgres database shutdown
            • Shutting down the Postgres database in the Management subsystem on different environments
            • Starting the Postgres database in the Management subsystem on different environments
          • Advanced configuration for Postgres components on Kubernetes V10.0.7.0 and later
            • Configuring zone affinity in the management subsystem
          • Postgres database shutdown
            • Shutting down the Postgres database in the Management subsystem on different environments
            • Starting the Postgres database in the Management subsystem on different environments
          • Disabling the status feedback on products page
        • Advanced configuration for the analytics subsystem
        • Advanced configuration for the gateway subsystem
          • Customizing a DataPower deployment
          • Updating the gateway password, secrets, and certificates
            • Changing the gateway administrator password
            • Changing the gateway client secret
            • Updating the gateway peering certificate
            • Updating the gateway director and invocation endpoint profiles
          • Overriding the default DataPower image, version, and license
          • Overriding pod CPU and memory settings
          • Enabling autoscaling of gateway pods
          • Configuring rate limits on the gateway nodes
          • Dynamically re-registering and reconfiguring a Gateway service in a Kubernetes deployment
          • Overriding DataPowerService spec properties
        • Advanced configuration for the portal subsystem
          • Updating portal keys and secrets
            • Changing the secret for portal data and system tools
            • Changing the portal client_secret
      • Backing up, restoring, and disaster recovery
        • Backing up and restoring the management subsystem
          • Taking a management infrastructure configuration backup
          • Configuring management database backups
          • Running an on-demand backup of the management database
          • Restoring from a management database backup
            • Restoring the management database with a backup CR
            • Restoring the management database with a backup ID
          • Recovering from a disaster
          • Troubleshooting management database backup and restore
        • Backing up and restoring the developer portal
          • Taking a portal infrastructure configuration backup
          • Configuring portal database backups
          • Running an on-demand backup of the portal database
          • Managing your remote portal database backups
          • Restoring from a portal database backup
          • Recovering from a disaster
          • Troubleshooting portal database backup and restore
        • Backing up and restoring the analytics subsystem
        • Backing up and restoring on OpenShift top-level CR
          • Backing up your OpenShift top-level CR API Connect deployment
          • Disaster recovery on OpenShift top-level CR
        • Backing up and restoring on Cloud Pak for Integration and OpenShift top-level CR
          • Backing up your Cloud Pak for Integration API Connect deployment
          • Recovering from a disaster on Cloud Pak for Integration
      • Maintaining a two data center deployment
        • Key concepts of 2DCDR and failure scenarios
        • Failing over to the warm-standby
        • Backup and restore requirements for a 2DCDR deployment
        • Removing a two data center deployment
        • Verifying replication between data centers
        • Synchronizing the ingress-ca certificates between sites
        • Troubleshooting a two data center deployment
      • Renewing TLS certificates
        • Renewing cert-manager controlled certificates
          • Renewing the management-ca with the ManagementSecretRotation CR
          • Renewing the portal-ca with the PortalSecretRotation CR
          • Renewing the analytics CA
          • Renewing the ingress-ca
            • Copying renewed ingress-ca to subsystems in different namespaces
          • Renewing end-entity certificates
          • Monitoring cert-manager certificate renewal
        • Renewing custom certificates
        • List of Issuers, CA certificates, and secrets
        • List of ingress certificates
        • List of intra-subsystem certificates
        • V2018 upgrade: List of certificates to update manually
        • Renewing certificates in a two data center deployment on Kubernetes and OpenShift
      • Monitoring and health checks
        • Monitoring on Kubernetes
          • Monitoring subsystems on Kubernetes
          • Monitoring Postgres disk usage
          • Monitoring platform health using Kubernetes events
        • Monitoring on OpenShift
          • Monitoring the API Connect cluster on OpenShift
          • Monitoring Postgres disk usage on OpenShift
          • Monitoring platform health on Red Hat OpenShift using Kubernetes events
        • Monitoring on Cloud Pak for Integration
          • Monitoring the API Connect cluster on Cloud Pak for Integration
          • Monitoring Postgres disk usage on Cloud Pak for Integration
        • Obtaining simple health check data of Developer Portal sites by using a REST API call
        • Monitoring subsystem health checks
      • Logging
        • Gathering logs
        • Changing logging levels
      • Troubleshooting
        • Power-cycling check on OpenShift and Cloud Pak for Integration
    • Uninstalling API Connect
      • Uninstalling API Connect subsystems
      • Removing API Connect
      • Removing API Connect on OpenShift or Cloud Pak for Integration
  • Migrating from v10 to v10 on a different form factor
    • v10 migration overview
    • v10 migration requirements
    • v10 migration steps
      • Preparing the source system
      • Installing the target system on Kubernetes, OpenShift, and Cloud Pak for Integration
      • Restoring the target system on Kubernetes, OpenShift, and Cloud Pak for Integration
      • Verifying the target system on Kubernetes, OpenShift, and Cloud Pak for Integration
    • Migrating from OpenShift to Cloud Pak for Integration on the same cluster
    • v10 migration troubleshooting
  • The API Connect operations tool: apicops
  • Using Config Sync to replicate consumer-side catalog data
    • Downloading the Config Sync utility
    • Running Config Sync as a standalone binary
• Configuring and managing your server environment
  • Cloud Manager configuration checklist
  • Activating your Cloud Manager user account
  • Accessing the Cloud Manager user interface
  • Defining your Cloud Manager topology
    • Creating an availability zone
    • Registering a gateway service
    • Registering an event gateway service
    • Registering an analytics service
    • Registering a portal service
    • Associating an analytics service with a gateway service
    • Associating an OpenTelemetry configuration with a gateway service
      • Creating an OpenTelemetry configuration
    • Setting visibility for a service
  • Managing authentication and security
    • User registries overview
      • Configuring an Authentication URL user registry
      • Configuring a shared custom user registry
      • Configuring an LDAP user registry in the Cloud Manager
        • Using the CLI to configure a shared LDAP user registry
      • Configuring a Local User Registry
      • Configuring an OIDC user registry in Cloud Manager
      • Setting visibility for a user registry
      • Deleting a user registry
      • Removing a user from a user registry
        • Removing yourself from a user registry
        • Removing another user from a user registry
    • TLS profiles overview
      • Creating a TLS server profile
      • Creating a TLS client profile
        • Defining elliptic curve cryptographic schemes for a TLS client profile
      • Creating a keystore
      • Creating a truststore
      • Managing TLS profiles, keystores, and truststores
      • Using OpenSSL to generate and format certificates
    • OAuth Provider overview
      • 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
        • Configuring scopes for a third-party OAuth provider
      • Setting the visibility for OAuth providers
      • OAuth concepts for API Connect
        • OAuth user scenario
        • OAuth introspection for third-party OAuth providers
        • Oauth metadata URL and authentication URL
        • Scope
        • Tokens
          • Refresh tokens
          • OAuth revocation URL
          • Authenticating and authorizing through a redirect URL
          • Token management with the DataPower Gateway (v5 compatible)
          • Token management with the DataPower API Gateway
        • Authentication URL
        • 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
  • Configuring the cloud settings
    • Change the name of your cloud
    • Configuring an email server for notifications
    • Setting up notifications
      • Customizing email notification templates
    • Configuring invitation timeouts
    • Configuring API key settings
    • Using the CLI to modify cloud settings
    • Configuring Base64 encoding for temporary tokens
    • Configuring the password-reset notification and timeout
    • Selecting user registries for Cloud Manager and API Manager
      • Setting a default user registry for Cloud Manager and API Manager
    • Configuring timeouts for access tokens and refresh tokens
    • Viewing platform and UI endpoints
    • Configuring the default gateway services for Catalogs
    • Managing the public/private key pairs for signing tokens
      • Configuring public/private key pairs for tokens
  • Configuring governance in the Cloud Manager
    • The governance ruleset lifecycle in the Cloud Manager
    • Updating rulesets and rules with the toolkit CLI
  • Administering provider organizations
    • Creating a provider organization
    • Editing a provider organization
    • Deleting a provider organization
    • Viewing current provider organizations
    • Sending messages to provider organization owners
  • Administering members and roles
    • Creating roles in the admin organization
    • Editing roles in the admin organization
    • Configuring LDAP group mappings on Cloud Manager user roles
    • Deleting roles in the admin organization
    • Viewing members and roles
    • Adding members to the admin organization
    • Assigning roles to members
    • Deleting a member
    • Role Defaults overview
      • Managing role defaults for provider organizations
  • Monitoring the cloud
    • Accessing and configuring analytics
    • Configuring audit logging to monitor user operations
      • Configuring the audit settings
    • Reviewing processing status and downloading gateway logs
  • Changing your Cloud Manager password and profile information
  • Resolving login problems by increasing HTTP header size
  • Onboarding a new admin for Cloud Pak for Integration
  • Extending the Gateway server behavior
    • Gateway extension guidelines - DataPower Gateway (v5 compatible)
    • Gateway extension guidelines - DataPower API Gateway
      • Gateway extensions manifest
        • GWD extension type
          • config-sequence
          • parse-settings
          • analytics-endpoint
          • front-side-handler
          • apigw
          • tls-client
          • api-collection
          • api-plan
          • registry
          • oauth-provider
          • api-definition
          • assembly
        • CLI command file extensions
      • v5 policy emulation limitations
    • Configuring your Gateway server extensions
  • Cloud Manager Tutorials
    • Tutorial: Configuring the Cloud
    • Tutorial: Creating a Provider Organization
• Creating, deploying, and publishing APIs using API Agent
  • API Agent user roles
  • Configuring
    • Watsonx.ai settings
    • API Agent settings
    • API Agent sources
      • API Connect catalogs and drafts
      • Application sources
    • Secure communication between Visual Studio Code plug-in and API Connect
    • MTLS for connectivity pack applications
  • Using API Agent
    • Getting started
    • API Agent overview
    • Uninstalling 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 testing a draft API
  • API Agent tools
    • Artifacts Searcher
    • OAS Creator
    • API Governance
    • API Connect Tester
    • API Connect Task
      • API-related operations
      • Product-related operations
      • Consumer application operations
      • List operations
      • Plans with multiple tool operations
    • OpenAPI Python Generator
    • OpenAPI Enhancer
    • OpenAPI Generator
    • Code deployment
  • Prompts library
  • Troubleshooting
  • Known limitations
• Developing your APIs and applications
  • 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
  • Working with the toolkit
    • Installing the toolkit
    • Logging in from API Designer
      • Setting the locale for API Designer
      • Switching clouds from API Designer
      • Working offline with API Designer
      • Gathering support information in API Designer
    • Using the developer toolkit command-line tool
      • Overview of the command-line tool
      • Logging in to a management server
      • Logging in to a management server with an OIDC registry
      • Cloud administration commands
      • API development and management commands
        • Configure user limit and invitation resend interval for Consumer organization
      • Creating APIs and applications
      • Publishing APIs and applications
      • Managing API Products
      • Working with Drafts
      • 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
  • Searching for items in API Manager
  • Working with API definitions
    • Using the AI Gateway to support APIs for AI applications
      • Using the AI Gateway to support watsonx.ai APIs
      • Using the AI Gateway to support OpenAI APIs
      • Using the AI Gateway to support Gemini APIs
      • Using the AI Gateway to support Azure OpenAI APIs
      • AI Service Introduction
    • Creating an API definition
      • Creating a REST proxy API from a target service
      • Creating a REST proxy API from an existing OpenAPI service
      • Creating a REST proxy API from an existing WSDL service
      • Creating a SOAP proxy API from an existing WSDL service
      • Creating a new REST OpenAPI definition
      • Adding a REST API by importing an OpenAPI definition file
      • Adding a SOAP API by importing a zip file
      • Creating a GraphQL proxy API
        • Using the GraphQL schema editor
        • Supporting introspection for a GraphQL API
        • Enabling the GraphiQL editor for a GraphQL API
        • Enabling the cost endpoint for a GraphQL API
        • Securing a GraphQL API by using a client ID
        • Request mechanisms supported by GraphQL endpoints
        • GraphQL custom schema directives and scalar types
        • @remove directive
        • GraphQL limitations
      • Importing an API from the CP4I asset repository
      • Importing an AsyncAPI from Event Endpoint Management
      • Creating an AsyncAPI with Event Endpoint Management
      • Creating a REST proxy for watsonx.ai with the AI Gateway
        • Creating a custom product for a watsonx.ai API
      • Creating a REST proxy for OpenAI with the AI Gateway
        • Creating a custom product for an OpenAI API
      • Creating a REST proxy for Gemini with the AI Gateway
        • Creating a custom product for a Gemini API
      • Creating a REST proxy for Azure OpenAI with the AI Gateway
        • Creating a custom product for an Azure OpenAI API
    • Editing an OpenAPI 2.0 API definition
      • Specifying API metadata
      • Specifying the host for an API
      • Specifying the basepath for an API
      • Specifying the schemes for an API
      • Specifying the MIME types that an API consumes
      • Specifying the MIME types that an API produces
      • Enforcing security requirements on an API
        • Defining security schemes
          • Defining basic authentication security schemes
          • Defining API key security schemes
            • Client ID behavior in API key security definitions
          • Defining OAuth2 security schemes
        • Enabling CORS support for an API
      • Specifying external documentation for an API
      • Adding tags to an API
      • Defining Paths for an API
        • Defining parameters for a path
        • Defining operations for a path
          • Adding tags to an operation
          • Specifying external documentation for an operation
          • Specifying the MIME types that an API operation produces
          • Specifying the MIME types that an API operation consumes
          • Defining parameters for an operation
          • Defining responses for an operation
          • Specifying schemes for an operation
          • Enforcing security requirements on an operation
      • Defining schema definitions for an API
        • Creating schema definitions
        • Editing schema definitions
      • Defining parameters for an API
        • Creating a parameter
        • Editing a parameter
      • Defining responses for an API
        • Creating a response
        • Editing a response
      • Specifying gateway and portal settings
      • Defining target services for an API
      • Setting API properties
        • Defining Catalog specific property values
      • Configuring application authentication for an API
      • Configuring activity logging
      • Configuring v5 compatibility options
      • Including elements in your API assembly
        • The assembly editor
        • Adding elements to your assembly
        • Handling errors in the assembly
      • Specifying the gateway type for an API definition
      • Converting an API definition for deployment to the DataPower API Gateway
      • Modifying a GraphQL schema
      • Validating the OpenAPI YAML source
      • Validating an API or product document by using the governance service
        • Validating an API or product document by using the toolkit CLI
    • Editing an OpenAPI 3.0 API definition
      • OpenAPI 3.0 support in IBM API Connect
      • Specifying API metadata
      • Defining servers for an API
      • Enforcing security requirements on an API
        • Enabling CORS support for an API
      • Specifying external documentation for an API
      • Adding tags to an API
      • Defining Paths for an API
        • Defining servers for a Path
        • Defining parameters for a Path
        • Defining operations for a Path
          • Adding tags to an operation
          • Specifying external documentation for an operation
          • Defining parameters for an operation
          • Defining the request body for an operation
          • Defining responses for an operation
          • Enforcing security requirements on an operation
          • Defining servers for an operation
      • Defining components for an API
        • Defining schema components
          • Creating a schema component
          • Editing a schema component
        • Defining response components
          • Creating a response
          • Editing a response
          • Creating a content definition
          • Editing a content definition
          • Creating an encoding definition
          • Editing an encoding definition
        • Defining parameter components
          • Creating a parameter
          • Editing a parameter
        • Defining example components
          • Creating an example
          • Editing an example
        • Defining request body components
          • Creating a request body
          • Editing a request body
        • Defining header components
          • Creating a header
          • Editing a header
        • 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
        • Defining link components
          • Creating a link
          • Editing a link
      • Specifying gateway and portal settings
      • Defining target services for an API
      • Setting API properties
        • Defining Catalog specific property values
      • Configuring application authentication for an API
      • Configuring activity logging
      • Including elements in your API assembly
        • The assembly editor
        • Adding elements to your assembly
        • Handling errors in the assembly
      • Validating the OpenAPI YAML source
      • Validating an API or product document by using the governance service
        • Validating an API or product document by using the toolkit CLI
    • LDAP authentication
    • Authentication URL user registry
    • Activating an API
    • Testing an API
      • Locating API information on the Endpoints tab
      • Using the Test tab to debug your API
        • Preparing an API for debugging with the Test tab
        • Specifying the testing preferences for an API
        • Sending the API request
        • Reviewing the API response and trace
        • Testing a GraphQL API with the Test tab
      • Testing an API with Automated API behavior testing
        • Getting started
          • Creating a test suite
          • Modifying a test suite
          • Deleting a test suite
          • Creating a test case
          • Modifying a test case
          • Deleting a test case
          • Defining variables
          • Running published test cases
          • Viewing a test report
          • Publishing a test case
          • Tagging a test
        • API Hooks
          • Creating an API Hook
          • Creating API Keys and Secrets
          • Using API Hooks
            • List all tests
            • Run All Published Tests
            • Run Published Tests By Tag
            • Run Published Test By ID
        • Test definition syntax
        • Tutorial: Invoking test cases from Jenkins with JUnit result format
        • AutoTest Assist
          • Creating an AutoTest profile
          • Modifying an AutoTest profile
            • API Extensions
          • Deleting an AutoTest profile
          • Running an AutoTest profile
          • Viewing the AutoTest report
          • Profile Configuration
          • Profile Security
          • Data Generation Rules
      • Testing an API with the policies editor
      • Testing an API with the Local Test Environment
      • Testing an API with the Explorer tab
    • Staging an API
    • Publishing an API
    • Creating a new version of an API definition
    • Updating an API definition from a file
    • Updating a SOAP API
    • Renaming an API definition
    • Changing an API rate limit
    • Adding an OpenAPI extension to an API
    • Downloading an API definition
    • Deleting an API definition
    • Using an options file when importing a WSDL service
    • Variable references in API Connect
    • API properties
    • 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
        • OAuth
          • Example - using multiple OAuth policies in an OAuth provider assembly
        • openai invoke
        • Azure openai invoke
        • Parse
        • Proxy
        • Rate Limit
          • Configuring a rate, burst, or count limit on the DataPower API Gateway
        • 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
    • Tags in API Connect
  • Working with Products
    • Creating a draft Product
    • Downloading a draft Product
    • Importing a draft Product
    • Searching for a draft Product
    • Editing a draft Product
      • Defining rate limits for an API operation
    • Staging a draft Product
    • Publishing a draft Product
    • Creating a new version of your Product
    • Specifying the gateway type for a Product
    • Deleting a draft Product
    • Organizing your Products into categories
  • 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
          • log
          • map
          • 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-defined policies
          • 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 Developer 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
  • Reference
    • API Connect context variables
    • OAuth context variables
    • Error cases supported by assembly catches
    • API and Product definition template examples
    • Template variables for API and Product definitions
• Learn to manage your APIs
  • API management checklist
  • Activating your API Manager user account
  • Accessing the API Manager user interface
  • Searching for items in API Manager
  • Using Engagement to automate notification tasks
    • Creating a notification task
    • Engagement datasource
      • API events
      • Audit events
      • API summary
      • Config sync
  • Working with Catalogs
    • Creating and configuring catalogs
      • Additional catalog options
    • Configuring Product visibility at a Catalog or Space level
    • Configuring sub paths for Developer Portal sites
    • Consumer Catalog and Developer Portal considerations
    • Managing Catalog membership
    • Importing a user-defined policy into a Catalog
    • Importing an OpenAPI extension into a Catalog
    • Retaining Version 5 vanity endpoint behavior in a Catalog
    • Protecting catalog properties
  • [Technology preview] Using Governance enforcement for validation
    • [Technology preview] Configuring rulesets and enforcement type
    • [Technology preview] Enabling governance enforcement to validate APIs and Products before publishing to a Catalog
  • Managing the application lifecycle
    • Approving application upgrade requests
  • 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
      • Managing Gateways in a Space
  • Working with products
    • The product lifecycle
    • Monetizing your products
      • Adding a billing integration resource
        • Billing integration resource job queues
      • Adding a billing integration resource to a Catalog
      • Defining a Product with billing integration
    • 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 organization-specific custom 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
        • Token management with the DataPower Gateway (v5 compatible)
        • Token management with the DataPower API Gateway
      • 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
  • Changing your API Manager password
  • Resolving login problems by increasing HTTP header size
  • Reviewing processing status and downloading gateway logs
  • Reference
    • API gateway response codes
    • Troubleshooting your billing configuration
  • API Manager tutorials
    • Tutorial: Creating a proxy REST API definition
    • Tutorial: Creating a SOAP API
    • Tutorial: Creating a REST API definition that invokes an existing SOAP service
    • Tutorial: Mapping JSON Content
    • Tutorial: Importing an API
    • Tutorial: Supersede a Product
    • Tutorial: Implementing OAuth Security
    • Tutorial: Implementing OIDC Security
    • Tutorial: Generate a JSON Web Token (JWT)
    • Tutorial: Validate a JSON Web Token (JWT)
    • Tutorial: Creating a Client Application
    • Tutorial: How to monetize an API Product
  • 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
• Authoring policies
  • Authoring policies for the DataPower Gateway (v5 compatible)
    • Describing your policy
    • Creating a new user-defined policy
      • Implementing your policy
    • Packaging and importing your policies into IBM API Connect
    • Reference
      • Implementation code examples
  • Authoring policies for the DataPower API Gateway
    • Defining, packaging and publishing a catalog-scoped policy for the API Gateway
      • Structure of the catalog-scoped user-defined policy YAML file
    • Defining, packaging, and publishing a global-scoped policy for the API Gateway
• Socializing your APIs using Developer Portal
  • Using the Developer Portal
    • Logging in as a consumer to the Developer Portal by using the CLI
    • Exploring APIs and Products in the Developer Portal
      • How to use a URL to navigate directly to a Product or API in the Developer Portal
      • Testing an API by using the Developer Portal test tool
      • Calling an API
        • Calling an API by using CORS
    • Applications in the Developer Portal
      • Registering an application
      • Upgrading a Development application to Production status
      • Managing applications
      • Editing an application
      • Deleting an application
      • Changing an application image
      • Verifying an application client secret
    • Analytics in the Developer Portal
      • Application analytics in the Developer Portal
      • Organization analytics in the Developer Portal
    • Consumer organizations in the Developer Portal
      • Adding a Consumer organization from within the Developer Portal
      • Editing the name of a Consumer organization
      • Switching Consumer organizations
      • Adding users to a Consumer organization
      • Removing a user from a Consumer organization
      • Changing the ownership of a Consumer organization
      • Deleting a Consumer organization
    • User accounts, passwords, and support in the Developer Portal
      • Creating a new developer account
      • Changing your account settings
      • Deleting your developer account
  • Configuring the Developer Portal site
    • Concepts in the Developer Portal
    • Getting started configuring the Developer Portal site
    • Appearance
      • Controlling general appearance elements in the Developer Portal
        • Changing the shortcut icon
        • Changing the site email address
        • Changing the site logo
        • Changing the site name or site slogan
        • Changing the visibility of site branding
      • Adding custom JavaScript to a custom theme
      • Applying a modified content type template
      • Creating a sub-theme
      • Installing additional themes
      • Deleting themes
    • Content
      • Adding content elements in the Developer Portal
        • Adding and configuring meta tags
          • Disabling external search engine indexing
        • Adding custom pages
        • Integrating X data into the social block
          • Editing the social block
        • Adding content in multiple languages
        • Adding custom pages to APIs and Products
        • Adding new frequently asked questions
        • Applying an image to an API or Product
        • Attaching a documentation file to APIs
        • Configuring blogs
        • Configuring the taxonomy menu block
        • Customizing the URL alias for a specific API or Product page
        • Embedding multimedia in site content
        • Linking from one piece of site content to another
        • Linking to social media sites
        • Managing tags in the Developer Portal
          • Tagging APIs based on their lifecycle phase
        • Posting a poll
        • Adding images to site content
      • Configuring and restricting content in the Developer Portal
        • Creating content types
          • Adding fields to content types
        • Configuring documentation upload limitations
        • Configuring image upload limitations
        • Configuring the appearance of ratings in the Developer Portal
        • Customizing the privacy policy statement
        • Customizing the terms of use statement
        • Editing a site comment
        • Editing sample content
        • Editing tags for a specific item
      • Turning content on or off in the Developer Portal
        • Deleting a site comment
        • Deleting blocks
        • Disabling blogs
        • Deleting forums from the front page
        • Turning comments for specific content types on or off in the Developer Portal
        • Turning comments off for an individual item
        • Turning off ratings for specific content types in the Developer Portal
    • Structure
      • Configuring the front page
        • Disabling blogs
        • Deleting forums from the front page
      • Adding a menu
      • Adding and changing the blocks displayed on Developer Portal pages
      • Changing the front page banner block
      • Changing the front page Featured Content block
      • Changing the case studies content block on the front page
      • Changing the items in the main menu
      • Changing the ratings display
      • Displaying APIs and Products in categories
        • Enabling dynamic category creation
      • Implementing an image carousel
      • Making your application's image public
      • Providing navigation by tag hierarchy
      • Using the Views module in the Developer Portal
        • Creating views in the Developer Portal
        • Configuring the search results view in the Developer Portal
        • Configuring the default number of items in a view list in the Developer Portal
    • Configuration
      • Configuring content moderation
        • Editing, reviewing, and publishing moderated content
      • General configuration tasks
        • Adding a page load progress indicator
        • Adding custom fields to user records
        • Checking the site status report
        • Clearing the server caches
        • Configuring a proxy
        • Configuring the visibility of analytics in the Developer Portal
        • Configuring the API details visibility for non-authenticated users
        • Configuring API product recommendations
        • Adding a case study
          • Configure the case study module
        • Configuring Stripe in the Developer Portal
        • Configuring cron to run scheduled tasks
        • Configuring search indexes and servers
        • Configuring the date and time
        • Configuring the notifications event log settings
        • Configuring the application settings
        • Configuring the site default time zone
        • Configuring the site error handling
        • Configuring which buttons are displayed in the WYSIWYG rich text editor
        • Configuring which languages are available
        • Customizing user account settings
        • Disabling languages
        • Disabling test tool restrictions
        • Enabling a cookie compliance banner
        • Enabling code languages for code snippets
        • Enabling code snippets for SOAP APIs
        • Forcing new users to accept terms and conditions
        • Hiding the admin registry on the login form
        • Hiding the certificate in the header for APIs secured with mutual TLS
        • Importing and exporting taxonomies
        • Removing keys beginning with x-ibm from Open API document download
        • Restricting access by IP address
        • Restricting or preventing access from search engines
        • Toggling the site in and out of maintenance mode
        • Viewing available updates
      • Managing Developer Portal security
        • Configuring CAPTCHA
        • Configuring reCAPTCHA
        • Configuring session timeout and limit
        • Configuring the timeout length for the password reset link
        • Configuring your site password policy
        • Disabling CORS warnings
        • Disabling live testing of APIs
        • How to enable penetration testing, and information about Developer Portal cookies
        • How to manage IP security in the Developer Portal
        • Managing banned IP addresses
        • Using flood control for login security
        • Login security
        • Using the Security kit
        • Using Honeypot for spam protection
    • People
      • Blocking and unblocking specific users
      • Controlling access to Developer Portal content
      • Creating a developer account to customize API properties
      • Email Subscribers
        • Emailing all subscribers
        • Emailing API subscribers
        • Emailing plan subscribers
        • Emailing product subscribers
        • Emailing consumer organizations
        • Token reference
      • How to style the Developer Portal emails
      • Working with roles in the Developer Portal
        • Creating administrator users for the Developer Portal
        • Assigning users to a role
        • Assigning permissions to a role
        • Creating a new role
    • Forums
      • Creating a new forum
      • Creating new forum containers
      • Configuring the creation of new forums for each API
      • Locking forum topics
      • Marking content in a forum as sticky
      • Removing forum posts
      • Turning off forums in the Developer Portal
    • Reports
    • Extend
      • Custom module development: an introduction to Drupal tools for PHP development
      • Custom module development: background and prerequisites
      • Custom module development: creating a module skeleton
      • Custom module development: using hooks
      • Installing custom modules
      • Deleting custom modules
      • Disabling modules
      • Using Developer Portal metadata on API Manager
      • Using a custom module for payment method creation
  • Managing the Developer Portal by using the toolkit CLI
    • Getting started with the Portal CLI commands
    • Developer Portal CLI commands
      • Using the api commands
      • Using the apic-config commands
      • Using the application commands
      • Using the backups commands
      • Using the consumer-org commands
      • Using the content commands
      • Using the custom-module commands
      • Using the custom-theme commands
      • Using the custom-translation commands
      • Using the custom-webserver-page commands
      • Using the drupal-config commands
      • Using the drupal-state commands
      • Using the entity commands
      • Using the export-entity commands
      • Using the factory-reset command
      • Using the forums commands
      • Using the ip-security-enabled command
      • Using the maintenance commands
      • Using the memcache commands
      • Using the modules commands
      • Using the php-memory commands
      • Using the platforms commands
      • Using the product commands
      • Using the queue commands
      • Using the role commands
      • Using the security command
      • Using the service command
      • Using the service-ip-allowlist commands
      • Using the site commands
      • Using the site-config commands
      • Using the sites commands
      • Using the themes commands
      • Using the twig commands
      • Using the user commands
    • Scenarios that use the Portal CLI
      • Exporting and importing custom themes and site configuration
        • Exporting and importing custom themes and site configuration by using the Portal Admin API
      • How to enable and disable maintenance mode on your Developer Portal
  • Troubleshooting guide for the Developer Portal
  • Migrating your Developer Portal from Version 5 to Version 10
  • Upgrading your Developer Portal from Drupal 10 to Drupal 11
    • How to find your custom modules and themes on your Developer Portal
    • Preparations for upgrading your Developer Portal to Drupal 11
    • Upgrading to class-based hooks in Drupal 11
  • Developer Portal – Frequently Asked Questions
  • Developer Portal tutorials
    • Tutorial: Creating the Developer Portal
    • Tutorial: Creating a private Developer Portal site
    • Tutorial: Creating Accounts and Applications on the Developer Portal
    • Tutorial: Creating a custom theme for the Developer Portal
    • Tutorial: Using avatars
    • Tutorial: Using image optimization
    • Tutorial: Adding a Back to top button
    • Tutorial: Creating a drop-down menu link
    • Tutorial: Displaying blog posts on the front page
    • Tutorial: Displaying tweets on the front page
    • Tutorial: Changing the front page of your Developer Portal
    • Tutorial: Grouping products by category
    • Tutorial: Adding a field to the sign-up form
      • Tutorial: Adding validation to a field on the sign-up form
    • Tutorial for Adding a field group to group fields in a content type
    • Tutorial: Adding a custom block to the front page
    • Tutorial: Adding a custom block to a page other than the front page
    • Tutorial: Configuring the RobotsTxt file
    • Tutorial: Configuring the SecurityTxt file
    • Tutorials for using custom modules in the Developer Portal
      • Tutorial: Changing the profile page to display firstname lastname, instead of username
      • Tutorial: Adding validation to a field on the sign-up form
      • Tutorial: Installing the IBM secure authentication module
    • Tutorial: Using a custom weighting sort order on the product list page
    • Tutorial: Synchronizing application credentials from the Developer Portal with an external server
• 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
  • Preinstallation planning
    • Estimating storage requirements
    • Kubernetes and Red Hat OpenShift preinstallation planning
  • Managing your analytics subsystem
    • API Connect on Kubernetes, Red Hat OpenShift, and Cloud Pak for Integration
      • Analytics CR properties reference
    • OpenSearch nodes, indices, shards, and replicas
  • Installing the analytics subsystem
  • Backup, restore, and disaster recovery
    • Kubernetes, OpenShift, and Cloud Pak for Integration
      • Taking an analytics infrastructure configuration backup
      • Configuring analytics database backups
        • Creating the object-store CA certificates
      • Running an on-demand analytics database backup
      • Restoring the analytics database
      • Recovering from a disaster
      • Deleting old backups
      • Troubleshooting backup and restore
  • API event record field reference
  • Summary API event record field reference
  • Advanced configuration options
    • Dedicated storage and scaling up
      • Horizontal scaling of storage pods
    • Retention and rollover
    • Logstash persistent queue
    • Offload to third-party systems
      • Configuring offload on Kubernetes and Red Hat OpenShift
        • Configuring offload server certificates on Kubernetes and Red Hat OpenShift
        • Configuring offload client certificates on Kubernetes and Red Hat OpenShift
      • Sample output plug-ins for offloading data
      • Using offloaded analytics data to train AI models
      • Troubleshooting offload
    • Replicating analytics data to a 2DCDR warm-standby data center
    • Disable local storage
    • Shutting down the analytics subsystem
    • Restarting analytics pods
    • Enable Amazon SNS for Engagement
    • Changing deployment profile
      • Changing deployment profile on Kubernetes and Red Hat OpenShift
    • Performance tuning with ingestion pipeline properties
  • Customize your analytics data
    • Activity log policy
    • Customizing data with a gateway script or set-variable operation
    • Customizing data with ingestion filters
      • Kubernetes and Red Hat OpenShift individual subsystem installations
      • Cloud Pak for Integration and OpenShift top-level CR
      • Example ingestion filters
  • Access your analytics data
    • API Connect UIs
      • Accessing analytics in the Cloud Manager UI
      • Accessing analytics in the API Manager UI
      • Accessing analytics in the Developer Portal
    • Counting total API calls for your analytics service
    • Export your analytics data
    • Allowing API Connect cloud admin users to view provider organization analytics data
    • Sharing analytics data for API discovery
    • Analytics CLI
    • Analytics REST API
      • Using the events scroll operation to export analytics data
  • Troubleshooting analytics
    • No analytics data in UIs
    • Running out of storage space
    • Offload failure
    • Gathering postmortem logs
    • Analytics subsystem CR is in an error state
• 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
  • API Connect TLS certificates
    • TLS certificates organized by usage
  • Troubleshooting API Connect
    • Unable to access Management UIs
    • Unable to access the portal sites
    • Login failure on Management UIs
    • Login failure on Portal sites
    • Management operations not reflected on Gateway or Portal
    • UI error after management database key rotation in Cloud Manager
  • Externally linked support topics
    • Management database changes from V10.0.7
    • Restore blocked on 2DCDR deployments