API Connect

https://www.ibm.com/docs/en/api-connect/software/12.1.1
Admin
This documentation provides comprehensive information and guides for configuring, managing, and...
Tokens:1,251,451
Snippets:18,295
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Restore Command and Output

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=burms-restoring-from-management-database-backup

This example demonstrates a full restore command with specific parameters and shows the initial output indicating the restore process has started. It also includes sample output from `k get mgmtr` showing the status of the restore job.

```bash
apicup subsys restore boaz-ova2-management --id 20230725T162548 --host s3.eu-gb.cloud-object-storage.appdomain.cloud/eu-gb --username 'a05e7aace2ab43b5941326429c8c071c' --password '3e510a1d9b06189b57334d064badf6abc39ab5a51d9bdcf7' --path upgrade-test/boaz-ova1-management-22/management-site1-db-2023-11-16T12:30:02Z

Starting restore...
INFO[0000] Creating generic secret mgmt-restore-auth-secret.
please check later for completion status of restore
ManagementRestore is RestoreInProgress
root@apicdev3067:/home/apicadm/boaz-ova2# k get mgmtr
NAME                 STATUS              MESSAGE                                                                                          BACKUP              CLUSTER                PITR                  AGE
NAME                 STATUS     MESSAGE                                            BACKUP              CLUSTER                PITR                  AGE
mgmt-restore-t6ss5   Complete   Restore process completed (DB Restore + DRR job)   mgmt-backup-cdkv6   boaz-ova2-management   2023-07-25T16:25:58   127m
mgmt-restore-tgxl2   Complete   Restore process completed (DB Restore + DRR job)                       boaz-ova2-management
```

--------------------------------

### Get help for installation script

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vms-installing-target-system-kubernetes-cloud-pak-integration-open-shift

View all available optional flags for the installation script to customize the deployment.

```bash
install_apic_using_individual_crs.py --help
```

--------------------------------

### Example Output of Installed Themes

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=syaucp-how-find-your-custom-modules-themes-your-cms-portal

This example shows the output format for the `themes:list` command, detailing the status (Enabled/Disabled) and package information for each installed theme, including custom ones.

```bash
❯ SERVER=myserver.ibm.com
❯ apic -s $SERVER -m portaladmin themes:list -o ibm -c api-connect-catalog-1 --no-core
bootstrap:
  package: Bootstrap
  display_name: 'Bootstrap (bootstrap)'
  status: Enabled
  version: 8.x-3.27
.
.
.
emerald_theme_css:
  package: Bootstrap
  display_name: 'emerald_theme_css (emerald_theme_css)'
  status: Disabled
  version: null
ruby_theme_scss:
  package: Bootstrap
  display_name: 'ruby_theme_scss (ruby_theme_scss)'
  status: Disabled
  version: null
sapphire_theme_css:
  package: Bootstrap
  display_name: 'sapphire_theme_css (sapphire_theme_css)'
  status: Disabled
  version: null
```

--------------------------------

### Developer Portal Installation Complete Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=openshift-installing-developer-portal-subsystem-in-different-namespaces

The installation is complete when the `READY` column shows all pods running (e.g., `5/5`), and the `STATUS` is `Running`.

```text
NAME      READY      STATUS            VERSION             RECONCILED VERSION               MESSAGE            AGE
devportal     5/5      Running             12.1.0.0             12.1.0.0.-0              Dev Portal is ready     7m39s 

```

--------------------------------

### Portal Subsystem Status Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=openshift-installing-cms-portal-subsystem-in-shared-namespace

Example output showing a successfully installed portal subsystem with STATUS 'Running' and all services online.

```text
NAME           READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE                               AGE
portal         3/3     Running   <version>  <version>            Ready for API Cloud Manager service registration   2h
```

--------------------------------

### Example Output of APIC Get

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=kubernetes-upgrading-datapower-nano-gateway-subsystem

Example output showing a successful Nano Gateway subsystem upgrade.

```text
NAME                                                    READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE                   AGE
nanogatewaycluster.nanogateway.apiconnect.ibm.com/ngw   7/7     Running   12.1.0.2   12.1.0.2-1573        Services are ready: 7/7   126m
```

--------------------------------

### Example API Call for Resource Information

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-example-managing-api

This example shows how a client would make an HTTP GET request to retrieve specific resource information for a product.

```HTTP
http://www.phonestore.com/phones/412456/features
```

--------------------------------

### Generate Dockerfile with Parameters

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=support-generating-docker-image-from-installation

Example of running the generateDockerfile script with specific parameters for the OS image and installation path.

```bash
sudo sh generateDockerfile --os.image ubuntu:20.04 
--installation.path fs/fslocal/Portal1015
```

--------------------------------

### Example GET Request to Authentication URL

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=overview-configuring-authentication-url-user-registry

This is an example of an HTTP GET request made by API Connect to an Authentication URL identity provider. It includes basic authentication credentials.

```http
GET /user/authenticate HTTP/1.1
 Host: myauthurl.example.com
 Authorization: Basic c3Bvb246Zm9yaw=

```

--------------------------------

### Example: Deploying and Testing Project1 Locally

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=studio-testing-projects

This example demonstrates how to deploy and test a specific project named 'Project1' located in a local directory to a target API Gateway. It includes placeholder credentials and target information.

```bash
apic test Project1 --localDir  C:/Users/user1/Desktop/apistudio_localdir  
--target "http://host:port" 
--username "******" --password "******" --deploy
```

--------------------------------

### Example: Build Single Project with Output Path

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=studio-building-projects

Demonstrates building a single project named 'Project1' from a specified local directory and saving the output to a designated build path.

```bash
apic build Project1 --localDir /Users/user1/Desktop/apistudio_localdir 
--output ./builds/project_build.zip
```

--------------------------------

### Example Gateway Status Output

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=openshift-installing-webmethods-api-gateway-in-shared-namespace

An example of the expected output when verifying the gateway installation status.

```text
NAME           READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE                   AGE
wmapigateway   4/4     Running   12.1.0.0   12.1.0.0-1           WM API Gateway is ready   15m
```

--------------------------------

### Example Analytics Cluster Status

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=openshift-installing-analytics-subsystem

An example of the expected output when the analytics subsystem is fully installed and running.

```text
NAME        READY   STATUS    VERSION          RECONCILED VERSION   AGE
analytics   n/n     Running   12.1.0.0   12.1.0.0-1281    86m
```

--------------------------------

### View help for the 'deploy' command

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=studio-getting-help

This example shows how to specifically retrieve help information for the 'apic deploy' command. It demonstrates the practical application of the general help syntax.

```bash
apic help deploy
```

--------------------------------

### Create APIs, Product, and Publish

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tool-publishing-apis-applications

This snippet demonstrates the complete workflow of creating APIs, composing them into an API Product, configuring the catalog, logging in, and finally publishing the API Product.

```bash
apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"
apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic login --username some-user --password some-password --server platform-api.myserver.com --realm provider/default-idp-2
apic products publish climb-on.yaml
```

--------------------------------

### Example Docker Registry Hostname

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=subsystems-installing-datapower-nano-gateway-subsystem-kubernetes

Specifies the hostname of the Docker Registry where installation images are uploaded. Example: cp.icr.io/cp/apic.

```text
cp.icr.io/cp/apic
```

--------------------------------

### Example Gateway Cluster Status Output

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=openshift-installing-datapower-api-gateway-subsystem

This is an example of the expected output when the gateway cluster is successfully installed and all services are online.

```text
NAME   READY   SUMMARY   VERSION    RECONCILED VERSION   AGE
gwv6   True    2/2       <version>  <version-build>      7m32s
```

--------------------------------

### Example: Configure Analytics Backups

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=subsystem-configuring-federated-api-management-database-backups

This example demonstrates setting analytics backups to enabled, using SFTP protocol, specifying a host and path, and setting a daily backup schedule.

```bash
apicup subsys set fam1 analytics-backup-enabled=true
apicup subsys set fam1 analytics-backup-protocol=sftp
apicup subsys set fam1 analytics-backup-host=backup.example.com
apicup subsys set fam1 analytics-backup-path=/backups/fam1
apicup subsys set fam1 analytics-backup-schedule="0 2 * * *"
```

--------------------------------

### Example GET Request with Basic Auth Header

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=connect-oauth-introspection-third-party-oauth-providers

Shows a GET request where the `x-introspect-basic-authorization-header` is used to provide credentials for the introspection endpoint.

```http
GET /petstore/pet/123 HTTP/1.1
Host: apiconnect.com
x-introspect-basic-authorization-header: user:password
```

--------------------------------

### Sample SSL Configuration with File Paths

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=configuration-securing-developer-portal-webmethods-api-gateway-communication

This sample demonstrates the configuration with specific file paths for the keystore and truststore, and example passwords. Ensure the truststore includes details of target component certificates.

```properties
wrapper.java.additional.2200=-Dportal.datastore.uris=http://opensearch:9200
wrapper.java.additional.2201=-Djavax.net.ssl.apigateway.keyStore=C:\\Installer\\DeveloperPortal\\configuration\\client-keystore.jks
wrapper.java.additional.2202=-Djavax.net.ssl.apigateway.keyStorePassword=changeit
wrapper.java.additional.2203=-Djavax.net.ssl.apigateway.trustStore=C:\\Installer\\DeveloperPortal\\configuration\\client-truststore.jks
wrapper.java.additional.2204=-Djavax.net.ssl.apigateway.trustStorePassword=changeit
```

--------------------------------

### Retrieve Setup Intent

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=apis-payment-gateway

Retrieves the setup intent code for initializing UI to get card details in STRIPE payment gateway.

```APIDOC
## GET /paymentgateway/user/signature

### Description
Retrieves the setup intent code that can be used to initialize UI to get card details in STRIPE payment gateway.

### Method
GET

### Endpoint
/paymentgateway/user/signature

### Request Example
```
curl --location --request GET 'developer_portal_rest_base/paymentgateway/user/signature' \
--header 'Accept: text/plain'
```
```

--------------------------------

### Example: Verify helper_files.zip

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=files-verifying-integrity-product

This example demonstrates how to verify the helper_files.zip file. The signature file must be in the same folder.

```bash
gpg --verify helper_files.zip.asc
```

--------------------------------

### Example Network Interface Creation

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-preparing-management-subsystem-deployment

An example of creating a network interface for a subsystem VM.

```bash
apicup iface create <subsystem name> <myHostname.domain> eth0 192.0.2.10/255.255.255.0 192.0.2.1
```

--------------------------------

### Example of logging in to the Developer Portal

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=ucp-logging-in-as-consumer-cms-portal-by-using-cli

An example of a successful login command to the Developer Portal.

```bash
apic login --mode consumer --server consumer.9a6e-88fa49bc.eu-gb.apiconnect.cloud.ibm.com -u my_username -p Blue123 -r consumer:frankenstein:om-portal/portal-idp

Logged into consumer.9a6e-88fb51bc.eu-gb.apiconnect.cloud.ibm.com successfully
```

--------------------------------

### GET Request for Universities by Course and Postal Code

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=implementation-api-mashups

This is an example of a GET request to retrieve university information based on course name and postal code.

```http
GET /universities?course=medicine&postalcode=600012
```

--------------------------------

### Example Ingress for Analytics Endpoint (Kubernetes)

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=topology-registering-analytics-service

This is an example of the output from the 'kubectl get ingress' command, illustrating the structure of an analytics ingestion endpoint for Kubernetes.

```text
NAME                     CLASS   HOSTS                        ADDRESS   PORTS     AGE
def-analytics-ai-endpoint   nginx   a7s-in.example.com                     80, 443   87d
```

--------------------------------

### Example Connection Command

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=settings-setting-trust-self-signed-certificates

An example of the `openssl s_client` command, demonstrating how to connect to a URL and display certificates. Replace `<URL>` with the target address.

```bash
openssl s_client -connect <URL> -showcerts
```

--------------------------------

### User Registry Settings Output Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=manager-using-cli-configure-shared-ldap-user-registry

This is an example of the output from the `apic user-registry-settings:get` command, showing the structure of current user registry configurations.

```yaml
type: user_registry_setting
api_version: 2.0.0
name: user-registry-setting
admin_user_registry_default_url: >-
  https://server.com/api/user-registries/xxxxx/xxxxx-1234
admin_user_registry_urls:
  - >-
    https://server.com/api/user-registries/xxxxx/xxxxx-1234
provider_user_registry_default_url: >-
  https://https://server.com/api/user-registries/xxxxx/xxxxx-5678
provider_user_registry_urls:
  - >-
    https://https://server.com/api/user-registries/xxxxx/xxxxx-5678
created_at: '2019-09-30T12:22:19.467Z'
updated_at: '2019-10-17T10:05:37.867Z'
url: 'https://server.com/api/cloud/settings/user-registries'
```

--------------------------------

### Sample Plan Configuration

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=plans-creating-api-products-in-code-view

A comprehensive example of a Plan configuration, demonstrating settings for webm-gateway, dp-nano-gateway, and dp-gateway.

```yaml
kind: Plan
apiVersion: api.ibm.com/v1
metadata:
  name: GoldPlan
  namespace: sample-namespace
  version: "1.0"
  tags: []
  description: "Sample plan"
spec:
  qos:
    withQuota:
      plan-limit:
        - $ref: sample-namespace:QuotaPerMinute:1.0
  extensions:
    webm-gateway:
      apiVersion: api.ibm.com/v1
      spec:
        pricing:
          value: 10
          currency: usd
        withRateLimit:
          - maxRequest: 100
            interval: 1h
            alertMessage: "Limit reached"
            alertFrequency: once
            name: "rateLimit1"
    dp-nano-gateway:
      apiVersion: api.ibm.com/v1
      spec:
        isApprovalRequired: true
        apis:
          - $ref: sample-namespace:SampleAPI:1.0
            operations:
              - path: "/sample"
                method: GET
              - path: "/sample"
                method: POST
                withQuota:
                  plan-limit:
                    - $ref: sample-namespace:QuotaPerHour:1.0
        withAssemblyCountLimit:
          dailyQuota:
            - $ref: sample-namespace:DailyCount:1.0
        properties:
          sampleProperty: "sampleValue"
        telemetry:
          metricKey: "metricValue"
    dp-gateway:
      apiVersion: api.ibm.com/v1
      spec:
        isApprovalRequired: true
        withRateLimit:
          - maxRequest: 100
            interval: 1h
            name: "burstLimit1"
        withAssemblyCountLimit:
          - name: SampleCountLimit
            maxRequest: 10
            hard-limit: true
        withAssemblyRateLimit:
          - name: SampleRateLimit
            maxRequest: 100
            interval: 1h
        withAssemblyQuotaLimit:
          - name: SampleQuotaLimit
            maxRequest: 100
            interval: 1h
        apis:
          - $ref: sample-namespace:SampleAPI:1.0
            operations:
              - path: "/sample"
                method: GET
              - path: "/sample"
                method: POST
                withQuota:
                  plan-limit:
                    - $ref: sample-namespace:SamplePlanQuota:1.0

```

--------------------------------

### Example Command with Server Option

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tool-overview-command-line

An example of publishing an application using the `apic` command with a specific server option.

```bash
apic apps:publish --server mgmnthost.com
```

--------------------------------

### GET Request for Postal Code by Latitude and Longitude

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=implementation-api-mashups

This is an example of a GET request to a public API that returns a postal code based on latitude and longitude coordinates.

```http
GET /postalcode?lat=331&long=22324321
```

--------------------------------

### Example Cloud-Init Static Routes

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-adding-static-route-virtual-machine

This example demonstrates how to add multiple static routes to a cloud-init file for different destination networks.

```yaml
bootcmd:
 - ip route add 172.27.218.0/24 via 172.27.218.1 dev eth1
 - ip route add 172.26.203.0/24 via 172.27.218.1 dev eth1
```

--------------------------------

### Install Common Issuers in Namespaces

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=docm-deploying-operators-in-multi-namespace-api-connect-cluster

Create the common-issuer configuration in all relevant namespaces where API Connect subsystems will be installed. Examples include 'mgmt', 'gtw', 'ptl', and 'a7s'.

```bash
kubectl create -f common-issuer.yaml -n mgmt
```

```bash
kubectl create -f common-issuer.yaml -n gtw
```

```bash
kubectl create -f common-issuer.yaml -n ptl
```

```bash
kubectl create -f common-issuer.yaml -n a7s
```

--------------------------------

### Install Portal Subsystem

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-configuring-api-connect-subsystems-in-cluster

Creates an ISO file in a specified plan folder for installing the portal subsystem. If multiple nodes are listed, an ISO is created for each node.

```bash
apicup subsys install port --out portplan-out
```

--------------------------------

### Example GET Request with Custom Headers

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=connect-oauth-introspection-third-party-oauth-providers

Demonstrates a GET request to an API protected by API Connect, including custom headers that can be passed to a third-party introspection endpoint.

```http
     GET /petstore/pet/123 HTTP/1.1
     Host: apiconnect.com
     x-Introspect-type: dog
     x-Introspect-name: simon
     x-custom-apic: petstore123
     Authorization: Bearer tGzv3JOkF0XG5Qx2TlKWIA
     x-IBM-Client-Id: xxx-xxx
```

--------------------------------

### Execute Valkey Setup Script

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=opidngs-deploying-valkey-operator-operand-datapower-nano-gateway

Runs the setup script for Valkey with specified application and TLS secret names.

```sh
sh setup-valkey-self-signed-tls.sh apic valkey-tls
```

--------------------------------

### Simple condition for HTTP GET method

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=switch-using-policy-condition-editor

This snippet uses the $httpVerb() extension to check if the request's HTTP method is GET. This is a basic example of a single function condition.

```JSONata
$httpVerb()="GET"
```

--------------------------------

### S3 Bucket Path Examples

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=portal-configuring-database-backups

Examples of valid path configurations for S3 buckets.

```text
bucket
bucket/path
bucket/lots/of/paths
```

--------------------------------

### GRUB Boot Screen Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=troubleshooting-running-filesystem-check-vmware-root-partition

This is an example of the GRUB boot screen that appears during the appliance boot process.

```text
GNU GRUB v2.02
.
.
- Ubuntu
- Advanced options for Ubuntu
.
.
.
Press Enter to boot the selected OS, 'e' to edit the commands 
before booting or 'c' for a command-line

```

--------------------------------

### Get MCP server details

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tools-mcp-server-client

Retrieve detailed configuration information for a specific MCP server. Use this to get in-depth data about a particular MCP server's setup.

```APIDOC
## Get MCP server details

### Description
Retrieve detailed configuration information for a specific MCP server.

### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the MCP server to check for existence
```

--------------------------------

### VMware Management Endpoint Configuration

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=topology-registering-cms-portal-service

If configured during installation in a VMware environment, the management endpoint is set using the `apicup` command. Consult the installation guide for detailed `apicup` usage.

```text
apicup subsys set portal portal-admin value
```

--------------------------------

### Create Product Definition File with CLI Arguments

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-creating-product-definition-file

Use this command to create a Product definition file with specified arguments. Ensure all API filenames are correctly listed.

```bash
apic create:product --name product_name --title product_title --filename product_file_name.yaml
--apis "filename_of_api1.yaml filename_of_api2.yaml"
```

--------------------------------

### API Gateway Subsystem Status Output Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-verifying-webmethods-api-gateway-subsystem-installation

This is an example of the expected output from the 'apic status' command after a successful installation. It details the cluster status, component health, and resource utilization.

```text
INFO[0000] Log level: infoCluster members:
- apimdev0170.hursley.ibm.com (9.20.152.170)
  Version: 6.0.1
  Type: BOOTSTRAP_MASTER
  Install stage: DONE
  Upgrade stage: UPGRADE_DONE
  Spec Version: 12.1.1.0
  Reconciled Version: 12.1.1.0
  CR Status: Running
  CR Message: WM API Gateway is ready
  CR Condition Message: 5/5
  CR Condition Reason: DeploymentReady
  Subsystem type: wmapigateway
  Subsystem version: 12.1.1.0
  Subsystem detail:
  NTP Status: systemd-timesyncd.service[active] (NTP: Contacted time server 9.20.60.77:123 (ntp.hursley.ibm.com).)
  System Clock Synchronized: yes
  CPU/Memory: 701m/8083Mi
  Reboot Required: false
  Containerd status:
    Systemd unit: running
  Kubernetes status:
    Systemd unit: running
    Kubelet version: apimdev0170 (6.8.0-124-generic) [Kubelet v1.36.0, Proxy ]
  Etcd status: pod etcd-apimdev0170 in namespace kube-system has status Running
  Addons: calico, cert-manager, dns, kube-proxy, local-volume-provisioner, metrics-server,
  Disk Space Available: 225G/245G | Used: 4%
  Inodes Available: 16M/16M | Used: 1%
  Containers: 21
    - Running: 21
    - Exited: 8
    - Unknown: 0
  Images: 33
Etcd cluster state:
- etcd member name: apimdev0170.hursley.ibm.com, member id: 9285426960754707779, cluster id: 10284957680184747311, leader id: 9285426960754707779, revision: 16134, version: 3.6.8Pods Summary:
NODE               NAMESPACE           NAME                                                   READY        STATUS           REASON
apimdev0170        cert-manager        cert-manager-654597cb4f-rxf8q                          1/1          Running
apimdev0170        cert-manager        cert-manager-cainjector-6758cc7fd8-82kzp               1/1          Running
apimdev0170        cert-manager        cert-manager-webhook-56df98bf5-kjb8m                   1/1          Running
apimdev0170        default             ibm-apiconnect-7d7fcdc496-s2wlh                        1/1          Running
apimdev0170        default             wmapig-2920f9d1-apigateway-0                           1/1          Running
apimdev0170        default             wmapig-2920f9d1-opensearch-0                           1/1          Running
apimdev0170        default             wmapig-2920f9d1-proxy-744b7f4c45-qdrjs                 2/2          Running
apimdev0170        default             wmapig-2920f9d1-system-check-29685445-6x44d            0/1          Succeeded
apimdev0170        kube-system         calico-kube-controllers-75499c66-xv582                 1/1          Running
apimdev0170        kube-system         calico-node-d7jb6                                      1/1          Running
apimdev0170        kube-system         coredns-5bff59f57-j862g                                1/1          Running
apimdev0170        kube-system         coredns-5bff59f57-kp7tx                                1/1          Running
apimdev0170        kube-system         etcd-apimdev0170                                       1/1          Running
apimdev0170        kube-system         ingress-nginx-ingress-controller-mqvbq                 1/1          Running
apimdev0170        kube-system         kube-apiserver-apimdev0170                             1/1          Running
apimdev0170        kube-system         kube-apiserver-proxy-apimdev0170                       1/1          Running
apimdev0170        kube-system         kube-controller-manager-apimdev0170                    1/1          Running
apimdev0170        kube-system         kube-proxy-wqt77                                       1/1          Running
apimdev0170        kube-system         kube-scheduler-apimdev0170                             1/1          Running
apimdev0170        kube-system         local-volume-provisioner-9dc8q                         1/1          Running
apimdev0170        kube-system         metrics-server-779b7748bd-6r7qs                        1/1          Running
```

--------------------------------

### Sample Developer Portal Configuration with Specific Paths

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=configuration-securing-developer-portal-federated-api-management-communication

This sample shows the custom_wrapper.conf entries with specific file paths and passwords for keystore and truststore, enabling two-way SSL for Developer Portal communication.

```properties
wrapper.java.additional.2200=-Dportal.datastore.uris=http://datastore-cp:9200
wrapper.java.additional.2201=-Djavax.net.ssl.controlplane.keyStore=C:\\Installer\\DeveloperPortal\\configuration\\client-keystore.jks
wrapper.java.additional.2202=-Djavax.net.ssl.controlplane.keyStorePassword=changeit
wrapper.java.additional.2203=-Djavax.net.ssl.controlplane.trustStore=C:\\Installer\\DeveloperPortal\\configuration\\client-truststore.jks
wrapper.java.additional.2204=-Djavax.net.ssl.controlplane.trustStorePassword=changeit
wrapper.java.additional.2205=-Djavax.net.ssl.controlplane.trustStoreType=JKS
wrapper.java.additional.2206=-Djavax.net.ssl.controlplane.keyStoreType=JKS
wrapper.java.additional.2207=-Djavax.net.ssl.controlplane.keyAlias=client
wrapper.java.additional.2208=-Djavax.net.ssl.controlplane.keyPassword=changeit
```

--------------------------------

### Install API Discovery Service Settings

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=subsystem-enabling-api-discovery-vmware

Apply the new API discovery service settings by running this command. The `--debug` option provides verbose output.

```bash
apicup subsys install <mgmt_subsystem_name> --debug
```

--------------------------------

### Example: Unhealthy Management Subsystem Output

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=acms-configuring-maximum-size-client-requests-management-subsystem-vmware

This is an example of the output you might see from `apicup subsys health-check` if the management subsystem is not yet healthy during installation, indicating pending phases and states.

```text
Error: Cluster not in good health:
 ManagementCluster (current ha mode: active) is not ready | State: 15/17 Phase: Pending
 ManagementCluster (current ha mode: active) is not ready | State: 15/17 Phase: Pending
```

--------------------------------

### Sample GET Request to Revocation URL

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tokens-oauth-revocation-url

This example shows a sample GET request that an API Gateway server would issue to a revocation URL. It includes necessary headers for the request.

```http
<?xml version="1.0" encoding="UTF-8"?>
GET <revocationURL> HTTP/1.1
User-Agent: IBM-APIManagement/4.0
Accept: application/xml; text/xml


```

--------------------------------

### Get Help for apic create:product Command

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-creating-product-definition-file

Run this command to view detailed information and available options for the `apic create:product` command.

```bash
apic create:product --help
```

--------------------------------

### Example Output for ManagementCluster CR

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=environment-custom-resources-custom-resource-definitions

This is an example output of the `kubectl get apic` command, specifically showing the details for a ManagementCluster Custom Resource. It includes readiness, status, version, and age.

```text
NAME                                                        READY   STATUS    VERSION    RECONCILED VERSION   AGE
managementcluster.management.apiconnect.ibm.com/test-mgmt   n/n   Running   10.0.x.y   10.0.x.y-2248        5d1h
```

--------------------------------

### Complete Sample Plans Section

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=file-describing-plans-in-your-product

This example demonstrates a comprehensive Plans section, including a default plan with global limits and a custom plan with operation-specific rate and burst limits.

```yaml
plans:
  default:
    title: Default Plan
    description: Default Plan
    approval: false
    rate-limits:
      default:
        value: 100/hour
        hard-limit: false
  my-plan:
    title: my_plan
    rate-limits:
      Default rate-limit:
        value: 50/1hour
        hard-limit: false
    burst-limits:
      Default burst-limit:
        value: 10/1second
    apis:
      api21.0.0:
        operations:
          - operation: get
            path: /path2
      api31.0.0:
        operations:
          - operation: get
            path: /path3
            rate-limits:
              limit3:
                value: 10/1second
                hard-limit: true
              limit4:
                value: 100/1hour
                hard-limit: true
      api11.0.0: {}

```

--------------------------------

### Example Output for GatewayCluster CR

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=environment-custom-resources-custom-resource-definitions

This is an example output of the `kubectl get apic` command, specifically showing the details for a GatewayCluster Custom Resource. It includes readiness, status, version, and age.

```text
NAME                                                READY   STATUS    VERSION    RECONCILED VERSION   AGE
gatewaycluster.gateway.apiconnect.ibm.com/test-gw   n/n     Running   10.0.x.y   10.0.x.y-2248        5d
```

--------------------------------

### Resource-Level Parameter Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-example-managing-api

This example shows a GET request with a resource-level parameter that narrows the focus to a specific review within a phone resource. This parameter is specific to the 'phone' resource and its associated methods.

```HTTP
GET /phones/412456/user_reviews/78
```

--------------------------------

### Connect to MCP Server and Run Summarize-Text Tool

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tools-mcp-server-client

Example prompt for connecting to an MCP server at a specified URL and running the 'summarize-text' tool with parameters. This showcases general tool execution via the MCP client.

```text
Use MCP client to connect to https://tools.mcp/api and run to summarize-text with parameters
```

--------------------------------

### Example Analytics CR Status Output

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=kubernetes-upgrading-analytics-subsystem

Example output from `kubectl get apic -n <namespace>` after a successful analytics subsystem upgrade, showing the number of ready pods, status, and versions.

```text
NAME                                                      READY   STATUS    VERSION              RECONCILED VERSION      AGE
analyticscluster.analytics.apiconnect.ibm.com/analytics   5/5     Running   <version>   <version-build>   121m
```

--------------------------------

### Sample Developer Portal OpenSearch Configuration

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=configuration-securing-developer-portal-opensearch-communication

This sample configuration demonstrates how to set up secure communication with OpenSearch, including credentials, URI, and paths to keystore and truststore files.

```properties
# OpenSearch Configuration
wrapper.java.additional.2700=-Dportal.datastore.username=admin
wrapper.java.additional.2701=-Dportal.datastore.password=password1
wrapper.java.additional.2702=-Dportal.datastore.uris=https://opensearch:9200
# SSL Configuration for OpenSearch Keystore and Truststore
wrapper.java.additional.2707=-Dportal.datastore.ssl.keystore.alias=opensearch-client
wrapper.java.additional.2708=-Dportal.datastore.ssl.keystore.filepath=C:/Installer/DeveloperPortal/configuration/client.p12
wrapper.java.additional.2709=-Dportal.datastore.ssl.keystore.password=changeit
wrapper.java.additional.2710=-Dportal.datastore.ssl.truststore.filepath=C:/Installer/DeveloperPortal/configuration/truststore.jks
wrapper.java.additional.2711=-Dportal.datastore.ssl.truststore.password=changeit
```

--------------------------------

### Example of Listing Identity Providers

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=manager-using-cli-configure-shared-ldap-user-registry

An example output from the `identity-providers:list` command, showing titles and realms for available identity providers. This helps in selecting the correct realm for login.

```bash
apic identity-providers:list --scope admin --server myserver.com --fields title,realm
total_results: 2
results:
  - title: Cloud Manager User Registry
    realm: admin/default-idp-1
  - title: Corporate LDAP user registry
    realm: admin/corporate-ldap
```

--------------------------------

### Example Output for AnalyticsCluster CR

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=environment-custom-resources-custom-resource-definitions

This is an example output of the `kubectl get apic` command, specifically showing the details for an AnalyticsCluster Custom Resource. It includes readiness, status, version, and reconciled version.

```text
NAME                                               READY   STATUS    VERSION    RECONCILED VERSION   AGE
analyticscluster.analytics.apiconnect.ibm.com/test-a7s   n/n     Running   10.0.x.y   10.0.x.y-2248        5d
```

--------------------------------

### Method-Level Parameter Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-example-managing-api

This example demonstrates a GET request with method-level query parameters to filter user reviews by year and name. These parameters are specific to the method execution and help restrict the response data.

```HTTP
GET /phones/412456/user_reviews/78?year=2013&name=Allen
```
Tokens:
Raw