| Last Updated | Title | Abstract |
|---|---|---|
| 2025-11-10 | API Connect v10.0.8 SFTP Backup limitation with AWS SFTP server | There are observed limitations with the management and analytics subsystems unable to take an SFTP backup to AWS SFTP server |
| 2025-11-03 | apic global-policy-prehooks:create fails with Error: A resource of type global_policy_prehook already exists. Please update the existing resource. | The following command failsapic global-policy-prehooks:create –catalog subincatalog1 –configured-gateway-service apigw –org porg1 –server "apim.mgmt.apic.hostname.ibm.com" –scope catalog /home/user/GlobalPolicy.yamlError: A resource of type global_policy_prehook already exists. Please update the existing resource. |
| 2025-10-25 | Steps to retrieve gateway extension zip file which was uploaded to the gateway service. | If you don't have access to the gateway-extension zip file uploaded in the cloud manager, you can use the toolkit to retrieve it. This note will walk you through the process. |
| 2025-10-23 | API Connect Management Subsystem Installation Stalls Due to Missing S3 Backup Secret | During a clean installation of API Connect v10.0.8.1, the Management subsystem fails to complete setup. The installation process stalls with several services remaining in a pending state, including postgresDb, ldap, apim, and others.kubectl get apicNAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGEmanagementcluster.management.apiconnect.ibm.com/management 1/16 Warning |
| 2025-10-15 | API Connect OVA – apic Commands Fail After VM Reboot | After rebooting API Connect VMs deployed via OVA, users may encounter failures when running apic commands. Here are few examples:Error: unknown command "unlock" for "/usr/bin/apic"Run 'apic –help' for usage.Error: unknown command "health-check" for "apic"Run 'apic –help' for usage.Error: unknown command "status" for "apic"Run 'apic –help' for usage.Error: unknown command "subsystem" for "apic"Run 'apic –help' for usage. |
| 2025-10-15 | IBM API Connect Configuration example: Creating a Gateway extension to tune the timeout settings on API Gateway | On DataPower when using IBM API Connect, the API Gateway object has 2 timeouts configured, which affect all API calls. The front timeout controls the amount of time the connection from the client to API Gateway can be idle while an active transaction is occurring and has a default value of 120 seconds. The front persistent timeout controls the amount of time a TCP connection from the client to the backend can remain idle for reuse before the connection closed and has a default value of 180 seconds. |
| 2025-10-14 | Published-Failed / Publish-Success State in API Connect Manager [New Feature v10.0.8.X] | You see in the API Manager UI that the state of several or all products are depicted as "published-failed" after upgrading to v10.0.8.x or a publish/republish event. |
| 2025-10-08 | Custom Theme export fails with Failed to authenticate management route – error during JWT token validation: TypeError: Cannot read properties of null | Custom Theme export fails with :curl -k -X 'POST' -H "Authorization: bearer ey<hide_me>qg" -H 'Accept: application/yaml' 'https://apim.mgmt.apic.<hide_me>.ibm.com/portal/catalogs/porg1/subin/custom-theme/export'status: 401message: – Failed to authenticate management routeerrors: – >- error during JWT token validation: TypeError: Cannot read properties of null (reading 'header') |
| 2025-09-30 | Embedding Watsonx Orchestrate AI Assistant Web Chat in IBM API Connect Developer Portal | This technote provides guidance on embedding the Watsonx Orchestrate AI Assistant web chat into the IBM API Connect Developer Portal |
| 2025-09-23 | API Connect Management Subsystem Restore Stuck with Message: Bringing up restored cluster | After restoring the Management database using a backup Custom Resource (CR), the restore process may fail to complete. The status remains stuck at:Bringing up restored clusterIn such cases, the recovery pod stays in a Pending state, preventing further progress. Investigation using kubectl describe pod often reveals issues such as missing PersistentVolumeClaims (PVCs), especially for db-wal.Once the PVC issue is resolved, the restore must be re-attempted after cleaning up artifacts from the previous failed r |
| 2025-09-18 | Error: "This policy is not available on selected gateway" displayed in API Manager UI | When editing an API in the Manager UI > Develop tab and navigating to the Gateway tab under Policies, the following error message is displayed: "This policy is not available on selected gateway." |
| 2025-09-17 | "Internal Error Traversing Flow" in IBM API Connect v5 Compatibility Gateway | Users deploying APIs with IBM API Connect version 5 compatibility may encounter the "Internal error traversing flow" message when invoking their APIs. |
| 2025-09-11 | API Connect OVA: Kubernetes Fails to Start Due to ResourceExhausted Error | In API Connect OVA deployments, Kubernetes may fail to start properly due to a ResourceExhausted error from the container runtime. This error occurs when the container runtime (containerd) attempts to process an excessively large number of containers, resulting in a gRPC message size exceeding the allowed limit.The error message observed is:rpc error: code = ResourceExhausted desc = grpc: trying to send message larger than max (16835417 vs. 16777216)This condition typically arises when thousands of paused c |
| 2025-09-11 | API Connect OVA: Excessive portal-sync-backup Pods in Pending Status Impacting Healthcheck | In API Connect OVA deployments, customers may observe hundreds of *-sync-backup pods in a Pending state. These pods are generated by the *-sync-backup-schedule job, which runs every ten minutes. Over time, this results in a large number of pending pods accumulating on the portal node.This condition can lead to failures when running the apic healthcheck command from within the VM shell, due to resource exhaustion or container runtime instability. |
| 2025-09-08 | IBM API Connect CORS Policy Issue with Wildcard (*) for Allow-Origin | When users set the Allow-Origin value in their API's CORS policy to the wildcard character (*), the Gateway processing logs will generate errors. |
| 2025-08-26 | Upgrade from 10.0.5.x to 10.0.8.x Blocked Due to Residual Crunchy pgcluster | During the upgrade from version 10.0.5.x to 10.0.8.x, the process failed repeatedly due to the preupgrade job being stuck. The associated pod was logging errors indicating it was unable to locate the Postgres leader. This preupgrade pod must complete successfully for the upgrade to proceed.Upon reviewing the pre upgrade pod logs, the following error was observed which has been formatted for readability:{ "level": "error", "ts": "<timestamp>", "logger": "controllers.ManagementClu |
| 2025-08-21 | Upgrade from API Connect 10.0.5.x to 10.0.8.0 Fails During Database Import | When upgrading IBM API Connect from version 10.0.5.x to 10.0.8.0, the database import job (dbimport) fails with the following error:kubectl get pods -n <namespace where APIC is deployed> | grep dbNAME READY STATUS RESTARTS AGEmanagement-subin-db-1 0/1 Running 0 1dkubectl logs management-subin-db-1 -c postgres{"level":"info","ts":"<timestamp>","logger":"pg_dump","msg":"pg |
| 2025-08-20 | Stanza Creation Failure During Upgrade to API Connect v10.0.5.8 | During upgrades from API Connect v10.0.5.x to v10.0.5.8, specifically for S3-only backup configurations, the stanza creation process may fail. This results in the Management subsystem entering a warning state with a WALArchiveNotWorking error, even though the upgrade completes successfully. |
| 2025-07-31 | User cannot login to the APIC Cloud Manager in the DR site with the DR user registry after restore | APIC DC/DR setup (v10.0.8.x) with Cloud Pak for Integration (v16.1.0.x) on OpenShift (v4.16.x).Both DC and DR environments are network isolated, each with its own Keycloak URL.After restoring DC backup on DR, when accessing the Cloud Manager URL on DR using the common services user registry, it redirects to the DC Keycloak URL. It should redirect to the DR Keycloak URL.To address this, we logged into Cloud Manager with the Cloud Manager user registry and updated the Keycloak FQDN and client secret and chang |
| 2025-07-23 | Trace Tab Is not Visible In API Manager when testing an API | The Trace tab in API Manager is not showing up for a specific API, but works fine for other APIs. |
| 2025-06-13 | Updating gateway extension using REST API fails with {"status":400,"message":["The multipart 'implementation' field must have a mimetype of application/zip."]} | Updating gateway extension using REST API fails with {"status":400,"message":["The multipart 'implementation' field must have a mimetype of application/zip."]}. Here is an example:Request:curl -v -k -X PUT –header 'Authorization: bearer ${bearer}' –header 'Content-Type: multipart/form-data' –form 'implementation=@./gateway-extension_ORIGINAL.zip' https://apic-np-api-manager.apic.subin.ibm.com/api/orgs/admin/availability-zones/availability-zone-default/gateway-services/gw-service-dv/gateway-extensionRes |
| 2025-06-11 | Mustgather Collecting Data for Transactional Latency Problems on IBM API Connect | Symptoms of latency include: higher than expected processing time, slow transactions, low throughput, and so on. Latency can occur in any layer or multiple layers from network to processing. The following information is required for IBM Support to use and expedite cases when troubleshooting latency issues on API Connect. |
| 2025-06-10 | Enabling Debug Logs for Mail Notifications | This technote provides step-by-step instructions to enable debug-level logging for email notifications in IBM API Connect. This is useful for troubleshooting issues related to mail delivery by capturing detailed log output from the relevant components. |
| 2025-06-04 | How to Add an Additional Property to a JSON Schema for the Entire Request Body | How can I add an additional property to a JSON Schema that applies to the entire request body? Instead of repeating the property for each object, I want to define it once at the schema level or through another configuration. |
| 2025-06-03 | IBM API Connect V10 – How to allow-list backend (server-side) custom headers when default CORS support is enabled in an API | When default CORS support is enabled in an API published in the DataPower® API Gateway, as described in the documentation: https://www.ibm.com/docs/en/api-connect/10.0.8_lts?topic=api-enabling-cors-support, implementing custom server-side header allow-listing at the APIC or backend level will not work. This means that if in an API invocation response from the backend or in an API assembly, the CORS response header Access-Control-Expose-Headers is populated with one or more values, representing backend custo |
| 2025-06-02 | Developer Portal does not show API Documentation Details and the page is blank | When a user navigates to Developer Portal API document page to get overview on an API there is no content displayed.This happens for all types of users – Admin, Authenticated and PublicAfter the Admin user clears the cache, the page displays but the issue appears sporadically |
| 2025-06-02 | Analytics Stuck in starting state during upgrade | [ERROR][logstash.geoipdatabasemanagement.manager] failed to sync databases{:exception=>"Connect to geoip.elastic.co:443 [geoip.elastic.co/34.72.239.183] failed: Connect timed out"}[logstash.filters.geoip.databasemanager] CC-licensed GeoIP databases are prepared for use by the GeoIP filter: {"City"=>"/usr/share/logstash/data/plugins/filters/geoip/CC/GeoLite2-City.mmdb","ASN"=>"/usr/share/logstash/data/plugins/filters/geoip/CC/GeoLite2-ASN.mmdb"} |
| 2025-05-29 | Publishing API's might error if the schema name is too long | Publishing a product will fail if the name of a referenced API schema is larger than 128 characters. |
| 2025-05-20 | Resolving 403 Forbidden Errors in Developer Portal: Misconfigured Load Balancer/Reverse Proxy | Users may encounter 403 forbidden errors when using a Load Balancer or Reverse Proxy in front of the Developer Portal due to excessive requests from the load balancer/reverse proxy to the Portal site. |
| 2025-05-09 | Generating Error Reports on DataPower Containers in API Connect on Kubernetes, OpenShift, and Cloud Pak for Integration | This technote provides a step-by-step guide on generating error reports for DataPower containers running as part of IBM API Connect on container platforms such as Kubernetes, OpenShift, and Cloud Pak for Integration. Since the DataPower UI may not always be accessible in these environments, this document outlines an alternate method to collect an error report, to help ensure efficient troubleshooting and problem resolution. |
| 2025-05-08 | Troubleshooting TLS Handshake Failures with SNI Profiles in API Connect | When a user registers the API Connect Gateway service there's an option to configure Server name indication (SNI). The SNI configures allows for different hostnames to use different TLS Server profiles.If a user sets up one SNI profile for TLS 1.2 for a specific hostname (e.g., api.example.com) and another default profile (eg. *) for TLS 1.2 and 1.3, TLS handshake failures may occur.This issue arises due to the SNI server profile object advertising the highest TLS version (TLS 1.3) while the API call |
| 2025-04-28 | Tips to improve your IBM Support Portal experience when engaging IBM Support | When using the IBM Support Portal www.ibm.com/mysupport, users are able to set individual preferences that fit their requirements. Users have reported that their personal experience with the support portal has been improved by making a few modifications to the default settings. |
| 2025-04-28 | gRPC protocol support in App Connect Enterprise or API Connect | Is gRPC protocol supported in ACE or APIC?We have a requirement to support gRPC backend system.This API needs to be exposed as a proxy in ACE or APICDoes any of these products support gRPC protocol or any other way to implement it? |
| 2025-04-22 | How to Troubleshoot API Connect Upgrade in Pending State Due to Pre-upgrade Check Failure | After initiating an upgrade of the API Connect cluster, the upgrade process remains in a Pending state with a Preupgrade check failed message. For example, running the following command shows:# oc get apiconnectclusterNAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGEsubin APIC instance being upgraded. Preupgrade che |
| 2025-04-22 | APIC toolkit governance mode rulesets:list command fails with Error: Server responded(code: 404) with an unexpected content-type(text/html) | The following failure occurs :$ ./apic -m governance rulesets:list -o porg1 -s apim.mgmt.apic.hideme.com –debugError: Server responded(code: 404) with an unexpected content-type(text/html). Re-run command with –debug to see additional data. |
| 2025-04-21 | Portal Backup or Management Backup Stuck in Running Due to backrest pod ContainerCreating and Postgres Backup pod terminating | When using the apicup tool to start a manual backup or list backups on a VM (Virtual Machine) with API Connect OVA deployed, the backup remains stuck in the Running status for longer than expected.Example:apicup subsys list-backups mgmtNAME STATUS ID CLUSTER TYPE CR TYPE AGEmgmt-backup-2hgnw Running mgmt full create 55m |
| 2025-04-18 | Known Issue: CNP plugin reports incorrect status for EDB Cluster | We have transitioned from Crunchy to EDB in 10.0.8.x stream of API Connect.EDB Postgres provides cnp plugin for kubectl to manage a cluster in Kubernetes. Customers can run the kubectl cnp status <cluster> command to retrieve the status for their EDB cluster. For OpenShift customers, replace kubectl with oc.There is a known issue with cnp plugin 1.22.5 and higher. The command does not return the Instance status correctly as seen below.Instances statusName |
| 2025-04-11 | API Connect Product Publish error: Missing Hyphen in Policy Name | When attempting to publish or stage a product, users might see an error like the following on the API Connect UI or within the apim pod logs: The OpenAPI definition 'sampleapi:1.0.0 (SampleAPI)' requires the policy 'undefined:2.0.0' that is not configured on the gateway service 'apigw (apigw)' |
| 2025-03-21 | IBM API Connect Management Server Backup Fails on OpenShift Deployment with The specified multipart upload does not exist error | IBM API Connect Management Server Backup Fails on OpenShift Deployment intermittently or consistently. The following command to display the list of backups shows:oc get backup -ANAMESPACE NAME AGE CLUSTER METHOD PHASE ERRORhideme apic-mgmt-20250221030000 6d4h apic-mgmt-hideme-db barmanObjectStore completedhideme apic-mgmt-20250222030000 5d4h apic-mgmt-hideme-db barmanObjectStore failed exit status 1hideme apic-mgmt-20250223030000 4d4h apic-mgmt-hid |
| 2025-03-10 | LDAP user registry Test Connection fails with Unauthorized error | LDAP user registry Test Connection fails with Unauthorized error. Here is a sample screenshot |
| 2025-03-10 | Resolving Limit of total fields [1000] has been exceeded Error in API Connect Analytics Offload to Elasticsearch | When offloading analytics data from IBM API Connect to Elasticsearch, users may observe numerous status=> 400 error messages in the api-analytics-ingestion pds. However, the offload appears to be functioning in Elasticsearch despite these errors. Example Log Output kubectl logs pod/<analytics_ingestion_pod> -n <namespace_where_APIC_is_deployed>[<timestamp>][WARN ][logstash.outputs.elasticsearch] Could not index event to Elasticsearch. { :status=>400, :action=>["in |
| 2025-03-10 | Step-by-Step Guide to Enabling the Web GUI in DataPower Gateway for API Connect v10 in OpenShift or CP4I Deployments | This technote provides detailed instructions on how to enable the GUI on IBM DataPower Gateway for API Connect v10 and set up access through OpenShift or Cloud Pak for Integration. The DataPower GUI is not enabled by default and provides a graphical interface for managing your DataPower Gateway. |
| 2025-03-10 | API Connect Gateway Pod Stuck in Pending State on OpenShift | The API Connect Gateway pod remains in a Pending state on OpenShift. Running the following command:oc describe pod/<gateway-pod-name> -n <project_where_APIC_is_deployed>reveals scheduling issues:Warning FailedScheduling 27m (x28 over 69m) default-scheduler 0/11 nodes are available: 2 Insufficient memory, 3 node(s) had untolerated taint {node-role.kubernetes.io/master: }, 6 node(s) had untolerated taint {node.cloudprovider.kubernetes.io/uninitialized: true}. preemption: 0/11 nodes |
| 2025-03-10 | API Creation Fails with “Only .xsd and .wsdl files are allowed in the zip.” | When attempting to create an API using the API Connect Toolkit with the apic draft-apis:create command, the process fails with the following error: Error: The multipart 'wsdl' field contains a WSDL definition with validation errors.- subinapi-api_2.0.0-test.yaml: Only .xsd and .wsdl files are allowed in the zip. Remove the file subinapi-api_2.0.0-test.yaml. |
| 2025-03-06 | How to use the API Probe on the DataPower API Gateway | The API probe captures transaction data for the API gateway. It can be valuable in debugging some issues on the API Gateway. |
| 2025-02-21 | Error accessing Analytics Advanced settings in the cloud manager GUI if missing permission | To set a time period for data retention and index rollover, users can access the Advanced Settings in the Analytics service. For more information about accessing the Advanced settings refer to the documentation page Configuring data retention and index rollover time periodsWhile trying to access the Analytics Service’s advanced settings, users might get an error if their user doesn't have the required permissions. |
| 2025-02-04 | API Connect v5 Gateway- Troubleshooting unable to retrieve policy information error | In API Connect version 5 and the v5 compatible DataPower Gateway in later editions, users might observe their API calls for a specific API are returning a 500 response code. |
| 2025-01-16 | API Connect Automated API Behavior testing might throw error if API Endpoint certificate not trusted | When using the Automated API behavior testing, running a test might cause an error if the API endpoint is using a certificate that was self-signed or signed by a custom certificate authority (CA). |
| 2025-01-07 | API Connect Upgrade to 10.0.8.1 Fails with Pending Status Due to Database Replication Issue | When upgrading Cloud Pak for Integration (CP4I) from version 2023.4 to 16.1, the corresponding API Connect upgrade from version 10.0.7.0 to 10.0.8.1 may encounter an issue where the API Connect Cluster Custom Resource (CR) remains in a pending state. |
| 2024-12-04 | Management Backup Job Fails with – Error in accessing bucket – invalid header field value for Authorization | When attempting to save the following backup configuration:host: <host>/<region>port: 443protocol: objstorepath: <path>credentials: mgmt-backup-secretschedule: "0 0 1 * * *"repoRetentionFull: 14backups3URIStyle: hostbackupCerts: mgmt-custom-objstore-caThe following error is encountered:Invalid value: v1beta1.DatabaseBackup{Protocol:"objstore", S3provider:"", Schedule:"0 0 1 * * *", Host:"<host>/<region>", Port:443, Retries:0, Path:"<path>", Credentials:"mgmt-backup-secret |
| 2024-12-03 | Analytics backup fails with error: unable to call remote backup endpoint – invalid status code 500 | API Connect Analytics backups remain in a pending state. Upon investigation, the backup fails with the following error logged in the API Connect Operator pod:kubectl logs ibm-apiconnect-<id>_ibm-apiconnect -n <namespace where APIC operator is deployed>{"level":"info","ts":"2024-11-25T14:15:13.989Z","logger":"controllers.AnalyticsBackup","msg":"calling analytics director backup status endpoint","analyticsbackup":{"name":"analytics-backup-01","namespace":"cp4i"},"id":"apic-dev-a7s-all-2024-11-25t1 |
| 2024-11-22 | Analytics ingestion or storage pods restart when using a storage class that provides a distributed or shared file system | Why my ingestion pod is keep restarting[ERROR][logstash.javapipeline ] Pipeline worker error, the pipeline will be stopped{:pipeline_id=>"intake", :error=>"deserialize invocation error",:exception=>Java::OrgLogstashAckedqueue::QueueRuntimeException, :backtrace["org.logstash.ackedqueue.Queue.deserialize(Queue.java:758)", "org.logstash.ackedqueue.Batch.deserializeElements(Batch.java:89)", "org.logstash.ackedqueue.Batch.<init>(Batch.java:49)", "org.logstash.ackedqueue.Queue.readPageBatch(Queue.j |
| 2024-11-21 | API Connect Map Policy adjusting parse settings | The default parse settings on DataPower have a max size limit of approximately 4 MB and a max width of 4096. Within DataPower the properties defined by the map policy are saved in a temporary JSON file, which is read by the API Gateway service. A large map policy can cause the overall size of the JSON document to exceed the limits defined in the default parse settings. Typically, such issues are observed with either large in line schemas and large JavaScript map action value properties. The following |
| 2024-11-08 | Upgrading API Connect operator causes EDB operator and Postgres pods to update | When upgrading API Connect from 10.0.7 or 10.0.8 to a later release, the EDB operator and EDB Postgres pods will be automatically upgraded when the API Connect operator is upgraded to the new version. |
| 2024-11-08 | Known Issue in Version 10.0.8.1 – Temporary Display of No Errors on Scan Report Screen for Large Reports | When a user opens a Scan report (click on 'catalog-prod-report' in below image), the UI has to process the errors before rendering the chart results (see second image below). Scan report results:No issues are seen for Scan reports with a small number of records to process, as in the case of the above screen shots.When creating scan reports with very large number of errors – in excess of 50,000 issues. While the UI is iterating through the 50,000 issues and categorizing the results, the default UI shown |
| 2024-11-08 | Known Issue in Version 10.0.8.1 – API missing required name in security schema can still be validated and published | In the API Manager UI > Develop > API editor UI shows that the variable name is a required field in the Security Schema, yet the API still passes validation and can be published to the catalog if that name is missing. The gateway will now return a failure in the event monitoring and all other actions will be reported as failed. If the name is filled in and the API saved, all is well. If the name is removed, the UI does capture the validation failure. Example in API yaml :s |
| 2024-10-31 | Applying datapower special build in API Connect deployment fails with no endpoints available for service ibm-apiconnect-service | An attempt to apply a DataPower special build (dk10509cw.lts.nonprod.tar.gz) on API Connect version 10.0.5.6 encounters an error due to missing endpoints for the ibm-apiconnect-service. The issue arises after specifying the dataPowerOverride in the GatewayCluster YAML configuration following the steps outlined in IBM's documentation for overriding the DataPower image. |
| 2024-10-31 | IBM API Connect might throw errors if you try to publish or create API's with same name and version and different capitalization | API's are case sensitive in API Connect. If you create a draft API named "xyz:1.0.0" and then try to import another API with the same name, but different capitalization, for example "Xyz:1.0.0" it will throw an error and you cannot import the API.Similarly, if multiple products within the same namespace refer to an API using different capitalization for the API name, it will cause errors and prevent you from publishing the second product.Note: Namespace refers to the same provider organization, catalog, and |
| 2024-10-30 | API Connect installation fails with could not create directory /var/lib/postgresql/data/pgdata – Permission denied | Installation of API Connect fails with the following error in the management initdb pod $ kubectl logs pod/management-b58c080a-db-1-initdb-b9mkm_initdb.log -n apic{"level":"info","ts":"<timestamp>","msg":"EPAS specific features","logging_pod":"management-b58c080a-db-1-initdb","enabled":false}{"level":"info","ts":"<timestamp>","msg":"Creating new data directory","logging_pod":"management-b58c080a-db-1-initdb","pgdata":"/var/lib/postgresql/data/pgdata","initDbOptions":["–username","postgres" |
| 2024-10-15 | Issues with Sign-Up and Forget Password Links in Developer Portal on OVA Platform | Users experience issues with the Sign-Up and Forget Password URL links in their Developer Portal. When users receive the email with the sign-up activation or forget password link, they must click the link multiple times for the process to complete successfully. |
| 2024-10-10 | API Connect v5 compatible Gateway does not support parsing escaped characters within JSON Strings | Attempting to parse a JSON message that contains an escaped character will throw an exception when using the V5 compatible Gateway. For example, suppose you have a JSON request that escaped the double quote character:{ “Message”: “He said, \”Hello, World!\” and smiled.”} |
| 2024-10-03 | draft-apis REST API fails with status 400 | Using the REST API to create a draft API curl –location 'https://apimserver.example.com/api/orgs/{org}/drafts/draft-apis?api_type=rest' \ –header 'Authorization: Bearer eyJhbGciOiJS…4NwpR3bY6KeWw' \ –form 'openapi=@"/tempAPI-1-0-0.json"'where tempAPI-1-0-0.json { "swagger": "2.0", "info": { "title": "tempAPI", "x-ibm-name": "tempAPI", "version": "1.0.0" }, ……….. ], "schemes": [ "https" ]} fails with:{ "status": 400, "messa |
| 2024-10-03 | Embedded EDB PostgreSQL database license key expires on 1 October 2024 for API Connect V10.0.7.0 Kubernetes and VMware | This article discusses the effects of the embedded Postgres license key expiration on API Connect environments on Kubernetes, VMWare and OpenShift and offers guidance on remediation steps. The existing embedded Postgres license key is scheduled to expire on 1 October, 2024. After the expiration, some of the database operations will cease to function and might cause downtime. |
| 2024-10-02 | API Connect Gateway policies missing if XML Management interface is not enabled | Users might observe policies are missing on the API Connect Gateway if they do not enable the DataPower XML Management Interface for non-container based DataPower installations. |
| 2024-09-10 | Analytics index rollover is not working | Analytics records API events in indices named using the syntax apic-api-yyyy.mm.dd-nnnnnn, for example apic-api-2023.11.20-000005.When rollover runs, it rolls over the active index i.e. the one that's being written to. When it's rolled over, a new index is created, the new index becomes the active index, and the old active index becomes read-only. The yyyy.mmm.dd in the new index name will be the date that the rollover ran, and the nnnnnn will be 1 more than the sequence number |
| 2024-09-09 | X-Global-Transaction-Id Header Truncation in DataPower Gateway Logs | Why is the X-Global-Transaction-Id header truncated in DataPower Gateway logs, and can this limitation be adjusted? |
| 2024-09-03 | IBM API Connect Registering Gateway Service requires connectivity from Gateway to Platform endpoint hostname | To register a new Gateway service in IBM API Connect, the cloud cannot complete the service registration if DataPower cannot resolve the hostname of the Platform REST API endpoint. |
| 2024-08-29 | API Connect API's with Path parameter might see behavior change after DataPower fix pack 10.5.0.10 | Users who use an API with Path Paramerter might face issues with calling their API's after upgrading to DataPower fix pack 10.5.0.10. This is because DataPower 10.5.0.10 enforces changes related to Pattern verification. |
| 2024-08-29 | How to Manually Delete Backups and WALs in SFTP Servers Configured for API Connect 10.0.8.x Management Backups | In API Connect 10.0.8.x, both backup files and Write Ahead Logs (WALs) are archived to the SFTP location specified in the management CR databaseBackup section. This differs from version 10.0.5.x, where only backups were written to the SFTP location, and WALs were stored locally. This new design prevents issues with missing WALs seen in earlier versions. There is a known issue in APAR LI83220 with automatic deletion of backups and WALs in SFTP servers and local backups in version 10.0.8.0, resolved in fix pa |
| 2024-08-08 | How to Add a User from Cloud Pak User Registry to API Connect | This document outlines the process of creating a user in the CP4I Platform UI and subsequently adding this user to API Connect. The steps include logging into the CP4I Platform UI, creating a user, setting credentials, and testing the login. It then describes the process of adding the user to API Connect via the API Manager UI, including the invitation and activation steps. |
| 2024-08-05 | Post reboot, API Connect VM does not start any pods | After rebooting the API Connect VM (Virtual Machine) deployed in VMWare using OVA, the VM does not start any of the pods. |
| 2024-07-25 | IBM API Connect upgrade 10.0.5 to 10.0.8 db import job might fail if governance and Discovery features to the mgmt CR during same time as upgrade | API Connect 10.0.8 introduced the Discovery and Governance features. If a user includes those in the mgmt CR during an upgrade from 10.0.5 to 10.0.8 they will see the db import job (job with name like apic-mgmt-nnnnnnnn-db-1-import or management-xxxxxxxx-db-1-import) fail |
| 2024-07-23 | API invoke policy persistent idle timeout | What is the persistent reuse timeout on the invoke endpoint? When the invoke v2.0 policy points to an endpoint URL, how long will the connection to the endpoint remain established and reusable if Persistent Connection is checked? |
| 2024-07-23 | MustGather: API Connect v10 (all subsystems) | ATTENTION: This MustGather has been updated to utilize the new python based apic-mustgather tool. This new tool provides significant improvements: Reduction in the amount of time it takes the tool to run to completion Simplification to no longer require passing multiple parameters. By default, it will automatically collect: data from all namespaces relevant to API Connect diagnostic data for each subsystem present in the cluster data specific to OVA form factor |
| 2024-07-23 | Step-by-Step Guide to Enabling the Web GUI in DataPower Gateway for API Connect v10 Kubernetes Deployment | This technote provides detailed instructions on how to enable the WebGUI on IBM DataPower Gateway for API Connect v10 and set up access through Kubernetes. The WebGUI is not enabled by default and provides a graphical interface for managing your DataPower Gateway. |
| 2024-07-19 | How to download all the Published Products and APIs yaml files from API Connect | How to download all the Published Products and APIs yaml files from API Connect |
| 2024-07-18 | How to Remove / Delete a Gateway Service from API Connect | How to Remove or Delete a Gateway Service from API Connect |
| 2024-07-17 | Changing API Connect Elasticsearch and Logstash memory settings | Analytics data sporadically missing from UI or the storage and ingestion pods restarting themselves. |
| 2024-07-15 | API Connect Analytics can have poor performance when using an undersized deployment profile due to heap exhaustion | API Connect version 10.0.5 users might observe slow response time and missing information on the Analytics Dashboard if the heap does not have sufficient memory to handle the analytics data. |
| 2024-07-15 | IBM API Connect How to create a validate policy which strictly validates the properties defined in the schema | API Connect supports JSON schema validation of the message body using the validate policy, though the UI does not natively allow users to limit the schema to only the defined properties. As a result, we need clarification on how to enforce validation, so including a field not defined by the properties throws an error. |
| 2024-07-11 | Calling an API fails with response code 422 error when passing null value | In an API, the validate policy is set to employeeChangeRequest definition – operations: – change_employee execute: … – validate: version: 2.7.0 title: validate graphql-error-policy: all compile-settings: {} validate-against: definition definition: '#/components/schemas/employeeChangeRequest'Where : employeeChangeRequ |
| 2024-07-09 | apicops-v10 detect-invalid-oauth-providers: Detect OAuth API Security Definitions check failed | When performing an apicops pre-upgrade check, we encounter the following error:** Checking for Invalid OAuth APIs with securityDefinitions object **Command: apicops-v10 detect-invalid-oauth-providers*****************************Error: APIC_APICOPS_1002E – The following OAuth Providers where found to contain a securityDefinitions object. Remove securityDefinitions object from the OAuth providers:"subin-oauth-provider1: /api/orgs/<id>/oauth-providers/<id>""subin-oauth-provider-store: /api/orgs/< |
| 2024-07-05 | API Gateways with a substantial number of user-defined policies (UDPs) deployed can experience very high config load times. | If many UDPs deployed on the gateway then a significant increase in the time required to load the gateway configuration can be observed. It is not easy to quantify "a large number of user-defined policies". This could range for example from 100 large or complicated UDPs to over 1000 simple UDPs packaged within an extension on the gateway. |
| 2024-07-02 | New Install of OVA not coming up healthy due to ETCD performance. | Upon installing OVA with the ISO and powering up the VM user find that the install says done but finds pods missing or in crashloopback or pending statusOne of the following job pods and the job pods would likely show as 0/1 CrashLookBackOff: <managementcluster_CR_name>-up-apim-schema-0-to-<schema_number>* <managementcluster_CR_name>-up-lur-schema-0-to-<schema_number>*This can cause any of this: could be during apim/lur DB creation could be during schema jobs for apim or lur cou |
| 2024-06-27 | Install or upgrade of API Connect 10.0.8.0 fails with edb-operator in CrashLoopBackOff | Install or upgrade of API Connect 10.0.8.0 fails with edb-operator in CrashLoopBackOff |
| 2024-06-27 | Gateway logs shows recurring error – A problem occurred when sending some HTTP/2 frames | Why is the gateway logs showing the following error in application domain used by API Connect ?20240523T183203.234Z [apiconnect][0x80e00820][mpgw][error] source-https(apiconnect_https_9443): tid(35648704)[1.2.3.4]: A problem occurred when sending some HTTP/2 frames. Error code: -902. |
| 2024-06-27 | How to retire and delete a product using API Connect toolkit | How to retire and delete a product using API Connect toolkit |
| 2024-06-24 | Best Practice: How to pass query parameters to a backend using API Connect | What are the best practices for passing query parameters to a backend using IBM API Connect? |
| 2024-06-24 | How to use the Developer Toolkit to list API's and Products | Listing the API's and products is a common use case for scripting developer toolkit commands. This is because users might need to iterate over a list of the API's or Products. Some common use cases are deleting API's or products and editing a property on multiple API's. |
| 2024-06-05 | ***DEPRECATED generate_postmortem.sh *** MustGather: API Connect v10 (all subsystems) | THE generate_postmortem.sh TOOL HAS BEEN DEPRECATED. PLEASE DO NOT USE THIS DOCUMENT UNLESS YOU HAVE AN ISSUE USING THE apic-mustgather PYTHON SCRIPT. THE MUSTGATHER BASED UPON apic-mustgather PYTHON SCRIPT CAN BE FOUND here. |
| 2024-05-28 | What to know about changing the Developer Portal URL | How can I change the Developer Portal site URL? What should I consider before changing the URL? |
| 2024-05-22 | How to use the Global Error Policy to Catch Errors | The Assembly catch allows users to handle errors thrown during the assembly execution. Some errors returned from the assembly cannot be handled by the Assembly catch. To handle these errors, use the global error policy. Below is a list of errors that require the global error policy, details of how to initiate the error and the sample response that is returned by the error: 1.Error name:APIRuleError How to initiate error: Forget to pass a required parameter. Sample Response: { "httpCode": "400" |
| 2024-05-21 | API Connect gateway service might have port conflict if you attempt to register config that was previously deleted | Users might have a problem registering the API Connect Gateway service if the same configuration had been previously registered and later deleted in another domain. |
| 2024-05-20 | Gateway Peering best practices | How should I configure a "v10" gateway, 10.0.1 or 10.5.0, to have a simple and ideal or typical configuration to prevent possible issues or complications? |
| 2024-05-20 | Logging client ip within pods | The actual client ip address needs to be logged at the DataPower gateway, how can I do this and what limitations or issues will I run into? The short answer to this is the client ip can be problematic in a cloud environment. |
| 2024-04-29 | API Connect v2018 to v10 form factor Migration and OVA upgrade error during import of CSV | When migrating form factors to OVA, users might see errors during the import of the CSV, if the new ISO is not generated using the same encryption secret that was used on the previous version. |
| 2024-04-25 | Patching the Login_Security module to work with IBM API Connect portal site | The unexpected discontinuation of the login_security module from releases 10.0.5.8 and 10.0.8 presents a pressing dilemma for users who heavily depend on its security functionalities, compelling the adoption of proactive measures such as comprehensive support, detailed documentation, and exploration of potential alternative solutions to safeguard the continuity, security, and stability of customer deployments. |
| 2024-04-25 | How to add metadata to API using REST API | How to add metadata to API using REST API in IBM API Connect |
| 2024-04-23 | MustGather: LDAP problems on IBM API Connect v10 | What information needs to be collected to help IBM Support troubleshoot LDAP problems and how to collect it? |
| 2024-04-19 | Storage pods fail to come up after changing analytics from n3 to n1 profile | Analytics storage is no longer ‘Ready’ after switching from n3 to n1 deployment profile. This affects deployment profiles for both a standalone analytics cluster and an analytics cluster that has been deployed as part of an API Connect cluster (including Cloud Pak for Integration).This problem is specific to 10.0.5.1 and 10.0.5.2, has been fixed in 10.0.5.3.Analytics storage pod logs show errors similar to:[2022-11-15T09:28:57,263][WARN ][r.suppressed ] [production-a7s-storage-0] path: /_cluster/health, par |
| 2024-04-18 | Files referenced by API Connect Gateway service identification credentials must be in PEM or P12 format | Users will experience a problem with their API Connect Gateway service not being able to start up if they have configured the Certificate or key referenced by the identification credentials with a file that doesn't have file extension pem or p12. |
| 2024-04-16 | Portal reset password fails with the Unable to send email. Contact the site administrator if the problem persists error message in UI | Portal reset password fails with the Unable to send email. Contact the site administrator if the problem persists error message in UI. Here is a screenshot: |
| 2024-04-09 | Best Practice: How to change password alias in a running API Connect instance | It is recommended to change the Gateway peering password alias for security reasons described in the Security Bulletin: IBM DataPower Gateway does not force a Gateway Peering password change Clarification is needed about the best practices for changing this configuration for a running API Connect configuration. |
| 2024-03-29 | How to update products from the toolkit to behave similar to the API Manager UI | When a user updates a product from the Develop tab on the UI the product's modified time will update, but the modified time for any referenced API's is not changed. When a user tries to do the same operation using the toolkit, with the default products retrieved from the toolkit, they observe both the APIs and Product's modified times are updated. Seeing the modified time change for an API, which hasn't been recently changed might cause confusion for users. |
| 2024-03-07 | API Connect Rate Limit might return invalid 429 response codes before Rate Limit is exceeded | Users might observe a problem where the Rate Limits are returning an invalid 429 response code, when the rate limits defined in the plan are not exceeded. Users of API Connect version 5 after fix pack 5.0.8.10 and the version 5 compatibility gateway on API Connect v2018 and v10 are impacted by this issue. |
| 2024-03-05 | Portal Site shows following message : "The website encountered an unexpected error. Please try again later." | Portal Site shows following message : "The website encountered an unexpected error. Please try again later." |
| 2024-02-20 | API Connect 10.0.7.0 – Missing "Edit Condition" icon on Switch Logic Case | API Connect 10.0.7.0 – Missing "Edit Condition" icon on Switch Logic Case |
| 2024-02-19 | Publishing API fails with 409 error | Publishing API fails with 409 error |
| 2024-02-16 | MustGather: Rate Limiting Issues on DataPower Gateways and API Connect | The following information is required for IBM Support to utilize when troubleshooting rate limiting issues with DataPower Gateway and API Connect. |
| 2024-02-12 | Troubleshooting API Connect Analytics – Analytics running out of disk space on 10.0.5.x | Analytics running out of disk space |
| 2024-01-22 | 10.0.1.X and 10.0.4.X upgrades to 10.0.5.3 with an analytics n1 profile fail. | API Connect upgrades from 10.0.1.X/10.0.4.X to 10.0.5.3 with an analytics n1 profile fail with an operator runtime error after applying the 10.0.5.3 operator. The problem does not happen with an analytics n3 profile. |
| 2024-01-12 | portal sftp backup fails with Permission denied (publickey,gssapi-keyex,gssapi-with-mic) | The portal backup using sftp fails. |
| 2023-11-16 | Unable to mount storage volume to a pod with Multi-Attach error. | Unable to mount storage volume to a pod with Multi-Attach error for volume "pvc-xxxx". |
| 2023-11-14 | API Invoke policy persistent idle timeout | How do I configure the API Invoke policy persistent idle timeout? |
| 2023-10-03 | events:cloudCount fails with error when using timeframe option | The following error is reported: $ ./apic-10.0.5.4 -m analytics events:cloudCount –server cloud.mgmt.dev.apictenlts.ibmlab.test –analytics-service analytics –format json –timeframe yesterdayJSON: json: cannot unmarshal string into Go struct field .errors of type models.ErrorPropErrorsItems |
| 2023-10-03 | analytics events:cloudCount fails with Invalid mode specified [analytics]. Must be one of [ apicatalog, apim, consumer, portaladmin ]. | The following error is reported: ./apic -m analytics events:cloudCount –server cloud.mgmt.dev.apictenlts.ibmlab.test –analytics-service analytics –format jsonInvalid mode specified []. Must be one of [ apicatalog, apim, consumer, portaladmin ]. |
| 2023-10-03 | analytics events:cloudCount fails with User not permitted to access this resource | $ ./apic-10.0.5.4 login -u user1porg1 -p password -s apim.mgmt.dev.apictenlts.ibmlab.test -r provider/default-idp-2Warning: Using default toolkit credentials.Logged into apim.mgmt.dev.apictenlts.ibmlab.test successfully$ ./apic-10.0.5.4 -m analytics events:cloudCount –server apim.mgmt.dev.apictenlts.ibmlab.test –analytics-service analyticsError: error unmarshaling JSON: json: cannot unmarshal string into Go struct field .errors of type models.ErrorPropErrorsItemsThe following errors are noticed: |
| 2023-09-20 | Adding a user fails with the error user already exists in the ldap identity provider | When a user is deleted and readded to the provider organization in the API Manager UI an error is reported that the user already exists in the user registry, for example, ldap. |
| 2023-09-13 | How to add a hyperlink in notification templates | How to add a hyperlink in notification templates |
| 2023-09-11 | API Connect Analytics Dashboard might not display on versions before 10.0.5.2 | In API Connect releases before 10.0.5.2 users might see that the analytics dashboard doesn't display as expected, with fields unavailable in the API Dashboard. |
| 2023-09-06 | How to export more than 10,000 lines of analytics data? | Users are not able to export all our API Analytics and are limited to only 10,000 rows of data that can be exported in 200s. |
| 2023-09-05 | API Connect Validate policy returns status code 422 in case of a validate error | In API Connect version 2018 and prior versions, when the validate policy throws a ValidateError, the API returned status code 400. In API Connect version 10, the behavior changed and a status code 422 is returned. Why did the behavior change, and is it possible to return status code 400 instead? |
| 2023-09-05 | Resetting the admin password in the API Connect developer portal site without triggering the email | How to reset the admin password in the API Connect developer portal site without triggering the email ? There could be various usecases for this, example, the portal site admin has moved from the company and you need to reset the password since the password is not known and the admin's email inbox is not accessible. |
| 2023-09-05 | API Connect version 10 support in Nutanix | Does API Connect version 10 support deployment of OVAs in Nutanix? |
| 2023-09-05 | sftp backup of APIC Mgmt fails with – Uploading backup using protocol sftp failed. Please check protocol parameters | SFTP backup for management subsystem in an OVA / VM deployment fails with the following error which has been formatted for readability:$ kubectl logs pod/ibm-apiconnect-<pod_name> -n <namespace_where_APIC_is_deployed> {"level":"error", "ts":1664751426.8194463, "logger":"controllers.ManagementBackup", "msg":"SFTP: Management backup upload failed", "managementbackup":"default/mgmt-backup-hdhfs", "scriptOutput":"","error":"Uploading backup using protocol sftp failed. Please check pr |
| 2023-09-05 | API Connect management server upgrade step apicops version:pre-upgrade gives error | During an upgrade of API Connect in 10.0.5.2 when executing apicops version:pre-upgrade it gives an error, here is the excerpt from the output :The backup protocol for the current environment is sftpSo Ensuring that APIC can communicate with SFTP server with the configuration*** Entering the sftp connection validation ***Communication checks between sftp and pgbackrest ran successfullyTo make sure the mgmt-site1-postgres-backrest-shared-repo-<pod_name> have permission in sftp server, t |
| 2023-08-28 | How to interpret data collected from the API Probe on the DataPower API Gateway | The API probe captures transaction data for the API gateway. It can be valuable in debugging some issues on the API Gateway. |
| 2023-08-18 | Third-party OAuth scope handling behavior changes from DP:10.5.0.6, 10.5.1.x, 10.0.1.14 | Please note that, there is a significant change in the DataPower code (for handing scope validation for a Third-party OAuth Provider) from the following DataPower versions: 10.5.0.6, 10.5.1.x, 10.0.1.14 and onward.Current behavior:When you configure a third-party OAuth Provider, we don’t perform any scope validations from the Introspection endpoint response even if it is returning scopes. |
| 2023-08-15 | How to get the bearer token for using API Connect v10 REST APIs | Clarification is needed of how to get and use the Bearer token for calling the REST APIs in the API Connect REST API Documentation |
| 2023-08-15 | API Connect sandbox catalog name has changed from sb in version 5 to sandbox in version 10 | In API Connect version 5, the sandbox catalog name was set as "sb" as default. After upgrading from API Connect version 5 to version10, the catalog name changed to "sandbox". Is there any way to change the catalog name from "sandbox" to "sb" to maintain a similar path as API Connect version 5? |
| 2023-08-14 | How to capture details of oauth errors in apic v10? | In APIC version 10, when there is an oauth failure, it returns a generic message: "Cannot pass the security checks that are required by the target API or operation, Enable debug headers for more details." |
| 2023-07-28 | apicup subsys install fails with fatal error: runtime: out of memory | apicup subsys install fails with fatal error: runtime: out of memoryFor example:./apicup subsys install subinmgmt /subin/apic/apic/upgrade_management_10.0.5.4.tgz –debugfatal error: runtime: out of memoryruntime stack:runtime.throw({0x1c5f28c?, 0x0?}) /usr/local/go/src/runtime/panic.go:1047 +0x5d fp=0xc000097df8 sp=0xc000097dc8 pc=0x4353fdruntime.sysMapOS(0xc009400000, 0x17a800000?) /usr/local/go/src/runtime/mem_linux.go:187 +0x11b fp=0xc000097e40 sp=0xc000097df8 pc=0x417e9bruntime.sysMap(0x2 |
| 2023-07-28 | apicup subsys install fails with fatal error: runtime: out of memory | apicup subsys install fails with fatal error: runtime: out of memory |
| 2023-07-20 | API Connect v10 SFTP Backup limitation with some SFTP servers | The management subsystem uses a different client for SFTP backup than what is used in the Portal subsystem. There are observed limitations with the management subsystem unable to take an SFTP backup to certain types of SFTP servers.Limitations are observed with using the following SFTP servers:Atmoz SFTP (https://hub.docker.com/r/atmoz/sftp)Azure blob storageWindows Server 2016 Standard |
| 2023-07-20 | IBM API Connect 10.0.1.6ifix1 to 10.0.5.3 fails with failed to pull image registry.k8s.io/pause:3.6 | You will find these errors in the VM where API Connect upgrade is failing after ssh to it and running the following command : journalctl -u appliance-manager -f<date> <host> kubelet[547853]: E0720 10:14:06.993195 547853 remote_runtime.go:198] "RunPodSandbox from runtime service failed" err="rpc error: code = Unknown desc = failed to get sandbox image \"registry.k8s.io/pause:3.6\": failed to pull image \"registry.k8s.io/pause:3.6\": failed to pull and unpack image \"registry.k8s.io/pause:3.6 |
| 2023-07-05 | MustGather: API Connect v2018 (all subsystems) | This document provides instructions for gathering diagnostic data for API Connect deployments on both Kubernetes and VMware. |
| 2023-07-03 | Loopback Mustgather | Follow this section to collect the data required to diagnose and resolve loopback issues Provide the operating system and its version where loopback is installed, or if the issue with loopback in IBM Cloud Provide the node, npm and loopback version using the commands : node -v npm -v npm ls –depth Provide details of use of LoopBack connectors Node module name of the LoopBack connector, for example, loopback-connector-db2. If it is a database connector, specify the database version is being u |
| 2023-05-09 | Billing in Portal is broken for 10.0.5.3 | When users access the Billing Configuration Forum, they receive a White screen and the error "The website encountered an unexpected error. Please try again later." |
| 2023-05-03 | Developer Portal throws PHP Fatal error due to issue with defining $title | Users might see an error like the following in the portal-www pod:"PHP message: PHP Fatal error: Type of Drupal\ibm_apim\Updater\ApicModule::$title must not be defined (as in class Drupal\Core\Updater\Updater) in /web/platforms/devportal-9.x-10.0.1.11-20230207-1645/modules/ibm_apim/src/Updater/ApicModule.php on line 22" Drupal 9.5 updated to add title to the Update file (https://github.com/drupal/drupal/blob/9.5.x/core/lib/Drupal/Core/Updater/Updater.php#L35) and PHP doesn't allow users to redefin |
| 2023-04-30 | Incorrect v5 emulation (v5e) policy list in API Connect gateway extension manifest in not validated properly | For API Connect 10.0.5.3 with Datapower 10.5.0.5, you can specify a nonexistent policy in the gateway extensions manifest. |
| 2023-04-26 | API's secured by OAuth do not record for successful API calls in analytics for errors in API Connect v5/v5C | How does analytics work in API Connect V5/V5C when an API is secured by OAuth? |
| 2023-04-24 | Options for migrating a gateway cluster | A How-To document to provide steps one can take to migrate a set of gateway clusters. |
| 2023-03-28 | MustGather: OAuth problems on IBM API Connect | What information should be collected to help IBM Support to troubleshoot OAuth problems in IBM API Connect? |
| 2023-03-02 | Enable DataPower webgui in cp4i and OCP | WebGui is not enabled by default. Access to webGui is helpful while debugging gateway problems and collecting logs. You can enable webGUI for DataPower container running in cp4i/ocp |
| 2023-02-20 | Changing the API version of a WSDL via the toolkit | At this time, the only way to create a new version of an existing WSDL API via the toolkit is to convert the WSDL file to a yaml first and then change the version and upload it to the UI. |
| 2023-02-20 | WSDL Definition does not contain the service | When uploading a WSDL .zip file to the API Manager to create the API, you are getting an error that saysThe WSDL definition does not contain the service 'Service_Name' requested by the wsdl_service query parameter. |
| 2023-02-20 | Remote Helper Files for WSDL API | When creating a WSDL API through the toolkit or UI, please note that remote file access is not supported.All helper files must be contained in the main file or .zip package. |
| 2023-02-08 | MustGather: Collecting Data for IBM API Connect as a Service on Amazon Web Services (AWS) | When opening a case with API Connect SaaS on AWS, provide a detailed problem description to include the following information:1. Description of the problem Fully describe the problem you are experiencing (please provide the full error messages). What were you attempting when the problem occurred? When did you first noticed it? When applicable, please provide a list of steps to re-create the problem (screen images will help to identify more details) Define the scope of the issue: How many objects (APIs, Prod |
| 2023-02-01 | Portal sites do not work after failover in 2DCHA for OVA/VMware (and any form factor if the portal CR names are different). | This bug affects 10.0.5.2 GA Only.For 2DCHA on any form factor, when the portal CR names are different in each DC, the portal-db certificate does not have all the necessary DNS names inside it and so the portal sites do not work after failover. When trying to access the portal sites, after a failover, the following error message is shown in the browser:'The website encountered an unexpected error. Please try again later.' APAR number for this issue: LI82863, which is fixed in v10.0.5.2-ifix1 and is als |
| 2023-01-03 | Portal upgrade might get stuck in pending after editing CR version | API Connect 10.0.5.2 introduces a validation to the Portal backup and restore CR to ensure correctness by using webhooks.Users might experience an issue where the operator attempts to inject new fields, but the operator is unable to save the CR as it's invalid and the operator gets itself into an infinite loop. |
| 2022-12-15 | Portal upgrade might be slow due to changes in 10.0.5.2 | API Connect 10.0.5.2 introduces new fields to the Portal backup and restore.If you have thousands of Portal backup records, when upgrading to 10.0.5.2 the Upgrade process might perform slowly because the process updates all of the existing Portal backup records with the new fields. |
| 2022-12-15 | Portal cannot communicate to management subsystem if microServiceSecurity: custom is used | A portal subsystem that uses microServiceSecurity: custom results in the API Manager being unable to communicate with the portal, which also means snapshots fail to reach the portal. |
| 2022-12-15 | Portal refuses to use x509 certifcate generated by an ACME issuer | Portal subsystem refuses to use a portal-web x509 certificate that was generated by an ACME issuer (https://cert-manager.io/docs/configuration/acme/) and contains the data ca.crt: "" |
| 2022-12-15 | Portal CLI tasks can get stuck in "Warning" and never complete. | Portal CLI tasks can get stuck in "Warning" and never complete. Affected are users running API Connect releases before and including 10.0.1.9 and 10.0.5.2. |
| 2022-12-15 | Portal site restore fails with "Could not create database" in the portal www pod, admin container logs. | When a user restores a portal backup for all sites or a specific site, one or more of the sites might fail to install. |
| 2022-12-13 | Scaling down API Connect analytics: Switching from n3 to n1 profiles | Analytics storage is no longer ‘Ready’ after switching from n3 to n1 deployment profile. This affects deployment profiles for both a stand-alone analytics cluster and an analytics cluster that has been deployed as part of an API Connect cluster (including Cloud Pak for Integration). |
| 2022-11-03 | S3 Disaster Recovery fails for Management Subsystem on API Connect v10.0.1.8 and v10.0.5.1 | When restoring a backup on the management subsystem that uses S3, it might fail, and the Management Cluster CR goes into warning status. Observed behaviorManagement CR shows wal is not working fails: |
| 2022-11-03 | Upgrade/Restore to portal sites fails due to invalid language code issue | Upgrading portal sites fails due to some invalid language code issue, for example:Invalid translation language (en) specified. [77.99 sec, 6.02 MB] [error] |
| 2022-10-14 | API Connect v10.0.5.1 removes support for TLS 1.0 and TLS 1.1 | API Connect v10.0.5.1 removes support for TLS versions 1.0 and 1.1 on the Management server. This change does not impact the Gateway server that is installed as part of an API Connect deployment. |
| 2022-10-11 | Customers migrating from API Connect v5 need to be using a minimum of N-2 of the AMU tool | There is a need to get customers doing migration to be on or as close to the latest level of API Connect as possible and always using the latest AMU tool. If a customer is on an earlier fix-pack of API Connect, they need to move up to a minimum of N-2 in order to get AMU support. |
| 2022-09-29 | Help to convert API Connect v5 GatewayScript code to compatible API Gateway code | There are known issues when customers attempt to manually convert v5c artifacts to the API Gateway. |
| 2022-09-13 | MustGather: Creating LogTargets via the Rest Management Interface on DataPower Gateway Container | When troubleshooting issues on DataPower, it is necessary to use a log target object. For DataPower containers, the log targets can be quickly created through the Rest Management Interface.Before going any further, ensure that you have enabled the Rest Management Interface on your DataPower Gateway.Use this article to collect the MustGather information required for IBM DataPower Support to help diagnose and solve your problem. |
| 2022-09-13 | MustGather: Collecting Information for API Objects and Status Providers the API Connect Gateway Component | This guide is to help you check individual process statuses as well as object statuses within your APIC Configuration. The information gathered here should be shared with your IBM APIC Support Agent within your Support Case. |
| 2022-08-31 | Updating certificate used by API Gateway on Datapower (API Invocation Endpoint from the API Gateway Service registration in the API Connect Cloud Manager) | Customer attempts to follow the API Connect product documentation trying to update a TLS profile that has an invalidated or expired certificate tends to lead to more questions and unknown answers. The API Connect support team documented a few simple steps and links to help resolve issues that can arise and allow customers to progress further with expiring certificates needing to be updated. |
| 2022-08-31 | Steps to update API Connect v2018 Entrust certificates for APIC Management and other subsystems | Customer attempts to follow the API Connect product documentation trying to update Entrust certificates for APIC management and other subsystem tends to lead to more questions and unknown answers. The API Connect support team documented a few simple steps and links to help resolve issues that can arise and allow customers to progress further with expiring certificates need to be updated. |
| 2022-08-31 | How to obtain a sample input file for a Developer Toolkit command | The API Connect Developer Toolkit has commands that require an input in the format of JSON/YAML to be provided. This technote provides an approach to use to obtain the input structure or sample based on the API Connect Platform REST API documentation. |
| 2022-08-30 | Error: invalid alphanumeric key length 0 expected 100 for original-encryption-secret while setting up portal DC2 | ptl1 and ptl2 are 2 portal subsystems in 2 DCHA./apicup certs set ptl2 encryption-secret encryption-secret1fails with:Error: invalid alphanumeric key length 0 expected 100 for original-encryption-secret |
| 2022-08-29 | How To: Use the Rest Management Interface on IBM DataPower Gateway | The RMI is a powerful tool for interacting with your DP/APIC Configuration. By using the RMI, you can access your configuration without using the online portal at all, making it useful for situations in which your portal is down, or for automated processes, such as through scripting. |
| 2022-08-15 | Installing a custom DataPower image through API Connect Operator | DataPower development creates firmware images (special builds) from time to time that are not generally available through normal means (such as fix central or the entitled registry). These images include debug builds, special builds (with custom fixes), and early releases of builds before it is GAed. This How-To provides steps to install the DataPower special firmware images by using API Connect (APIC) Operator from the custom registry. When APIC Gateway subsystem is installed and managed through APIC, t |
| 2022-08-04 | Cannot find appliance-control-plane-1.22.1.tgz required for upgrading to v10.0.1.x | Upgrading to 10.0.1.6 or 10.0.1.7 and need appliance-control-plane-1.22.1.tgz for your OVA deployment |
| 2022-08-02 | Long delay during API Connect Gateway service registration | Users might experience up to 30mins delay when performing below actions: Registering new Gateway service with management server Adding new Gateway server to Gateway cluster When rebooting or restarting GatewayThese Logs entries can be seen in DataPower error report or gwd.logs:[0x80e0084c][apic-gw-service][debug] apic-gw-service(default): tid(9248): lib:gateway-controller:apigateway:ApiGatewayConfigStatus: /drouter/local/abcd/config-sequence is NOT up-to-date: No log statFirst timeout after 10 minutes and s |
| 2022-08-01 | Management backup might remain in pending state blocking other backup from completing | A management backup might remain in a Pending state for a long period, particularly after upgrading the management subsystem. A pending backup blocks other backup from completing. |
| 2022-07-19 | Best Practice: Use a custom Gateway peering object when configuring the API Connect Gateway service | Rebooting your DataPower can bring the default Gateway peering object "default-gateway-peering" to disabled state. If the API Connect Gateway service references this object, it can result in it going down. |
| 2022-06-14 | API Connect HTTP GET ?WSDL retrieval returns "401 – Unauthorized Invalid client id or secret" | API Connect v5 allowed GET ?WSDL requests by defining the WSDL in your service. Newer versions of API Connect, such as v10 or later require modification to the assembly in the preflow. |
| 2022-06-10 | How to properly health check an API Connect gateway | Often load balancers use simple TCP or similar lightweight default health checks that do NOT properly mark the gateways down.This can result in a failure for both the management communication to the API Connect Gateway and also for the client to API Gateway, API invocation. |
| 2022-03-30 | How to update API Connect SLM peer group to use Unicast | By default API Connect version 5 uses SLM Multicast. SLM multicast has requirements that are described in the DataPower documentation. If Multicast isn't an option in your network, it's possible to update the SLM Peering configuration to unicast. After confirming SLM unicast works, you'll want to setup a Gateway extension so the management server is aware of the changes and the configuration will persist. |
| 2022-03-18 | Upgrade to v2018.4.1.19 and issue while upgrading to v2018.4.1.16 in OVA | Upgrade from v2018.4.1.13-ifix3.0 or earlier to v2018.4.1.19 Before upgrading to v2018.4.1.19, verifying the upgrade tarballs is important to ensure you have the correct archive and prevent appliance stuck while running the upgrade task. Should there be a problem with applying a wrong tarball, you can recover by running the workaround. Issue while upgrading to v2018.4.1.16 You may see in the appliance-manager log "helm rendered manifests contain a resource that already exists" and the upgrade |
| 2022-02-15 | Required Steps for all v10 customers to slow disk filling due to WAL archive failure. | There is a known issue where the pgwal PVC will fill up when WAL archiving is failing. When it is close to 80% (Kubernetes, ICP, CP4i, OpenShift) or 70% (OVA) the management CR will go into Error state and the postgres database is shut down.Users see following message when describing the management CR. "Current disk usage is more than 80 percent. DATABASE will be shut down. Please contact IBM Support immediately." |
| 2022-02-01 | OVA upgrade fails for v10.0.1.5 with no available PVs(persistent volumes) | One, or more, of the pods in the VMWare API Connect deployment are stuck in Pending state |
| 2022-01-21 | Upgrade paths to 5.0.8.1x and Issues while upgrading and post upgrade 5.0.8.1x | Upgrade Path Creating a backup of an API Connect configuration. Also, it is highly recommended that you take VM Snapshot of API Connect appliances. Upgrade paths to latest v5.0.8.11 or later If you are on any version prior to 5087ifix4 then upgrade to 5087-ifix4 // to save analytics data Apply 50810ifix2 /// Minimum required for OS upgrade Run config autodiskadd disable on 50810ifix2 run config autodiskadd status // to confirm status shows enable: false Add a NE |
| 2021-11-30 | On APIC cp4i 2020.x, if the user is not on-boarded, they will receive a 401 error during the authentication step. | For API Connect version 10.0.1.5 or earlier running on Cloud Pak for Integration 2020.x, the user must be on-boarded with an invitation in order to authenticate successfully with API Connect. If the user is not on-boarded, they will receive a 401 error during the authentication step. |
| 2021-11-30 | Update new AWS CA cert used by API Connect Management subsystem (s3 backups) | Note: This document is only relevant to customers who are using AWS s3 as their backup solution in API Connect Management subsystem AWS now started using it's own CA certificate authority and it has started rolling out it's changes to regions. At the time of this writing, we are sure that eu-west-1 and us-west-2 regions now use latest CA authority. What features won't work? Fresh install of IBM API Connect Management subsystem when s3 backups are used. S3 backups of existing installations. S3 resto |
| 2021-11-20 | Information about compatibility of IBM License Metric Tool (ILMT) with IBM API Connect | Is IBM API Connect compatible with the IBM License Metric Tool (ILMT)? |
| 2021-11-01 | Troubleshooting API Connect Analytics – Missing analytics due to split brain | Missing analytics due to split brain |
| 2021-10-18 | Troubleshooting API Connect Analytics – Analytics running out of disk space | Analytics running out of disk space |
| 2021-10-18 | Troubleshooting API Connect Analytics – No analytics are seen in the APIC analytics dashboard. | Troubleshooting API Connect Analytics – No analytics are seen in the APIC analytics dashboard. |
| 2021-10-14 | Analytics is not working even though Analytic helath | Analytics is not working however output of 'system show analytics health' is green |
| 2021-10-12 | Portal upgrade is stuck in SETUP_SUBSYSTEM | Portal subsystem is stuck at the SETUP_SUBSYSTEM, when upgrading to 2018.4.1.17.Type: BOOTSTRAP_MASTERInstall stage: SETUP_SUBSYSTEMUpgrade stage: UPGRADE_DONESubsystem type: portalSubsystem version: 2018.4.1.17Subsystem detail: Running helm upgrade |
| 2021-10-07 | API request fails with HTTP 401: Unauthorized, with error message "registration not active for plan" | API request fails with HTTP 401:Unauthorized, throwing this error message in the gateway logs "registration not active for plan" |
| 2021-10-06 | How to enable web-mgmt in cp4i? | Web Management is disabled by default in Datapower containers. It is required to access webui for troubleshooting. This technote provides different options to enable web-mgmt and persist the pod restart. |
| 2021-10-06 | Unable to delete PVC when retrying APIC upgrade from 2018 to v10. | How to delete a PVC that remains in "Terminating" state after a failed attempt of apic upgrade from 2018 to v10? |
| 2021-09-28 | After upgrading portal to a newer version, few sites remain in UPGRADING state. | After upgrading portal to a newer version, few sites remain in UPGRADING state. The platform version on these sites still shows the old version. |
| 2021-08-17 | Upgrade to API Connect 10.0.1.4/10.0.3 fails with data populate 409 error | When you upgrade to 10.0.1.4 or 10.0.3, the following error occurs during data population and the upgrade aborts.Example of error from the apim-data-populate pod:[00000000-0000-0000-0000-000000000000] Error in POST post:/api/tasks (my_task.js:create) – status : 409 – message: Another request might be operating on the resource. Please try again later. – stack : Error: Another request might be operating on the resource. Please try again later. at error (/app/node_modules/bhendi/lib/bhend |
| 2021-08-13 | DataPower or API Connect VMWare OVA Deployment Fails | There is an issue deploying either DataPower or API Connect OVA to a VMWare environment. |
| 2021-08-13 | DataPower Gateway x2020_valcred is not up for V5C Gateway | The following errors may be seen if there is an issue with the x2020_valcred object: [0x00f30009][mgmt][error] idcred(x2020_idcred): tid(111) gtid(c3bb437cde7348db8608e61fbc8edc04): Mismatched public/private key pair[0x81000013][mgmt][error] valcred(x2020_valcred): tid(1234): Cannot be deleted. In use by: ssl-client(api-sslcli-x2020) profile(x2020_crypto_profile)[0x8060010a][crypto][warn] valcred(x2020_valcred): tid(12345): certificate validation failed for '/CN=analytics-ingestion-ingress' against 'x |
| 2021-08-12 | ACCESS CONTROL FOR APIC ENDPOINTS USING NGINX CONTROLLER | In IBM API Connect, you can configure an access control based on client IP addresses -using a Kubernetes ingress-nginx-ingress controller. Using the ingress controller allowlisting, you can also restrict access for different endpoints.For example: cloud-admin-ui, api-manager-ui, platform-api, consumer-apiNOTE: This article refers to a third-party software that IBM does not control. As such, the software might change and this information can become outdated. The steps described here, |
| 2021-08-03 | How to consume Consumer APIs provided by API Connect Platform | This article describes how to consume the API Connect Consumer APIs that is provided by the platform. The API Connect Platform REST APIs provide complete access to the capability of the platform. Consumer APIs can be used to automate administration of consumer side of the platform, for example consumer orgs, users, app registrations and so on. |
| 2021-08-02 | How to consume API Connect Platform – Cloud Management and Provider APIs | This article describes how to consume the API Connect Platform – Cloud Management and Provider APIs. The API Connect Platform REST APIs provide complete access to the capability of the platform. They can be used to automate administration of the platform, for scripts and tools to support a continuous integration environment, for API development and publishing, and for management of catalogs of APIs and their subscribers. The operations provided in the REST API also correspond directly with commands in th |
| 2021-07-27 | How does the API Connect Client ID and Secret work? | How do the Client ID and Secret work with API Connect version 2018? |
| 2021-07-27 | Using REST API's in high concurrency may result in error | The API Connect version 5 Developer Portal REST API's are not designed for high concurrency and will throw 500 error if executed in high concurrency. |
| 2021-06-23 | How to obtain the bearer token for API Connect REST APIs | This technote was created to provide sample steps to obtain the bearer token used to invoke the API Connect REST APIs. |
| 2021-04-07 | Consideration for upgrading v5 API Connect to latest release and migrating v10 | What are some good considerations for upgrading v5 API Connect to latest release? |
| 2021-02-23 | API PORTAL SERVER AFTER UPGRADE GIVE ERRORS WHEN RUNNING SCRIPT : RUN_BG_SYNC -F | Error seen when running RUN_BG_SYNC -FNote: This effects ubuntu18 clustered customers. |
| 2021-02-18 | MustGather: Collecting data for API Connect version 4 and version 5 Upgrade issue | Contact IBM Support if you experience a problem with IBM API Connect. Use the details in this document to provide all of the relevant information to the Support team to help with problem resolution. |
| 2021-02-18 | Mustgather Troubleshooting issues with APIs calls returning unexpected results | What information should be collected to help IBM Support to troubleshoot issues with APIs calls returning unexpected results in IBM API Connect? For example, here are problems involving symptoms such as: API Calls return HTTP 404 API Calls fail intermittently or do not work consistently between invocations APIs behave differently between gateways Publishing artifacts never becoming available API Calls fails with No Policy Defined |
| 2021-02-18 | MustGather: SSL and certificates problems on IBM API Connect | What information should be collected to help IBM Support to troubleshoot SSL and certificates problems in IBM API Connect? |
| 2021-02-18 | IBM MustGather: Read first for IBM API Connect | MustGather information aids in problem determination and save time resolving cases. API Connect Support can understand better the problem and save time analyzing the data. |
| 2021-02-09 | Upgrade OVA ENV to 2018.4.1.15 failed for Analytics | While upgrading OVA environment to 2018.4.1.15 Analytics upgrade is never completed, as the helm upgrade is failing.journalctl -u appliance-manager -f output shows:Feb 04 14:22:41 hostname apic[19457]: time="2021-02-04T14:22:41Z" level=debug msg="helm [upgrade apic-analytics /var/lib/apiconnect/subsystem/helm/apic-analytics –values=/tmp/701472419]"Feb 04 14:22:41 hostname apic[19457]: time="2021-02-04T14:22:41Z" level=error msg="unable to get upgrade helm chart: exit status 1"Feb 04 14:22:41 hostname apic[ |
| 2021-02-09 | APIC v5 Manager OVA deployment issues into VMWare vSphere v6.5 | User cannot deploy APIC v5 OVA into VMWare vSphere 6.5. VMWare complaining issue with template "Issues detected with selected template. Details:" – 52:9:ELEMENT_ILLEGAL:Element "partition" is not allowed |
| 2020-12-18 | Importing Analytics dashboards from one catalog into another does not work properly in IBM API Connect | After attempting to display an imported dashboard, you either see an empty page, or see an error similar to the one below in place of one or more of its visualizations:"Could not locate that visualization (id: fed6da7e-4db4-4e32-b2e0-5a59d044cdea)" |
| 2020-11-13 | MustGather Version 10.x | MustGather Version 10.x |
| 2020-11-13 | Collect MustGather data for IBM API Connect Version 5.0 | Contact IBM Support if you experience a problem with IBM API Connect. Use the details in this document to provide all of the relevant information to the Support team to help with problem resolution. |
| 2020-11-13 | MustGather Version 2018.x | MustGather Version 2018 |
| 2020-10-06 | Upgrading from API Connect v10.0.0.0 to v10.0.1.0 requires intermediate pre-requisite upgrade to v10.0.0.0ifix2 | IBM API Connect support would like to reemphasize one of the prerequisite steps needed to upgrade to API Connect v10.0.1.0 from v10.0.0.0. as described in the announcement material here: https://www.ibm.com/support/pages/node/6339249Note that this upgrade API Connect v10.0.0.0 to v10.0.1.0 requires that you first upgrade to v10.0.0.0-ifix2, see the IBM Knowledge Center details here:https://www.ibm.com/support/knowledgecenter/SSMNED_v10/com.ibm.apic.install.doc/upgrading_ova.htmlThe required instal |
| 2020-07-27 | IBM API Connect Analytics Filtering Sensitive Headers | Modify Analytics Engine to filter sensitive headers |
| 2020-07-22 | How to push REST APIs from App Connect Enterprise to API Connect | In order to push REST APIs from App Connect Enterprise to API Connect, you will need client application credentials and a realm to connect to API Connect. This article describes how to register a client application in API Connect in order to obtain credentials, and how to find the realm value. |
| 2020-07-20 | MustGather: Security Vulnerability issues for API Connect & DataPower Gateways | This document describes the MustGather process for opening a security vulnerability case with IBM Support.How to report a security vulnerability with IBM Support: Before you report a security vulnerability issue with IBM Support, please take the following steps: 1. Test the vulnerability on the latest version fix pack of the product. It is important to make sure any security scan is performed on the latest release to avoid reporting current fixed issues. See latest |
| 2020-07-20 | MustGather: API Connect gateway service v2018.4.x | MustGather information and logs needed to troubleshoot an issue involving the API Connect gateway service within API Connect v2018.4.1 and later |
| 2020-07-10 | How to configure API Connect v5 to integrate with DataPower Link Aggregate Interface | The steps described here, outline Configuring a DataPower to handle API Calls with a Link Aggregation interface. |
| 2020-06-25 | Not able to Access CMC/APIM User Interface | Problem: User's are not able to access Cloud Console or API manager UIError in CMC UI : This site cann't be reached.Error in Portal CLI: APIC Certificate Status (Mismatch): ERROR – Unknown error. Please run set_apim_cert to configure and install a valid public certificate.Error in seeing var/log/apim_rproxy_error.log:[error] [client IP:49914] [7f185c01c350] [8938] SSL0221E: SSL Handshake Failed, Either the certificate has expired or the system clock is incorrect. [IP:49914 -> IP:443] [07: |
| 2020-06-22 | How to change Consumer Organization Owner if Owner left company? | How to change Consumer Organization Owner if Owner left company? |
| 2020-05-28 | How to scale APIC pods | If you need to temporarily scale up or down the pods running. For example if you are unsure which APIM-v2 pod is handling the publish, config change, etc you may need to have only a single apim-v2 instance. This would force the activity to be handled by just this pod and allow simpler debugging rather than have the actions spread over three possible nodes. |
| 2020-04-27 | MustGather: API Connect Management server v2018 | Contact IBM Support if you experience a problem with IBM API Connect. Use the details in this document to provide all of the relevant information to the Support team to help with problem resolution. |
| 2020-04-20 | Capture the 429 error when rate limit exceeds in a plan with IBM API Connect | Can I capture the 429 error when rate limit exceeds in the Assembly in IBM API Connect? |
| 2020-04-01 | Collect MustGather data for IBM API Connect Gateway | Gather the following MustGather information for IBM Support to use in troubleshooting problems with IBM API Connect Gateway (Microgateway and DataPower). |
| 2020-04-01 | Identifying the DataPower domain name of the API Connect created domain | You configure multiple Gateway services that share a single DataPowerReference: https://www.ibm.com/support/knowledgecenter/en/SSMNED_5.0.0/com.ibm.apic.cmc.doc/create_multiple_gateway_clusters.htmlHow can you identify which domain corresponds to which Gateway service? |
| 2020-03-25 | IBM API Connect Mustgather – Portal 2018 | Contact IBM Support if you experience a problem with IBM API Connect. Use the details in this document to provide all of the relevant information to the Support team to help with problem resolution. |
| 2020-03-25 | Mustgather for Analytics server 2018 API Connect | MustGather information aid in problem determination and save time resolving Problem Management Records (PMRs). API Connect Support can understand better the problem and save time analyzing the data. |
| 2020-03-20 | IBM API Connect Developer Portal Upgrade Issues moving to 2018.4.1.10 | Customers may experience problems upgrading their Developer Portal subsystem and sites to version 2018.4.1.10, if not done directly from version 2018.4.1.9iFix1.0. |
| 2020-03-13 | MustGather: Collecting the data needed for IBM Support to restore a client backup of an API Connect subsystem within the IBM secure lab | IBM Support indicated that they need a backup from an API Connect subsystem in order to progress identifying root cause. What actions need to be taken in order to provide all of the information and data needed by IBM Support? |
| 2020-03-02 | How to Extend SMTP Timeout for API Connect | By default there is a 10 second timeout configured for the SMTP server used by API Connect. In cases when the mail server is slower to respond, the timeout triggers invalidating the invitation. The mail might still deliver to the recipient, but the invitation link is broken due to the timeout. |
| 2020-02-26 | How to register an app with API Connect cloud to consume API Connect consumer APIs | This article describes how to register an app with API Connect cloud to consume API Connect consumer APIs. |
| 2020-02-22 | IBM API Connect OVA deployment with VMware vCenter 6.5 fails | When using VMware vCenter 6.5 to deploy the IBM API Connect OVA, the deployment fails with the following message.OVF package with compressed disks is currently not supported for OVF import. |
| 2020-01-24 | DataPower Gateway Application Optimization Module is required for certain deployments of API Connect (Version 2018.4.1.7 or earlier) | When you deploy DataPower Gateway service with the Kubernetes distribution of API Connect Version 2018.4.1.7 (or earlier), you must also install the Application Optimization (AO) module if 1) the deployment is a production deployment and 2) uses the v5-compatible DataPower Gateway Service. Note the Application Optimization module is not needed for production deployments that use DataPower API Gateway, nor for non-production deployments. The requirement was eliminated for API Connect v2018.4.1.8 or |
| 2020-01-03 | Rate Limit calculation at Plan level | How is the Rate Limit calculated when applied at Plan level? Is the Rate Limit shared across all API Operations in the Plan? |
| 2019-11-25 | Restrict access to API operations using plans for a group of consumers | This article will describe how to restrict access to only certain API operations for a given group of consumers by creating a plan for them and have them subscribed to that plan only. Often there is a requirement to allow read only access to API(s) to the certain group of consumers. If your backend services follow leading REST practices, you can achieve this by creating a plan that will only allow access to the GET HTTP method of APIs and only allow subscriptions to the plan for that group of consumers. |
| 2019-11-25 | Prevent Developer Portal users from creating consumer organizations | How do I prevent Developer Portal users/consumer organization owners from creating consumer organizations? |
| 2019-11-22 | How to recover Developer Portal site admin password | Admin User is not able to reset the Developer Portal site "admin" account password via the Forgot Password link on the Sign In page. |
| 2019-11-20 | Considerations when using a BigIP F5 load balancer in front of API Connect v2018 | Performance Layer 4====================Make sure to configure F5 for Performance Layer 4 virtual server, see https://support.f5.com/csp/article/K8082This is in particular needed to allow for SSL passthrough required for mutual SSL connections between certain API Connect subsystems.API Connect appliances and dropped connections==============================================When using F5 there has been reports that connections to API Connect may be intermittently failing, and looking at TCPDUMP captures would |
| 2019-11-11 | How to change the hostname within your v5 DevPortal | How do I change the hostname of my v5 DevPortal? |
| 2019-06-25 | Ingress controller may stop processing requests and hang | Prod Mgt – "An unknown Server Error Occured : 502 API Error" return when accessing the manage catalog page |
| 2019-04-30 | IBM API Connect Configuring a Password for SMTP server without Password will result in authentication error | If a user accidentally configures the optional User name and password fields for their SMTP server which does not require a user name and password on the Cloud Management Console (CMC) Settings>Email page it will throw an authentication error when trying to invite new users to a Provider Organization, resend emails to existing users who have not activated their account, and when you try to test the SMTP configuration. |
| 2019-04-26 | Troubleshooting blocked or expired user(s) in API Connect Developer Portal v5 | One or more users report being blocked from logging into the Developer Portal. The admin takes steps to unblock the user(s); however, the problem repeatedly reoccurs. |
| 2019-04-11 | Handling URLs containing DotDot (..) on DataPower as part of API Connect | Customer requests may contain DotDot (..) in the URL. For example as part of query parameter. By default this is not allowed by DataPower |
| 2019-02-06 | MustGather: Out of Memory errors with IBM API Connect v2018 | This MustGather details how to collect necessary logs for a java/lang/OutOfMemoryError on IBM API Connect v2018. Contact IBM Support if you experience an OutOfMemory exception with IBM API Connect. Use the details in this document to provide all of the relevant information to the Support team. |
| 2019-02-05 | API Connect V2018.x: 404 errors after publishing changes to a catalog which is already deployed | It has been observed under certain circumstances that updating an already published catalog can result in an inability to access any resources within the catalog. |
| 2019-01-25 | Automating APIC Management CLI Operations | How to streamline the process of logging into the CLI of an API Connect Management appliance |
| 2018-12-03 | How to resolve error "client_body_temp" failed (13: Permission denied)" when installing the API Connect 2018 v4.1.x Analytics | Installing the analytics-mtls-gw pod on Openshift version 3.9.x, I get the following log message2018/11/21 12:18:10 [emerg] 1#1: mkdir() "/usr/local/openresty/nginx/client_body_temp" failed (13: Permission denied)nginx: [emerg] mkdir() "/usr/local/openresty/nginx/client_body_temp" failed (13: Permission denied)What is the reason for this error and how do I resolve it? |
| 2018-11-27 | Developer Portal upgrade results in error: "chmod: cannot access '/etc/csync2.key': No such file or directory" | Why is my Developer Portal upgrade failing with the following errors?Updating from system version 7.x-5.0.8.1-20171030-1423 to system version 7.x-5.0.8.3-20180426-2319Checking file perms …chmod: cannot access '/etc/csync2.key': No such file or directoryRe-enabling the crontab for the admin user …Fixpack removing stop_db breadcrumbError occurred in script 5.0.8.3-APIConnect-Portal-Ubuntu16-20180426-2319.bin at line: 1586.Line exited with status: 1See /var/log/devportal/command_line.log for more details.N |
| 2018-11-15 | API Connect: Error while adding gateway server to gateway cluster | When adding a gateway server to a gateway cluster, it goes into "errored" state and the following message can be seen in the API Connect cmc.out log file: GATEWAY ADDITION: Error while adding gateway server to gateway cluster in a background thread. Gateway server ID: <gw server ID>; gateway cluster ID: <gw cluster ID> |
| 2018-10-15 | MustGather: API Manager roles and permissions | User encounters unexpected results based upon their assigned their assigned role(s) and associated permissions |
| 2018-09-11 | How to find the database name and database IP address of the Developer Portal for IBM API Connect | How to find the database name and database IP address of mysql of the Developer Portal tool for IBM API Connect |
| 2018-08-30 | Mustgather for Analytics Issues in v5 API Connect | MustGather information aids in problem determination and saves time resolving CASEs.With this information, API Connect Support can better understand the problem, and save time by analyzing the data. |
| 2018-07-31 | How to disable "Upload picture" in "My account" in Developer Portal for IBM API Connect | You want to disable the "Upload picture" feature in "My account" in Developer Portal for IBM API Connect . |
| 2018-06-15 | Collect MustGather data for IBM API Connect MicroGateway | Gather the following MustGather information for IBM Support to use in troubleshooting problems with the IBM API Connect (APIC) MicroGateway. |
| 2018-06-15 | Collect MustGather data for IBM API Connect Management Server | Gather the following MustGather information for IBM Support to use in troubleshooting problems with IBM API Connect Management Server. |
| 2018-06-15 | Collect MustGather data for IBM API Connect Toolkit | Gather the following MustGather information for IBM Support to use in troubleshooting problems with IBM API Connect Toolkit. |
| 2018-06-15 | Collect MustGather data for IBM API Connect Developer Portal | Gather the following MustGather information for IBM Support to use in troubleshooting problems with IBM API Connect Developer Portal. |
| 2018-06-15 | SNI Support from CMC to DP XML Management | SNI Support from CMC to DP XML Management |
| 2018-06-15 | Error observed when manually updating the ctools module in the IBM API Connect Developer Portal | Error observed when manually updating the ctools module in the IBM API Connect Developer Portal. |
| 2018-06-15 | Upgrade fails between v5010 and v5030 on the developer portal in a cluster | Upgrading the developer portal from v5010 to v5030 is failing on clustered servers. |
| 2018-06-15 | Issues with misconfigured NTP settings in API Management/API Connect | There have been several reports of issues in API Management/API Connect which are related to the time on the servers not being configured correctly. It is advised to check systems to ensure their times are accurate. |
| 2018-06-15 | Supported upgrade paths between product levels of IBM API Connect | What are the supported upgrade paths between the supported versions of IBM API Connect? |
“IBM prides itself on delivering world class software support with highly skilled, customer-focused people. ”
Give Feedback