• TIBCO Cloud™ API Management - Local Edition Installation and Configuration Guide
    • TIBCO Cloud™ API Management - Local Edition Overview
      • TIBCO Cloud™ API Management - Local Edition Topology
      • TIBCO Cloud™ API Management - Local Edition Component Interactions
    • Quick Start
    • TIBCO Cloud™ API Management - Local Edition Components
      • Components Overview
      • NoSQL
      • Registry
      • Log Service
        • Accessing QPM Data by Cluster for Untethered Deployments
      • SQL DB
        • Onprem Loader
      • Cache
        • Memcached Loader
      • Traffic Manager
        • TLS Security
      • Cluster Manager
        • Cluster Manager CLI
      • API Management - Local Edition API
      • Configuration Manager Overview
      • Developer Portal Overview
    • TIBCO Cloud™ API Management - Local Edition 5.x Cluster Design Guidelines
      • Cluster Sizing Summary
      • Cluster Storage Summary
      • High Availability Cluster Design
      • Relative Sizing
    • TIBCO Cloud™ API Management - Local Edition Installer
      • Installer Overview
        • HTTP Proxy Support
        • HTTP Proxy Support with Authentication
      • Deploying the Installer
        • How to Run the Installer on Windows
        • Setting up HTTP Proxy Authentication in Installer Jenkins
      • Managing the Installer
      • Prebuilding
      • Building and Verifying the Docker Images
        • Building and Installing TIBCO Cloud™ API Management - Local Edition Connectors
      • Prepushing
      • Pushing the Docker Images
      • Deploying the TIBCO Cloud™ API Management - Local Edition Cluster
    • Deploying a TIBCO Cloud™ API Management - Local Edition Cluster
      • Platform and Deployment Options
      • Deployment Topologies
        • Docker Container View of a Single Zone
        • TIBCO Cloud™ API Management - Local Edition Cluster in Kubernetes / Docker Swarm - Single Zone
        • TIBCO Cloud™ API Management - Local Edition Cluster in Kubernetes Docker Swarm - Multizone
      • User Content, Templates and Resources
        • User Templates
        • Example
        • FAQ
      • Configuring Properties Common to All Deployments
        • Ports to Open Externally
        • Changing the MySQL Password of a Running Cluster
      • API Debug Key Common to All Deployments
      • Deployment Sequence
      • MySQL Replication Groups
        • Normal State of MySQL Replication Group
        • Abnormal State of MySQL Replication Group
        • Rebuilding MySQL Replication Group
      • Installing MySQL Standard (Commercial) Edition in TIBCO Cloud™ API Management - Local Edition
      • Deployments on Amazon AWS
        • AWS using Kubernetes
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Customizing Deployment
            • Creating Local Edition Docker Images
            • Pushing Local Edition Docker Images to the AWS Registry
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
              • Customizing TIBCO Cloud™ API Management - Local Edition Properties
          • Service Configuration Data
          • Customizing the TIBCO Cloud™ API Management - Local Edition Deployment Manifest
          • Creating a Kubernetes Cluster on AWS
          • Creating a Local Edition Cluster
            • Note about Creating Local Edition Clusters
          • Validating a Local Edition Cluster
          • Stopping and Starting the Cluster while Keeping the Cluster State Intact
          • Deleting a Cluster
            • Clearing the AWS Registry
        • AWS EKS using Kubernetes
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Customizing Deployment
            • Creating Local Edition Docker Images
            • Pushing Local Edition Docker Images to the AWS Registry
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
              • Customizing TIBCO Cloud™ API Management - Local Edition Properties
          • Service Configuration Data
          • Customizing the Local Edition Deployment Manifest
          • Creating a Kubernetes Cluster on AWS
          • Creating a Local Edition Cluster
            • Note about Creating Local Edition Clusters
          • Validating a Local Edition Cluster
          • Stopping and Starting the Cluster while Keeping the Cluster State Intact
          • Deleting a Cluster
        • AWS using Docker Swarm
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Customizing Deployment
            • Creating Local Edition Docker Images
            • Pushing Local Edition Docker Images to the AWS Registry
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
              • Customizing TIBCO Cloud™ API Management - Local Edition Properties
          • Service Configuration Data
          • Customizing the Local Edition Deployment Manifest
          • Creating a Docker Swarm Cluster in AWS
          • Creating a Local Edition Cluster
          • Validating a Local Edition Cluster
          • Deleting a Local Edition Cluster
        • AWS using OpenShift
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
          • Customizing API Management - Local Edition Manifest
          • Creating a Local Edition Cluster
          • Verifying a Local Edition Cluster
          • Deleting a Cluster
      • Deployments on Microsoft Azure
        • Azure using Kubernetes
          • Multi-zone Deployment in Azure Kubernetes Service
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Customizing Deployment
            • Creating Local Edition Docker Images
            • Pushing Local Edition Docker Images to Azure
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
              • Customizing TIBCO Cloud™ API Management - Local Edition Properties
          • Service Configuration Data
          • Customizing the Local Edition Deployment Manifest
          • Creating an Azure Kubernetes Cluster
          • Creating a Local Edition Cluster
            • Note about Creating Local Edition Clusters
          • Validating a Local Edition Cluster
          • Stopping and Starting the Cluster while Keeping the Cluster State Intact
          • Deleting a Cluster
        • Azure using OpenShift
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Customizing Deployment
            • Creating Local Edition Docker Images
            • Pushing Local Edition Docker Images to Azure
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
              • Customizing TIBCO Cloud™ API Management - Local Edition Properties
          • Service Configuration Data
          • Customizing the Local Edition Deployment Manifest
          • Creating an Azure OpenShift Cluster
          • Creating a Local Edition Cluster
          • Validating a Local Edition Cluster
          • Stopping and Starting the Cluster while Keeping the Cluster State Intact
          • Deleting a Local Edition Cluster
        • Azure using Docker Swarm
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Customizing Deployment
            • Creating Local Edition Docker Images
            • Pushing Local Edition Docker Images to Azure
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
              • Customizing TIBCO Cloud™ API Management - Local Edition Properties
          • Service Configuration Data
          • Customizing the Local Edition Deployment Manifest
          • Creating a Docker Swarm Cluster (Azure Swarm)
          • Creating a Local Edition Cluster
          • Validating a Local Edition Cluster
            • Making an API Traffic Call
          • Deleting a Local Edition Cluster
      • Deployments on Google Cloud Platform
        • Deployment on Google Cloud Platform using Kubernetes
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Configuration
            • Prebuild
          • Building and Deploying
            • Creating Docker Images
            • Push Docker Images to GCP Container Registry from the Installer
            • Customizing TIBCO Cloud™ API Management - Local Edition Deployment Manifest from Installer
            • Generating Deployment Scripts
            • Customizing Deployment Artifacts and Building Deployment Package
              • Updating Platform API Properties
              • Preparing KeyStores for Traffic Manager
              • Preparing KeyStores for Configuration Manager
              • Building Deployment Package
            • Creating a GCP Kubernetes Cluster
            • Creating a Local Edition Cluster
              • Note about Creating Local Edition Clusters
          • Verifying a Local Edition Cluster
          • Stopping and Starting the Cluster while Keeping the Cluster State Intact
          • Deleting a Cluster
          • For Advanced Users
        • Deployment on Google Cloud Platform using OpenShift
          • Prerequisites
          • Planning and Configuring the Local Edition Cluster
            • Planning
            • Prebuild
          • Building and Deploying
            • Customizing Local Edition Manifest
            • Creating the Local Edition Cluster
          • Verifying a Local Edition Cluster
          • Deleting a Cluster
      • Deployment on On-premises Bare Metal using Swarm
        • Prerequisites
        • Planning and Configuring
          • Planning
          • Configuring
          • Files to Modify
          • Local Edition Cluster Configuration
            • High Availability Guidance when Setting Up a Local Edition Cluster on Swarm Deployments
          • Local Edition Component Configuration
          • Setting up Service Configuration Data
            • Option 1: Using Local Edition Configuration Manager
            • Option 2: Synchronizing Service Configuration data from Local Edition On-premise Manager (MOM)
        • Building and Customizing Deployment
        • Customizing the Local Edition Deployment Manifest
        • Creating a Docker Swarm Cluster
        • Creating a Local Edition Cluster
        • Validating a Local Edition Cluster
          • Making a Traffic Call
        • Deleting a Local Edition Cluster
      • Deployment on On-premises using Kubernetes
        • Prerequisites
        • Planning and Configuring the Local Edition Cluster
          • Files to Modify
          • Local Edition Cluster Configuration
          • Setting API Management - Local Edition Service Configuration Data
        • Building and Customizing Deployment
          • Customizing Deployment Artifacts and Building Deployment Package
          • Generating Deployment Scripts
          • Creating a TIBCO Cloud™ API Management - Local Edition Cluster
            • Note about Creating Local Edition Clusters
        • Validating a Local Edition Cluster
        • Making a Traffic Call
        • Stopping and Starting the Cluster while Keeping the Cluster State Intact
        • Deleting the Local Edition Cluster
      • Onpremises using OpenShift
        • Prerequisites
        • Planning and Configuring the Local Edition Cluster
          • Planning
          • Configuring
        • Building and Customizing Deployment
        • Customizing API Management - Local Edition Manifest
        • Creating a Local Edition Cluster
        • Verifying a Local Edition Cluster
        • Deleting a Cluster
    • Configuration Manager
      • Managing Configuration Data
        • Configuring Zone Settings
          • Content Security Policy Editor
        • Configuring API Definitions and Endpoints
          • Enabling HSSM for an Endpoint
        • Configuring API Packages and Plans
        • Configuring Apps and Package Keys
        • Configuring API Domains
        • Configuring Members
        • Configuring Roles
        • Configuring API HTTPS Client Profiles
        • Configuring the Content Management System
          • Setting Advanced Options
          • Managing Developer Portal Content
        • Searching Package Keys
        • Configuring Interactive Documentation
        • Configuring Portal Domains
        • Configure SMTP/Admin Emails
        • Managing Portal Settings
          • Customizing Registration Email Body
        • Managing Organizations
        • Managing Schedule Maintenance Events
      • FAQ and Troubleshooting
    • LDAP and SAML
      • Configuring LDAP and SAML with Local Edition
      • Logging in the Configuration Manager with LDAP and SAML
    • Developer Portal
      • Getting Started
        • Portal Roles
        • Default Developer Portal Pages
      • Configuring your Developer Portal Pages
      • Changing the Administrator Password
      • Advanced Customizations for your Developer Portal
        • Customizing your CSS
        • Modifying Templates and Layouts
          • Getting Started
          • Using User-Specific Data
          • Creating Form Field HTML
          • Adding, Removing, and Reordering Fields
          • Adding Translation Strings
        • Loading Custom Fonts
          • Getting Started
          • Using Fonts and Handling Performance Issues
        • Configuring Developer Portal Settings
          • Default Developer Portal Settings
          • Changing Developer Portal Settings
          • Getting Developer Portal Settings
          • Updating Your Logo
        • Including TIBCO Cloud API Management Plugins
          • Getting Started
          • Toggling Password Visibility
        • Adding Third-party Scripts, Styles, and Plugins
          • Loading Scripts
          • Loading Styles
          • Initializing Plugins
        • Translations
          • Getting Started
          • Updating a Single String
          • Adding Multi-Language Support
          • Translation Strings Reference
        • JavaScript APIs
          • API Calls and HTTP Requests
          • Events
          • Forms
          • General
          • Navigation
          • Notifications
          • Plugins
          • Rendering
          • Sanitize
          • Session
          • Settings
          • Storage
          • Templates
          • Translations
          • Utilities
      • Deploying Default Portal Customizations and Assets to Your Clusters
        • Phase: Design and Development
          • Zip File Contract Details
        • Phase: Production
    • Managing Logs in a Cluster
      • Viewing Logs
      • Interacting with Loggers
      • Collecting Logs
      • Performing Log Cleanup
      • Enriched Access Logs
      • Exporting Logs to Different Output Channels
        • Recipe for File Destination
        • Recipe for Elasticsearch
        • Recipe for HTTP Endpoints
        • Recipe for Kafka
        • Recipe for TCP Socket
        • Recipe for SYSLOG Socket
        • Recipe for MOM and HTTP
        • Configuring Local Edition to Send Logs to Splunk
        • Recipe for Database
        • Recipe for Forward
      • Integrating with TIBCO Spotfire
        • Preparing TIBCO Spotfire to Consume Access Logs
      • Changing Output Destinations for Different Types of Logs using CLI
        • JSON Configuration Files Format for Different Outputs
      • TIBCO Cloud™ API Management - Local Edition Access Log Sync
      • Payload Logging
    • HTTPS Configuration
      • HTTPS Configuration Overview
      • HTTPS Server Configuration
        • Traffic Manager as an HTTPS Server with Mutual SSL
      • HTTPS Client Configuration
        • HTTPS Endpoint Configuration
        • Testing the HTTPS Client Call
        • Troubleshooting HTTPS Problems
          • Enabling Java SSL Debug Logging
      • HTTPS Mutual Authentication
        • Setting up HTTPS Authentication
          • One-Way HTTPS Client Configuration
          • Mutual HTTPS Client Configuration
          • Cluster Manager CLI Commands
            • Create Certificate
            • Create Identity
            • Update Certificate
            • Update Identity
            • List Certificates
            • List Identities
        • Creating Mutual Authentication
          • Tethered Mode
          • Untethered Mode
    • OAuth
      • Configuring OAuth 2.0 API Access
        • OAuth APIs and Authenticator Service
      • Making OAuth 2.0 Calls
        • OAuth API Supported Methods
        • Sample Calls
      • Local Edition 5.x OAuth API Compatibility with Local Edition 4.x
      • OAuth Token Migration
        • Structure of Token Migration Utility
        • Deploying the OAuth Token Migration Utility
        • OAuth Token Migration Configuration Properties
        • Running the OAuth Token Migration Utility
        • Verifying OAuth Token Migration
        • OAuth Token Migration FAQs
        • Troubleshooting OAuth Token Migration Issues
    • Monitoring Local Edition Components
      • Format of Metrics
      • Resource Monitoring
      • Component Metrics Monitoring
        • Traffic Manager Metrics
        • SQL Container Metrics (MySQL DB)
          • Diagnostic Recipe and Alerts for MySQL
        • Cache Container Metrics (Memcached)
          • Diagnostic Recipe and Alerts for Memcached
        • NoSQL Container Metrics (Cassandra)
          • Diagnostic Recipe and Alerts for NoSQL
        • Onprem Loader Monitoring
          • Diagnostic Recipe and Alerts for Onprem Loader
        • Memcached Loader Monitoring
          • Diagnostic Recipe and Alerts for Memcached Loader
      • Functional Monitoring
      • Recipes for ELK
    • Connectors and Adapters
      • TIBCO-provided Connectors and Adapters
        • Verifying the TIBCO Cloud API Management Connectors and Adapters
        • FAQs
      • Customer-provided Adapters
    • Troubleshooting
  • TIBCO Cloud™ API Management - Local Edition Migration and Upgrade Guide
    • Migrating to TIBCO Cloud™ API Management - Local Edition 5.x
      • Migration Prerequisites
    • Migrating MySQL Data from Version 5.4.1 Untethered Mode to Version 5.5.0 Untethered Mode
    • Migrating Local Edition Cluster from 4.4.x to 5.5.1
      • Installing Updated Traffic Manager on 4.4.x Running in OVA
      • Installing Updated Traffic Manager on 4.4.x Running in Docker
      • Migrating Tokens from 4.4.x to 5.5.1
    • Upgrading Local Edition Cluster
      • Upgrading Local Edition cluster from 5.2.0, 5.3.0,5.3.1, or 5.4.0 to 5.4.1
      • Upgrading Local Edition cluster from 5.0 to 5.4.1
      • Upgrading Local Edition cluster from 5.3.1 to 5.4.1 for Kubernetes in Tethered Mode
      • Upgrading Local Edition Cluster from 5.4.0 to 5.4.1
        • Upgrading Local Edition cluster from 5.4.0 to 5.4.1 for Docker Swarm
        • Upgrading Local Edition cluster from 5.4.0 to 5.4.1 for Kubernetes in Untethered Mode
      • Upgrading Local Edition Cluster from 5.4.1 to 5.5.0
        • Upgrading Local Edition Cluster from 5.4.1 to 5.5.0 for Kubernetes in Tethered Mode
        • Upgrading Local Edition cluster from 5.4.1 to 5.5.0 for Docker Swarm Tethered
        • Upgrading Local Edition Cluster from 5.4.1 to 5.5.0 for Kubernetes in Untethered mode
        • Upgrading Local Edition cluster from 5.4.1 to 5.5.0 for Docker Swarm Untethered
      • Upgrading Local Edition cluster from 5.5.0 to 5.5.1
        • Upgrading Local Edition Cluster from 5.5.0 to 5.5.1 for Kubernetes in Tethered Mode
        • Upgrading Local Edition cluster from 5.5.0 to 5.5.1 for Docker Swarm Tethered
        • Upgrading Local Edition Cluster from 5.5.0 to 5.5.1 for Kubernetes in Untethered mode
        • Upgrading Local Edition cluster from 5.5.0 to 5.5.1 for Docker Swarm Untethered
    • Migrating Certificate Data in MySQL in Tethered mode
    • Downgrading Local Edition to an Earlier Version
      • Notes for Downgrading Local Edition 5.4.1 to an Earlier Version
  • TIBCO Cloud™ API Management - Local Edition SDK Guide
    • Overview
      • The TIBCO Cloud™ API Management - Local Edition SDK
      • SDK Components
      • System Requirements
    • Quick Start
      • Step 1: Creating an Adapter Project
      • Step 2: Packaging the Adapter
      • Step 3: Uploading the Build Adapters to Local Edition-Installer Build Job
      • Step 4: Building the Changing TIBCO Cloud™ API Management - Local Edition-TM Docker image with Customer-Provided Adapters or Processors
      • Step 5: Configuring Endpoints for Processors
    • Upgrading the Local Edition SDK 5.2 or 5.3 or 5.4 to Local Edition SDK 5.5
    • Downgrading TIBCO Cloud™ API Management - Local Edition SDK to an Earlier Version
    • Configuring Network Proxy for TIBCO Cloud™ API Management - Local Edition SDK
    • Adapter SDK Package
      • TIBCO Cloud™ API Management - Local Edition Domain SDK
      • TIBCO Cloud™ API Management - Local Edition Infrastructure SDK
    • Developing Processors and Authenticators
      • SDK Domain Model
        • Extended Attributes
        • Pre and Post Processor Extension Points
        • Listener Pattern
        • Event Types and Event
        • Event Listener API
      • Importing Existing Adapters
      • Developing and Packaging Multiple Adapters
      • Using the Adapter SDK in an IDE
        • Creating an Adapter using Eclipse
        • Creating an Adapter using IntelliJ IDEA
        • Creating an Adapter using Apache NetBeans
      • Adding Third-Party Libraries in an Adapter
        • Referring to Third-party Libraries with Dependency
    • Debugging the Adapter
      • Adding Logger Utility Class
      • Changing Log Levels
      • Checking Adapter Logs
      • Debugging SDK Processor Remotely
    • Implementing and Registering Processors and Adapters
      • Implementing a Processor or Adapter
      • Creating a Pre-processing Adapter
        • Reading Body Content of Request
        • Modifying the Request Body
        • Terminating Further Processing for Unavailable Header
      • Creating a Post-processing Adapter
        • Add Custom Header to the Response to Client
        • Modifying Body Content of Response to Client
      • Creating a Custom Authenticator
        • Stopping a Processing Request on Authentication Failure
        • Continue Processing Request for Successful Authentication
      • Implementing the Event Listener
      • Implementing Lifecycle Callback Handling
      • Caching Content
      • Terminating a Call During Processing of an Event
      • Accessing and Using Extended Attributes
      • How to Send Response Body to Another Location Other Than Caller
      • How to Externalize Properties and Files from SDK-Built Adapters
      • Accessing Plan, Package and Application ID in Custom Processor
      • Chaining of Processors
        • Chaining of Processors Using Mashery_Proxy_Processor_Chain
        • Chaining of Processor Using Chain Adapter
    • FAQs
  • TIBCO Cloud™ API Management - Local Edition Reporting Services Guide
    • Overview
      • Reporting Services Concepts
      • Reporting Services Architecture
      • Types of Reports
        • Traffic Summary
        • Mashery Operations
          • Traffic Detailed Reports
          • TML Metrics
          • TML Container Logs
          • Verbose Logs View
    • Infrastructure Planning, Sizing and Deployment
    • Prerequisites
    • Installing the Reporting Services
    • Deploying the Reporting Services
      • Deploying the Reporting Services along with TML-Cluster
      • Deploying the Reporting Services Separately after TML-Cluster Deployment
      • Quick Start Deployment
    • Configuring Clusters
    • Customizing the User Interface
      • Grafana Dashboards
      • Fluentd Configuration
      • Loki Configuration
      • Prometheus Configuration
      • TML-Reporting Configuration
    • Verification
    • Accessing Grafana Dashboards and Reports
      • Managing Users and Roles
      • Managing Dashboards
        • Customer Traffic Detail Reports
        • TML Cache Metrics
        • TML CM Metrics
        • TML Logs Metrics
        • TML NoSQL Metrics
        • TML Reporting Metrics
        • TML SQL Metrics
        • TML TM Metrics
        • TML Verbose Logs
        • TML Container Logs
          • TML SQL Container Logs
          • TML NoSQL Container Logs
          • TML TM Container Logs
          • TML CM Container Logs
          • TML Log Container Logs
          • TML Cache Container Logs
        • Customer Traffic Summary
    • Customizing Dashboards and Reports
      • Basic Customization
        • Adding Alerts
        • Adding Alert Dashboard
        • Changing Bucket Interval
        • Changing Data Visualization
    • Persistence of Dashboards and Reports
      • Importing or Exporting Dashboards
      • Uploading Custom Dashboards at the Time of Deployment
    • FAQs
    • Troubleshooting
  • TIBCO Cloud™ API Management - Local Edition Cluster Design Guide
    • Liveness for TIBCO Cloud™ API Management - Local Edition Components
    • Using Sample Scripts
    • Cluster Sizing
  • TIBCO Documentation and Support Services
  • Legal and Third-Party Notices