Known Issues

This article lists the known issues in .
apip42
This article lists the known issues in 
API Developer Portal
.
2
Known Issues Added in Release 4.2.9.3
APIs Link Missing from Navigation Menu (DE390002)
When logging in as an Organization Administrator, the APIs link is missing from the navigation menu. The Organization Administrator has to select Publish to view the APIs page. 
Known Issues Added in Release 4.2.7.5
Docker Version Support Issue (DE375266)
Currently, On Premise Portal supports only Docker CE Version 17.12.
Known Issues Added in Release 4.2.7.4
Unable to View the Analytics Dashboard (DE370582 / DE372412)
After a new installation of Portal 4.2.7.4, when you view the Monitor page in On Premise Portal, the following error message displays: "Unable to fetch analytics data. Please contact Portal Administrator." When you upgrade to 4.2.7.4 from a base installation of 4.2.7.1, the APIM tenant's analytics will be broken. Also, if a user upgrades to 4.2.7.4 and creates a new tenant, the analytics for the APIM tenant and newly added tenant will be broken.  
To work around this issue, follow this procedure to on board tenants to Jarvis manually:
  1. Obtain the Jarvis product ID using this command.
    docker service inspect portal_analytics-server | grep JARVIS_PRODUCT_ID
  2. Copy the
     JARVIS_PRODUCT_ID 
    value for use later.
  3. Obtain the
    uuid
    ,
    tenantId
    and
    portalName
    for each tenant that needs to be on boarded to Jarvis using this command.
    docker exec -it $(docker ps --filter name=portal_analytics-server -q) curl http://tenant-provisioner:9000/tenants
  4. Copy the tenant's
    uuid
    ,
    tenantId
    , and
    portalName
    for use later.
  5. Run the following curl command.
    curl -X POST \ "http://<portal_hostname>:8080/onboarding/tenants"\ -w " Response Code %{http_code}"\ -H 'Content-Type: application/json'\ -d '{"product_id":"<Jarvis Product ID>","tenant_id":"<tenant UUID>","tenant_details":{ "retention_period":365, "tenantName":"<tenant ID>", "portalName":"<portal name>"}}'
    It should return "Response Code 204".
  6. For each tenant that needs on boarding, run the following command to connect to the lddsweb container. 
    docker exec -it $(docker ps --filter name=portal_ldds-web -q) sh
  7. Then run the following curl command.
    curl -X POST \ http://localhost:8080/LDDS-rest/onboarding/product/<Jarvis Product ID>/tenant \ -w " Response Code %{http_code}"\ -H 'Content-Type: application/json'\ -d '{ "tenantCode":"<tenant UUID>", "productAdminRoleName":"PA", "adminRoleName":"TA", "userRoleName":"OA", "ana":"ingress"}'
    It should return "Response Code 200".
Known Issues Added in Release 4.2.7.1
IE 11: Login Interface Error (DE364227)
When a user logs into API Portal, after providing credentials and clicking the Login button, the application would hang and the following back-end Login Component (login.js) error is reported: "Object doesn't support this action". To work around this issue, open another browser tab and go to the tenant URL. The Portal dashboard will be displayed with the user already logged in.
Known Issues Added in Release 4.2.5.4
Searching the API as an Anonymous User Returns an Internal Server Error (DE363144)
When an anonymous user searches the public APIs on the public home page and the load balancer redirects the query to a different tenant hostname, the server returns a 500 error.
API Filtering Does Not Working Properly on Application List Page (DE348565)
Applications in different organizations will not filter if attached to the same API Group.
This issue was corrected in release 4.2.7.
Regular Characters are Called When Calling Special Characters through /api-management/0.1/apis (DE355994)
Making a GET request containing special characters through /api-management/0.1/apis returns APIs with both the special as well as regular characters. 
This issue was corrected in release 4.2.7.
Known Issues Added in Release 4.2.5.2
None.
Known Issues Added in Release 4.2.5.1
Hamburger Icon Not Working when Opening API Portal Anonymously (DE365014)
Hamburger icon does not work when opening API Portal anonymously for the first time. This is due to a suffix in the URL similar to the following example:
.../admin/app/home;jsessionid=node01gkixol6nzh8019w5ek79ucoya48.node0
To work around this issue, choose one the following methods:
  • Click on the API Portal logo to redirect to
    .../admin/app/home
    page. The hamburger icon will work on this page.
  • Log in to the Portal.
APIs are Shown Out of Sync on API Proxy Page (DE357252)
After upgrading to release 4.2.5.1, the following Portal APIs are not pushed to the Ingress Gateway, causing APIs to be shown out of sync on the API Proxy page:
  • Reference Jarvis API (read-only)
  • Reference Portal API (read-only)
  • Reference Portal Metric API (read-only)
  • Reference Portal RBAC API (read-only)
API Attached to Rejected Application Cannot be Deleted (DE355065)
When an application is rejected by admin, the API used by the application can be disabled but cannot be deleted from the APIs list.
This issue was corrected in release 4.2.7.
Registration Still Displayed for Approval when Registration Flow is Disabled (DE356956)
There is a known issue with the registration request workflow whereby users are allowed to register even when the registration workflow is disabled. The request will still be displayed in Request list and admin can approve or reject it.
Non-Functional My Profile Link in User Details Menu (DE355525)
When logged in as admin, the My Profile link in User details menu is not functional. As a workaround, use the My Profile link from the Service icon or from the top menu of Settings.
This issue was corrected in release 4.2.7.
Non-Functional Hamburger Icon on Some Pages with Anonymous Access (DE357300)
The hamburger icon is not working on some of pages available to an anonymous user, such as the API Catalog page or the page displayed after search (/admin/app/search-results).
This issue was corrected in release 4.2.7.
Develop Pages for OrgAdmin Show Global Instead of Custom Settings (DE357312)
All Develop pages available to the OrgAdmin (/dev, /dev/apis, /dev/apps) show the Global settings (global Portal logo, global Portal Name, global favicon) instead of an organization's custom Portal Name, Portal logo, and favicon.
Videos on Home Page Do Not Play (DE357565)
Video links on Home page do not work.
Broken Documentation Link for Generating Reports on Home Page (DE357775)
The documentation link for Generating Reports on the Home page returns a 404 error.
Error when Shifting from Automatic to On-Demand or Scripted Proxy (DE356210)
API deployments created on an automatic proxy cannot be updated or deleted after the proxy is toggled to on-demand or scripted. To work around this issue, once the proxy has been toggled from AUTOMATIC to ON_DEMAND or SCRIPTED, you must modify the APIs associated with this proxy to force a re-deployment. This includes a change to the following API fields: name, status, application URL, proxy URL, custom fields, or policy templates.
Username Validation Failure in Account Setup (DE353373)
The Username field in the Account Setup form wrongly fails a validation if any other validation fails, such as a missing password or not accepting the Terms of Use. When this happens, the user have to refresh the page in order to activate an account.
Menu Error for Admin if Previous User Let Session Expire (DE355051)
Admin user does not see all the tiles and correct menu if the previous user with the Organization Admin role lets the session expire.
Delay in Approving or Rejecting App Request in Large-Scale Deployments (DE355099)
Approving or rejecting an app request may take some time in API Portal with more than 200 users.
Missing API Public Description for Available Private APIs (DE355091)
API Public description is not displayed for available private APIs in Add/Edit Account Plan pages.
Undefined Browser Title for API Details Page (DE355405)
In the API details page, the browser title does not have a corresponding API name and instead displays "undefined".
IE 11: Images on Homepage Not Displaying Properly (DE353855)
With Internet Explorer 11, images on the homepage are not displayed properly for users with Developer and OrgAdmin roles.
IE 11: Creating API Succeeds but Does Not Close Add API Page When Completed (DE355363)
With Internet Explorer 11, clicking on the Create button on the Add API page successfully creates an API but does not close the tab. If the user clicks Create a second time, the error "The request could not be completed due to data input errors" will display, as the API has been created. 
Firefox: Creating API Redirects to API Detail Page (DE355368)
With Firefox, API creation redirects the user to the API Detail Page of the newly created API, instead of the API list page.
Chrome: Favicon Not Updated on Some Pages (DE357310)
With Chrome, if favicon was not previously setup, pages will not show a newly defined favicon. If favicon existed and was updated with the new one, some pages will still show the old favicon, some will not show favicon at all.
Users List is Not Sorted Alphabetically by Name (DE355011)
Users list is sorted by UUID instead of alphabetically by name.
Known Issues Added in Release 4.2.3
Invalid CORS Validation Due to Unencoded Variables when Enrolling Gateway or Incorrect White List of Domains (DE348925, DE362903)
There is a known issue with invalid CORS validation owing to either of these defects:
  • When enrolling Gateway, global policies have improperly escaped variables in payload that prevent CORS origin enforcement.
  • An incorrect white list of domains that are allowed to send requests is causing a 500 error when testing API with OAuth.
To work around this issue:
  1. After enrolling the Gateway, connect the tenant Gateway using the Policy Manager.
  2. Navigate to 
    API Portal Integration > Portal Custom Messages > portal-message-received 
    policy, and import the following policy: portal-message-received.zip
  3. Open the 
    Process CORS Request
     assertion properties and replace the hard-coded origin URLs with your own tenant hostname, for example, http://foo.bar.com or https://foo.bar.com.
  4. Save and activate the policy.
This issue was corrected in release 4.2.7.
IE 11: Swagger File and Use API Buttons Not Positioned Properly (DE347910)
With Internet Explorer 11, Swagger File and Use API buttons on the API View Documentation page are not positioned properly. The Swagger File button is also too large.
This issue was corrected in release 4.2.5.1.
IE 11: Search APIs Do Not Display Properly (DE347893)
With Internet Explorer 11, search APIs text on the Developer Console has only the top half text displayed.
This issue was corrected in release 4.2.5.1.
IE 11: API Creation Redirects to 404 Page (DE347578)
With Internet Explorer 11, creating API succeeds but redirects to 404 page instead of APIs list page.
This issue was corrected in release 4.2.5.1.
Edit and Delete Limitation for Org Admin with CRUD Permissions (DE349744)
Users with Org Admin role and CRUD permissions cannot edit or delete API (edit and delete action links are disabled).
This issue was corrected in release 4.2.5.1.
Caching Issue after Admin Enables or Disables Registration (DE351109)
If registration is disabled, the
Sign In
button will still be displayed for a while after the admin logs out, but is not allowing user to proceed with registration and instead displays a 404 page.
Error when Updating Existing LDAP Authentication Scheme Returns (DE352459)
Updating existing LDAP Authentication Scheme returns a 500 error.
This issue was corrected in release 4.2.5.1.
Known Issues Added in Release 4.2.2.1 Patch
HTTP Error 500 Displayed When Performing Offline Installation Using Customer Signed Certificates (DE348598)
There is a known issue with offline installation using customer signed certificates. Installation completes successfully but displays a HTTP Error 500 page when accessing the default tenant or Portal URL.
This issue was corrected in release 4.2.3.
Known Issues Added in Release 4.2.2
Application Sync Issue Due to Custom Fields (DE346727)
Creating Application with custom fields defined in the system would cause the app sync to stop working.
This issue was corrected in release 4.2.2.1 patch.
Admin Needs Extra Steps to Get to API Groups List (DE341648)
API groups number in APIs list is linked to read-only API Group list. It takes extra steps as an Admin to get to the API groups list.
This issue was corrected in release 4.2.5.1.
Different Number of Applications on Proxy Details Page (DE341324)
Proxy details page displays different numbers of Applications on Portal and Proxy, even when sync is working properly.
Help Button Size in Internet Explorer 11 (DE336098)
With Internet Explorer 11, Help icon size is very large when logged in as any user other than the default Admin. 
This issue was corrected in release 4.2.3.
Known Issues Added in Release 4.2.0.2 Patch
Internal SMTP Service Does Not Work in the Offline Environment (DE340092)
This issue was corrected in release 4.2.2.
Portal User Must Use Sudo When Running portal.sh for example, sudo ./portal.sh (DE340095)
This issue was corrected in release 4.2.2.
Known Issues in Release 4.2
Proxies Menu is Available for API Owner (DE334930)
Proxies menu item, which should not be available for an API Owner role, is displayed and returns an error when clicked.
This issue was corrected in release 4.2.3.
Customize Developer Organizations Page Not Loading (DE340607)
There is an issue when upgrading to 4.2 that prevents the database from being updated. As a result, some pages do not display correctly. For this release, you must manually update the  PORTAL.SETTING and PORTAL.THEME_SETTING tables to ensure the logos and favicons are in the correct format.
See Update the Portal Database for the procedure to manually update the database settings table.
Users with OrgAdmin Customized User Role Cannot Reorder Policy Templates Via Drag-and-drop (DE339772)
When editing or creating an API on the Proxy Configuration tab, orgadmin users are unable to reorder policy templates by drag-and-drop.
This issue was corrected in release 4.2.2.
API Explorer Consumes and Produces JSON Content Type Only (DE226341)
Removal of Ingress Network
To remove Ingress network in Docker, you must forcibly remove it. If removed by accident, you can recreate it by issuing the following command on the master node:
docker network create --ingress --driver overlay ingress
/var Partition Size is Too Small
The /var partition on the server can fill up the log space quickly if the partitiion size is too small. For example, a 7.5 GB partition is too small and fills up the log space.
A full partition can result in unpredictable behavior. For example, 
API Portal
 fails to start silently.
Adding
 set -x
 to the appropriate startup files indicates that the firewall settings cannot be applied to the the /var partition since the log is full.
Another potential symptom is that Docker crashes and certain commands stop working or give error messages. For example, 
util/retrieve-logs.sh
 fails or the docker stack services portal command fails because docker has crashed.
Docker Out of Date Kernel
Docker has an outstanding bug since 2014, https://github.com/moby/moby/issues/5618
The bug manifests with the following message:
Message from [email protected] at Nov 15 17:09:21 ... kernel:unregister_netdevice: waiting for lo to become free. Usage count = 1
To resolve, run a yum update and ensure that the Linux kernel gets updated and rebooted using the following command:
sudo yum -y update && sudo reboot
vm.max_map_count is Too Low
The default
vm.max_map_count
setting of 65530 in CentOS is too low for Elasticsearch. See https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html for more information.
This issue manifests as several services (usually 3) not starting.
Screen capture of services not starting
To confirm, list all services using the following command:
sysctl vm.max_map_count
If you see the following example output (a few services with 0/1 replicas), check the vm.max_map_count.
Screen capture of example output
If the count is less than 262144, update the count using the following commands:
echo 'vm.max_map_count=262144' > /etc/sysctl.d/vm.conf sysctl -p /etc/sysctl.d/vm.conf
API Search Starts Before You Click Enter (DE332673)
When you enter all or part of an API name in the API search bar, the search begins before you click enter. 
This issue was corrected in release 4.2.2.
Incorrect Help text in Create/Edit API Form (DE333192)
The Help text in the Create or Edit API form incorrectly states that a comma (,) is a valid delimiter between the API name and version.
Supported delimiters include the following: 
  • underscore (_)
  • hyphen ( -)
  • period (.)
This issue was corrected in release 4.2.5.1.
Default CSS Includes Incorrect Values (DE333157)
The default CSS theme includes incorrect values for the following UI elements:
  • Page title font size
  • Button font size 
  • Background color 
APIs on the API Catalog page are Not Sorted Alphabetically (DE330608)
This issue was corrected in release 4.2.2.
Application Configuration Does Not Accept Internationalized Strings (DE333481)
This issue was corrected in release 4.2.2.
API Tile Does Not Align Correctly in API Search Results (DE333464)
In some cases, API tiles are misaligned if the APIs page was displayed as part of the search workflow and the search returns no results. 
This issue was corrected in release 4.2.3.
Internet Explorer 11 is Not Supported (DE333368)
When accessing 
API Developer Portal
 as any role other than Admin, display issues occur. 
To prevent these issues, use one of the following supported browsers:
  • Mozilla Firefox 50 or later
  • Google Chrome 55 or later
This issue was corrected in release 4.2.2.
Users Are Not Automatically Redirected to a Login Page When Their Session Times Out (DE333417)
In this case, users are allowed to complete the form they are working on, but the information is not saved.
When users try to submit the form, they are redirected to the Login page. 
Application Counts For an API on an API List Page May be Incorrect for Users with the Developer Role (DE333480)
Empty validation error when organization logo image size is greater than allowed (DE333197)
This issue was corrected in release 4.2.3.
Duplicate Analytics seen on monitor page after restart (DE333445)
This issue was corrected in release 4.2.2.
When viewing the Analytics page, the API Portal calls ' https://google-code-prettify.googlecode.com/svn/loader/prettify.css' (DE249112)
[APN-177] Errors for the usb_serial_init and usr/bin/setfont are reported when booting up the VM (DE226628 )
Login locked message was not displayed after multiple invalid attempts (DE332683)
[CA SSO Integration]: Portal APIs are not listed for T1 tenants (DE333373)
Known Issues in Release 4.1
  • After integrating a tenant API Gateway with the 
    API Portal
    , the administrator cannot log in through the API Portal. To work around this issue, define the variables DEFAULT_ADMIN_USERNAME and DEFAULT_ADMIN_PASSWORD in the '/opt/ca/apim-portal/config/env-tenant-provisioner’ file. Then restart the apim-portal service. (DE302853)
    This issue was corrected in release 4.2.
  • When an 
    API Portal
     administrator logs in, the 
    API Portal
     might incorrectly ask them to accept the 
    API Portal
     4.1 EULA, even though an 
    API Portal
     administrator accepted it before. (DE301488)
  • When the 
    API Portal
     receives a GET ALL request, it incorrectly returns null for ApiLocationUrl and SsgName. (DE300543)
  • In the Add or API wizard, if you change the authentication type and then you add a policy template, the 
    API Portal
     incorrectly disables the Save button. (DE300390)
  • With Internet Explorer 11, when you use the API Explorer to access the Portal API, the API Explorer fails to access the OAuth token endpoint. To work around this issue, use another browser, or use another client, such as cURL or Postman. (DE296687)
  • If the 
    API Portal
     loses its database connection, it incorrectly creates empty folders in the /root directory. It labels these folders "start-portal.xxxxxx". (DE294250)
    This issue was corrected in release 4.2.
  • Due to a Cloud-init bug, the Cloud-init payload fails to configure Rsyslog. However, administrators can use other methods and tools to configure Rsyslog. (DE274875)
  • The value of the portal.config.pssg.host cluster property is still configured with the hostname "pssg" in the enrolled Tenant API Gateway. (DE269476)
  • The Analytics screen might appear blank when scrolling in Internet Explorer 11. (DE269083)
  • The Analytics Get Started widget on the Dashboard appears inconsistently to organization administrators and developers. (DE268867)
  • If a Gateway-published API has a double-byte character in the name, each time the API is synchronized the name is extended until all APIs fail to synchronize. (DE268849)
  • If the time on the 
    API Portal
     and tenant Gateway is not synchronized, 
    API Portal
     administrators might be unable to enroll an external tenant Gateway. (DE268541)
  • If the context variable in the portalAuth policy is not set to ‘${from}’, email is received from [email protected]. (DE268172)
    This issue was corrected in release 4.2.
  • APIs with names longer than 245 characters cannot be synchronized with the tenant Gateway. (DE267506)
  • (BYO CMS) When an 
    API Portal
     administrator is logged in to Drupal and they click Portal API on the navigation bar, the login page for the internal APIM Gateway incorrectly appears. To work around this issue, the administrator can click on another item on the navigation bar and then click Portal API again. (DE265520)
  • (BYO CMS) When the default 
    API Portal
     administrator logs in to Drupal, the anonymous user navigation menu appears. (DE258078)
  • When viewing the Analytics page, the 
    API Portal
     calls '
    https://google-code-prettify.googlecode.com/svn/loader/prettify.css
    '. (DE249112)
  • When an 
    API Portal
     administrator enables third-party registration and then they log out, when they log in again, the navigation bar fails to display the Register command. To work around this issue, press Ctrl+F5 to clear the cache and refresh the page. (DE245359)
    This issue was corrected in release 4.2.2.
  • When booting up the VM, errors for the usb_serial_init and usr/bin/setfont might be reported. (DE226628)
Known Issues Added in Release 4.0.170601 Patch
  • The Analytics screen might appear blank when scrolling in IE11. (DE269083)
  • The Analytics Get Started widget on the Dashboard appears inconsistently to organization administrators and developers. (DE268867)
  • When booting up the VM, errors for the usb_serial_init and usr/bin/setfont might be reported. (DE226628)
  • Due to a Cloud-init bug, the Cloud-init payload fails to configure Rsyslog. However, administrators can use other methods and tools to configure Rsyslog. (DE274875)
  • If the context variable in the portalAuth policy is not set to ‘${from}’, email is received from [email protected]. (DE268172)
  • The value of the portal.config.pssg.host cluster property is still configured with the hostname "pssg" in the enrolled Tenant API Gateway. (DE269476)
  • If the time on the API Portal and tenant Gateway is not synchronized, Portal administrators might be unable to enroll an external tenant Gateway. (DE268541)
  • APIs with names longer than 245 characters cannot be synchronized with the tenant Gateway. (DE267506)
  • If a Gateway-published API has a double-byte character in the name, each time the API is synchronized the name is extended until all APIs fail to synchronize. (DE268849)
  • (BYO CMS) When the default Portal administrator logs in to Drupal, the anonymous user navigation menu appears. (DE258078)
  • (BYO CMS) When a Portal administrator is logged in to Drupal and they click Portal API on the navigation bar, the login page for the internal APIM Gateway incorrectly appears. To work around this issue, the administrator can click on another item on the navigation bar and then click Portal API again. (DE265520)
  • When a Portal administrator enables third-party registration and then they log out, when they log in again, the navigation bar fails to display the Register command. To work around this issue, press Ctrl+F5 to clear the cache and refresh the page. (DE245359)
Known Issues in Release 4.0
  • The Analytics screen might appear blank when scrolling in IE11. (DE269083)
  • When booting up the VM, errors for the usb_serial_init and usr/bin/setfont might be reported. (DE226628)
  • Email will be received from [email protected] if the context variable in the portalAuth policy is not set to ‘${from}’. (DE268172)
  • The Analytics Get Started widget on the Dashboard appears inconsistently to organization administrators and developers. (DE268867)
  • The value of the portal.config.pssg.host cluster property is still configured with the hostname "pssg" in the enrolled Tenant API Gateway. (DE269476)
  • (BYO CMS) When the default Portal administrator logs in to Drupal, the anonymous user navigation menu appears. (DE258078)
  • (BYO CMS) When a Portal administrator is logged in to Drupal and they click Portal API on the navigation bar, the login page for the internal APIM Gateway incorrectly appears. To work around this issue, the administrator can click on another item on the navigation bar and then click Portal API again. (DE265520)
  • Administrators might not be able to enroll an external tenant Gateway if the time on the API Portal and tenant Gateway is not synchronized. (DE268541)
  • When a Portal administrator enables third-party registration in the settings and then they log out, when they log in again, the navigation bar fails to display the Register command. To work around this issue press Ctl+F5 to clear the cache and refresh the page. (DE245359)
  • APIs with names longer than 245 characters cannot be synchronized with the tenant Gateway. (DE267506)
  • When a Gateway-published API is given a double-byte character in the name, each time the API is synchronized with the Portal, the service name is extended until eventually all APIs fail to synchronize. (DE268849)
  • API Portal EE fails to start after its expired license is replaced with an active license. (DE274528)
  • Due to a cloud-init bug, the cloud-init payload fails to configure Rsyslog. However, administrators can use other methods and tools to configure Rsyslog. (DE274875)