• IBM webMethods API Control Plane Documentation
•  About this Documentation
  • Document Conventions
• Intent
•  Getting Started with API Control Plane
  •  Deploy API Control Plane
    • Deploy API Control Plane using Docker
    • Deploy API Control Plane using Helm
  •  Connecting Runtimes
    • Connecting IBM webMethods API Gateway
    • Connecting IBM webMethods Developer Portal
    • Connecting Third-party Gateway
•  Administering API Control Plane
  •  Deployment Concepts
    • Deployment Options
    • API Control Plane Components
    • Deployment Models
    •  Reference Architectures
      • Recommended High Availability Architecture
      • High Availability and Disaster Recovery (HADR) solution
    • Reference Deployment Scripts
  •  Deployment Configuration
    •  Configuring API Control Plane
      •  Hardware and Product Configurations
        • Resource Sizing Guidelines
    • Configuration Details
    • Connecting Runtime to API Control Plane
    •  Secure Communication to API Control Plane
      • Securing the Communication to API Control Plane using Docker
      • Securing the Communication to API Control Plane using Helm
  •  Operating API Control Plane
    •  Data Management
      • Data Types and Storage Methods
      •  Data Housekeeping
        • Index Management
        •  Snapshot Management
          • Backup Requirement Analysis
          • Backup Repository Capacity Sizing
          • Elasticsearch Backup and Restore
          •  Configuring a Backup Repository
            • Configuring a Local File System Repository
            • Configuring a Cloud Repository in Amazon S3
            • Configuring a Cloud Repository in Azure
          • Creating Elasticsearch Backup
          • Restoring Elasticsearch Backup
          • Purging Data
    • Log Management
    •  Monitoring API Control Plane
      • Monitoring API Control Plane Service
      •  Monitoring Microservices
        • Use probes
        •  Collect metrics
          • Application metrics
          • Infrastructure metrics
      •  Monitoring Components
        • Use probes
        •  Collect metrics
          • Application metrics
          •  Infrastructure Metrics
            • Pod metrics
      •  Troubleshooting: API Control Plane Monitoring
        • How Do I Generate Thread Dump?
        • How Do I Generate Heap Dump?
        • Causes for timeout errors
    •  User Management
      •  Manage Users
        • Adding a user
      •  Password Management
        • Customizing UMC properties through environment variables using Docker
        • Customizing UMC properties through environment variables using Helm
        • Customizing UMC properties through external properties file using Docker
        • Customizing UMC properties through external properties file using Helm
      •  User Profile
        • Modifying Profile Settings
    • Data Protection
•  Using API Control Plane
  •  Catalog
    •  Runtimes
      • What are Runtimes?
      •  Manage Runtimes
        • Editing a Runtime
        • Deleting a Runtime
        • Viewing the APIs associated with a Runtime
    •  Data planes
      • What are Data Planes?
      •  Manage Data Planes
        • Adding a Data Plane
    •  APIs
      • Manage APIs
  •  Insights
    •  Dashboard
      •  Dashboard at a Glance
        •  Widgets in detail
          • Geographic visualization
          • Count
          • Overall view
          • Status, performance, and used capacity
          • Trending runtimes and APIs or Trending APIs
          • API activity
          • Top APIs, runtimes, and data planes
    •  Data Planes
      •  Monitor Data Planes
        •  Monitoring all Data Planes
          •  Widgets in detail
            • Status, performance & used capacity
            • Transactions
            • Problematic data planes by
            • Availability
            • Error rate
        • Monitoring a Specific Data Plane
    •  Runtimes
      •  Monitor Runtimes
        •  Monitoring all Runtimes
          •  Widgets in detail
            • Status, performance, and used capacity
            • Problematic runtimes by
            • Transactions
            • Error rate
            • Availability
            • Response time
            • Latency
        • Monitoring a Specific Runtime
    •  APIs
      •  Monitor APIs
        •  Monitoring all APIs
          •  Widgets in detail
            • Problematic APIs by
            • Transactions
            • Error rate
            • Response time
            • Latency
        • Monitoring a Specific API
  •  User preferences
    • Overview
    •  Display Settings
      • Customizing row settings
      • Hiding widgets
    • Change Threshold Settings
•  Developer's Guide
  • Administration APIs
  •  Agent
    •  Understanding the Agent
      •  Agent Implementation Approaches
        • JAVA-based Implementation
        • REST API-based Implementation
      • Agent Deployment Modes
      • API Control Plane Compatibility Matrix
    •  Use Agent SDK
      • How to Access the Agent SDK?
      • Agent SDK Interfaces and Classes
      • How to Implement an Agent using SDK?
    •  Agent SDK Implementation Samples
      • Amazon API Gateway
      • Azure API Management Service
•  Upgrade Guide
  • Overview
  • Upgrade Plan
  •  Upgrade to 11.1
    •  Upgrade API Control Plane 11.0.3 or later to 11.1
      •  Upgrade a Docker Compose based Deployment
        • Plan Your Upgrade
        • Pre-Upgrade Preparation
        • Upgrade Process
        • Post-Upgrade Verification
        • Rollback Process
      •  Upgrade a HELM Container based Deployment
        • Plan Your Upgrade
        • Pre-Upgrade Preparation
        • Upgrade Process
        • Post-Upgrade Verification
        • Rollback Process
    • Upgrade API Control Plane 11.0.2 or earlier to 11.1

IBM webMethods API Control Plane Documentation

Upgrade API Control Plane 11.0.2 or earlier to 11.1