IBM API Connect

https://www.ibm.com/docs/en/api-connect/software
Admin
IBM API Connect is an API management platform that enables organizations to create, secure, manage,...
Tokens:914,981
Snippets:13,330
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example Subsystem Status Output

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

Sample output showing a successful installation, including cluster members, subsystem details, and a summary of running pods.

```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
```

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

### Build a single project example

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

Example command to build Project1 and save the output to a specific zip file path.

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

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

### Port Configuration Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=configuration-supported-environment-variables

Example showing how to map environment variables to specific listener keys defined in listeners.cnf.

```text
apigw_ports_0_key=HTTPListener@5555 
<definitions for port 5555>
(....) 
apigw_ports_1_key=WebSocketListener@4555 
<definitions for port 4555>
(...)
```

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

### Configure and install subsystem

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-adding-is-packages-webmethods-api-gateway

Use apicup to set the extra-values file and install the subsystem to apply changes.

```bash
apicup subsys set <wmgw_name> 
extra-values-file=<path_to_extra-values.yml>
```

```bash
apicup subsys install <wmgw_name>
```

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

### Example $ref file paths

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cvapdbuc-using-ref-reuse-code-fragments-in-your-openapi-files

Examples of referencing specific YAML and JSON fragment files.

```yaml
$ref: code_fragments/my_fragment.yaml
```

```json
{
  "$ref": "code_fragments/my_fragment.json"
}
```

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

### Site Configuration Export Output Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api

Example JSON response after initiating a site configuration export.

```json
{
    "status": 201,
    "message": {
        "stdout": "/catalogs/75cfdc05-e818-408e-8ce6-fd3fd61c8756/f09602a2-a0e4-40dc-a82d-d1af326ad092/config/export/5cy1gk55ciiwn190/status",
        "stderr": ""
    },
    "errors": []
}
```

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

### Example Calculation Parameters

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=planning-estimating-storage-requirements

Input variables used for the example storage requirement calculation.

```text
Copies of data = 3
API event data retention = 45 days
API summary data retention = 366 days
Activity log bytes per call = 1500 bytes
Header log bytes per call = 15000 bytes
Payload log bytes per call = 30500 bytes
% of Activity log = 70%
% of Header log = 20%
% of Payload log = 10%
Calls per day = 100000
```

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

### Global Policy Preflow Examples

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=policies-customizing-preflow

Examples demonstrating after-builtin, before-builtin, and full-custom modes for global policy preflow configuration.

```yaml
global-policy: 1.0.0
info:
  name: foo-example
  title: foo-example
  version: 2.0.0
  mode: after-builtin
gateways:
  - datapower-api-gateway
assembly:
  execute:
    - set-variable:
        version: 2.0.0
        title: set-variable
        actions:
          - set: message.headers.X-Flexible-Preflow
            value: 'Hello reboot global policy 1 on catalog 1 this policy will be executed after all default builtins'
            type: string
```

```yaml
global-policy: 1.0.0
info:
  name: foo-example
  title: foo-example
  version: 2.0.0
  mode: before-builtin
gateways:
  - datapower-api-gateway
assembly:
  execute:
    - set-variable:
        version: 2.0.0
        title: set-variable
        actions:
          - set: message.headers.X-Flexible-Preflow
            value: 'Hello reboot global policy 1 on catalog 1 this policy will be executed before all default builtin policies'
            type: string
```

```yaml
global-policy: 1.0.0
info:
  name: preflow-4-actions
  title: preflow-4-actions
  version: 2.0.0
  mode: full-custom
gateways:
  - datapower-api-gateway
assembly:
  execute:
    - cors:
        version: 2.0.0
        title: cors-in-preflow
    - wsdl:
        title: default-wsdl
    - html-page:
        title: html-page-in-preflow
        output: message
        version: 2.0.0
    - helloworld:
        version: 1.0.0
        title: helloworld
    - client-identification:
        version: 2.0.0
        title: ci-in-preflow
    - ratelimit:
        version: 2.0.0
        title: assembly-rt-in-preflow
        source: plan-default
    - security:
        version: 2.0.0
        title: sec-in-preflow
    - set-variable:
        version: 2.0.0
        title: set-variable
        actions:
          - set: message.headers.X-Flexible-Preflow
            value: 'Hello reboot with 4 actions'
            type: string
```

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

### Migration log example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=uwagv-data-transition-vmware

Example of the migration ID found in the upgrade log file.

```json
gateway-upgrade-core-20251209T08-46-57.log
Response body: {"migrationId":"61d22be6-9c61-496c-9928-59f9d4ab4b9c"}
```

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

### Example Backup Path

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=subsystem-troubleshooting-management-database-backup-restore

A concrete example of a full path to a management database backup on an S3 bucket.

```text
s3bucket1/folder2/mgmt-db-2023-12-25T00:00:00Z/base/20231225T094400
```

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

### Kubernetes Ingress Output Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=v12-migration-requirements

Example output showing the list of hostnames retrieved from a Kubernetes ingress resource.

```text
kubectl get ingress -n ask1
NAME                      CLASS    HOSTS                                     ADDRESS                                                                                             PORTS     AGE
analytics1-ac-endpoint    <none>   ac1.testuser1-master.fyre.example.com           1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
analytics1-ai-endpoint    <none>   ai1.testuser1-master.fyre.example.com           1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
apigw1-gateway            <none>   rgw1.testuser1-master.fyre.example.com          1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d5h
apigw1-gateway-manager    <none>   rgwd1.testuser1-master.fyre.example.com         1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d5h
management-admin          <none>   admin.testuser1-master.fyre.example.com         1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
management-api-manager    <none>   manager.testuser1-master.fyre.example.com       1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
management-consumer-api   <none>   consumer.testuser1-master.fyre.example.com      1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
management-platform-api   <none>   api.testuser1-master.fyre.example.com           1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
portal1-portal-director   <none>   api.portal1.testuser1-master.fyre.example.com   1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
portal1-portal-web        <none>   portal1.testuser1-master.fyre.example.com       1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d7h
v5gw1-gateway             <none>   gw1.testuser1-master.fyre.example.com           1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,1.2.104.161,1.2.104.166   80, 443   5d5h
v5gw1-gateway-manager     <none>   gwd1.testuser1-master.fyre.example.com          1.2.104.133,1.2.104.137,1.2.104.147,1.2.104.157,1.2.104.158,
```

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

### Example portal backup records

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

Shows an example output of PortalBackup custom resources for a portal with three sites.

```text
portal-record-222cg   20230108.010033                Ready    system   record  
portal-record-22xdc   20230108.010035                Ready    site     record  
portal-record-245j7   20230108.010037                Ready    site     record    
portal-record-246hm   20230108.010040                Ready    site     record 
```

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

### Netplan Configuration Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-changing-dns-server-configuration

Example structure of the name server addresses section within the Netplan YAML file.

```yaml
network:
    ethernets:
        eth0:
            addresses:
            - 192.168.122.242/24
            nameservers:
                addresses:
                - 1.1.1.1
                - 1.0.0.1
                - 8.8.8.8
                search:
                - nip.io
            routes:
            -   metric: 10
                to: 0.0.0.0/0
                via: 192.168.122.1
    version: 2
```

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

### Upgrade webMethods API Control Plane example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=ufamv-data-transition

Example command demonstrating an upgrade from a specific source server to a target server with certificate and authentication flags.

```bash
apicupgrade api-control-plane upgrade core \
  --source-server=https://source-control-plane.acme.com \
  --target-server=https://target-control-plane.acme.com \
  --source-username=administrator \
  --source-password=$SOURCE_PW \
  --target-username=administrator \
  --target-password=$TARGET_PW \
  --source-client-ca-cert=/apicupgrade/source-control-plane-ca.crt \
  --insecure-skip-tls-verify
```

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

### Theme File Contents Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api

Example output showing the contents of a valid theme export file.

```text
drwxrwsr-x  0 aegir  aegir       0  9 Jun 13:40 ./
drwxr-sr-x  0 aegir  aegir       0  9 Jun 13:40 emerald_theme_css/
-rw-r--r--  0 aegir  aegir       7  9 Jun 13:40 emerald_theme_css/emerald_theme_css.theme
-rw-r--r--  0 aegir  aegir   29224  9 Jun 13:40 emerald_theme_css/screenshot.png
-rw-r--r--  0 aegir  aegir     442  9 Jun 13:40 emerald_theme_css/composer.json
-rw-r--r--  0 aegir  aegir     599  9 Jun 13:40 emerald_theme_css/emerald_theme_css.info.yml
-rw-r--r--  0 aegir  aegir    1150  9 Jun 13:40 emerald_theme_css/favicon.ico
-rw-r--r--  0 aegir  aegir    5932  9 Jun 13:40 emerald_theme_css/logo.svg
-rw-r--r--  0 aegir  aegir      61  9 Jun 13:40 emerald_theme_css/emerald_theme_css.libraries.yml
drwxr-sr-x  0 aegir  aegir       0  9 Jun 13:40 emerald_theme_css/css/
-rw-r--r--  0 aegir  aegir   47249  9 Jun 13:40 emerald_theme_css/css/overrides.css
```

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

### Verify apicupgrade installation on Windows

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tools-installing-using-apicupgrade-cli

Use the help flag to confirm the tool is correctly installed and accessible in the command prompt.

```bash
apicupgrade -h
```

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

### GraphQL GET Request Formats

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

Examples of GraphQL input formats for GET requests.

```text
https://myapi/graphql?query={me{name}}
```

```text
https://hostname/basepath/graphql?query=query%20fetchAccounts%20($limit:%20Int)%20{accounts(limit:%20$limit)%20{name{first,last}}}&variables={"limit":100}&operationName=fetchAccounts
```

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

### Resource-level GET request example

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

A sample GET request targeting a specific user review within a phone resource.

```http
GET /phones/412456/user_reviews/78
```

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

### Create APIs and reference them in a Product

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

Create individual API definitions first, then associate them with a new Product using the --apis option.

```bash
apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"
```

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

### GraphQL GET request URL format

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

Example of a GraphQL query passed through a URL query parameter in a GET request.

```text
https://myapi/graphql?query={me{name}}
```

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

### Start the Developer Portal Docker image

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=support-running-developer-portal-docker-image

Use this command to initiate the container. Replace the placeholders with your specific host and port configurations.

```bash
docker run -p host_numer:port_numer image_name
```

```bash
docker run -p 18101:18101 dpo_final
```

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

### GraphQL GET request with variables and operation name

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

Example of a URL-encoded GraphQL GET request including variables and an operation name.

```text
https://hostname/basepath/graphql?query=query%20fetchAccounts
%20($limit:%20Int)%20{accounts(limit:%20$limit)%20{name{first,last}}}
&variables={"limit":100}&operationName=fetchAccounts
```

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

### Retrieve Phone Feature Information via GET

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

Example URL structure for retrieving specific resource data using an HTTP GET request.

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

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

### View help for product creation

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

Display available options and details for the product creation command.

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

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

### Authentication URL HTTP GET request

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

Example of the HTTP GET call issued by API Connect to the authentication endpoint with basic authorization credentials.

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

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

### GET /rest/apigateway/installedLanguages

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

Retrieves list of installed language packs in webMethods API Gateway.

```APIDOC
## GET /rest/apigateway/installedLanguages

### Description
Retrieves list of installed language packs in webMethods API Gateway.

### Method
GET

### Endpoint
/rest/apigateway/installedLanguages
```

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

### Create the PortalBackup resource

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

Apply the configuration file to initiate the backup process.

```bash
kubectl -n <portal namespace> create -f portalbackup_cr.yaml
```

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

### GET Request and Response for Token Revocation

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

Example of an API Gateway GET request to a revocation URL and the corresponding XML response containing revoked tokens and resource owner information.

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

```xml
<?xml version="1.0" encoding="UTF-8"?>
<oauth-revocation>

<!--
Access Tokens and/or Refresh Tokens that are revoked can be individually listed.
To keep this list small, please only include access tokens and refresh tokens that are valid.
For access tokens, any token older than 20 minutes is no longer valid.
For refresh tokens, any token older than 44700 minutes is no longer valid.
-->

<token type="access">AAETb2F1dGgtcmV2b2tlLWN1c3RvbfZaRlVbnPSc1...</token>
<token type="refresh">fZaRlVbnPSc1UGTjCRdq4mPbOosD2+aZIKbJ6bTeW...</token>

<!--
If a resource owner has revoked all tokens issued to a given application, please
list them as shown here. 
-->

<resource-owner client-id="760d75a2-44b1-4485-8c6f-0d264fcf7398">laura</resource-owner>
<resource-owner client-id="760d75a2-44b1-4485-8c6f-0d264fcf7398">emily</resource-owner>

</oauth-revocation>
```

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

### Complete Sample Plans Configuration

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

A comprehensive example demonstrating multiple plans, burst limits, and nested operation-level rate 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: {}
```

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

### MCP server creation and deployment prompts

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

Examples of commands for creating MCP servers from OpenAPI files and checking deployment status.

```text
Create an MCP server from openapi.yaml
```

```text
Deploy the application code using mcp-server.zip
```

```text
Give me the deployment status for the application code file mcp-server.zip
```

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

### View subsystem configuration output

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

Example output returned after running the get command for an analytics subsystem.

```text
Appliance settings                                    
==================                                    
                                                      
Name                                   Value           Description 
----                                   -----           ------
additional-cloud-init-file                             (Optional) Path to additional cloud-init yml file 
...
<list of settings continues>
```

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

### Complete APIs section example

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

A sample configuration showing multiple APIs referenced by name and version.

```yaml
apis:
  api11.0.0:
    name: 'api1:1.0.0'
  api21.0.0:
    name: 'api2:1.0.0'
  api31.0.0:
    name: 'api3:1.0.0'
```

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

### Run generateDockerfile 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 script with specific operating system and installation path parameters.

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

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

### Call Analytics REST API

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=ui-analytics-rest-api

Examples of authenticated GET requests for provider, consumer, and cloud analytics endpoints.

```bash
# This call to /orgs/<provider_organization>/events requires a bearer token that was requested with provider org credentials:
curl -k -H 'Authorization: Bearer <bearer_token>' -X GET --url 'https://<platform api endpoint>/analytics/<analytics_service>/orgs/<provider_organization>/events'

{
    "total": 300,
    "search_time": 3,
    "events": [...]
}

# This call to the consumer API: orgs/<consumer org>/dashboard, requires a bearer token that was requested with consumer org credentials.
curl -k -H 'X-IBM-Consumer-Context: <provider org>.<catalog>' -H 'Authorization: Bearer <bearer_token>' -X GET --url 'https://<consumer api endpoint>/consumer-analytics/orgs/<consumer org>/dashboard' 
{
    "search_time": 16,
    "status_codes": {
        "total": 300,
        "data": [...]
    },
    "min_response_time": {
        "data": ...
    ...


# This call to /cloud/events requires a bearer token that was requested with admin credentials:
curl -k -H 'Authorization: Bearer <bearer_token>' -X GET --url 'https://<platform api endpoint>/analytics/<analytics_service>/cloud/events'

{
    "total": 45543,
    "search_time": 36,
    "events": [...]

}
```

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

### Example GET request with introspection headers

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

A sample request showing how custom headers like x-Introspect- are passed to the API.

```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
```

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

### Create and verify portal subsystem

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

Initialize the portal subsystem and verify its configuration status.

```bash
apicup subsys create <subsystem name> portal
```

```bash
apicup subsys get <subsystem name>
```

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

### Viewing deploy command output

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

Example output showing the usage and options for the deploy command.

```text
Usage: apic deploy [options] [projects]

deploy the projects or the specified archive to API Gateway

Options:
  -l, --localDir <localDir>    path of the local directory of the specified project asset. For example, C:\local_dir
  -a, --all                    deploys all projects existing in the local directory
  -n, --names <names>          deploys the specified api asset kind. For example, dev:paymentAPI:1.0
  -ar, --archive <archive>     deploys the specified archive. For example, C:\dir\build.zip
  -t, --target <target>        endpoint of the API Gateway instance to which the asset has to be deployed
  -u, --username <username>    username of the API Gateway instance to which the asset has to be deployed
  -pwd, --password <password>  password of the API Gateway instance to which the asset has to be deployed
  -ow, --overwrite             overwrites the existing assets on the  instance where the specified asset is being
                               deployed
  -d, --debug                  enable debug mode
  -h, --help                   display help for command
```

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

### Gateway Token Verification Requests

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

Examples of GET requests sent by the Gateway to the revocation URL for verifying bearer and refresh tokens.

```http
GET  <revocationURL>HTTP/1.1 
access-token: AAETb2F1dGgtcmV2b2tlLWN1c3RvbfZaRlVbnPSc1
client-id: 760d75a2-44b1-4485-8c6f-0d264fcf7398 
resource-owner: alice
```

```http
GET  <revocationURL>GET  HTTP/1.1 
refresh-token: AAETb2F1dGgtcmV2b2tlLWN1c3RvbfZaRlVbnPSc1 
client-id: 760d75a2-44b1-4485-8c6f-0d264fcf7398 
resource-owner: alice
```

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

### Example REST API Call for Heartbeats

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=gateways-creating-agents-by-using-sdk

A sample HTTP GET request structure used to retrieve runtime health status.

```http
//REST API call 

GET /health HTTP/1.1      // REST API (specified in the runtime.heartbeat.url property)to retrieve the heartbeats of the runtime using POST method in HTTP protocol. 

Host: localhost:5555 	//Runtime URL (specified in the runtime.url property) 

Authorization: Basic QWRtaW5pc3RyYXRvcjptYW5hZ2U= // Text highlighted in bold is the AuthHeader value of the REST API (specified in the runtime.heartbeat.url.auth property) 
```

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

### Standard API Request with OAuth Token

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

Example of a GET request including an Authorization header with a Bearer token for scope validation.

```http
GET /getaccount
HTTP/1.1
Host: server.example.com
X-IBM-Client-Id: 8888-8888-8888
Authorization: Bearer AAEkNjVkOWIyYjgtOWY5ZS00YWQwLWIyYzktZ
```

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

### Sample .env Configuration File

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=transition-deployment-configurations

A template for the .env file containing all necessary properties for the Transition Helper tool.

```text
SERVER_SSL_ENABLED=
SERVER_SSL_CERTIFICATE=
SERVER_SSL_PRIVATE_KEY=
SERVER_SSL_PRIVATE_KEY_PASSWORD=

# Internationalization
I18N_DEFAULT_LOCALE=

# APIM Platform API Endpoint and Authentication
APIM_PLATFORM_API_BASE_URL=
APIM_AUTH_CLIENT_ID=
APIM_AUTH_CLIENT_SECRET=
APIM_AUTH_REALM=

APIM_AUTH_GRANT_TYPE=password
APIM_PLATFORM_API_CONNECTION_TIMEOUT_MS=
APIM_PLATFORM_API_READ_TIMEOUT_MS=
APIM_PLATFORM_API_SSL_DISABLE_VALIDATION=
APIM_PLATFORM_API_SSL_TRUST_CERTIFICATE_PATH=

# API Manager Configuration
APIM_ORG_NAME=
APIM_CATALOG_NAME=
APIM_GATEWAY_SERVICE_NAME=
APIM_PORTAL_SERVICE_NAME=
APIM_SPACE_NAME=
APIM_USER_REGISTRY_NAME=

# API Manager UI Configuration
APIM_MANAGER_BASE_URL=
APIM_MANAGER_SSL_DISABLE_VALIDATION=
APIM_MANAGER_SSL_TRUST_CERTIFICATE_PATH=
APIM_MANAGER_CONNECTION_TIMEOUT_MS=
APIM_MANAGER_TIMEOUT_MS=

# Logging Configuration
LOG_LEVEL=
LOG_FILE_PATH=
LOG_FILE_MAX_SIZE=
LOG_FILE_MAX_HISTORY=
LOG_FILE_TOTAL_SIZE_CAP=

# IBM Cloud IAM Authentication Configuration
IAM_TOKEN_ENDPOINT=
IAM_CONNECTION_TIMEOUT_MS=
IAM_READ_TIMEOUT_MS=
IAM_SSL_DISABLE_VALIDATION=

# API Gateway Configuration
APIGATEWAY_BASE_URL=
APIGATEWAY_SSL_DISABLE_VALIDATION=
APIGATEWAY_SSL_TRUST_CERTIFICATE_PATH=
APIGATEWAY_SSL_CONNECTION_TIMEOUT_MS=

# Developer Portal Configuration
PORTAL_UI_BASE_URL=
PORTAL_SSL_DISABLE_VALIDATION=
PORTAL_SSL_TRUST_CERTIFICATE_PATH=
PORTAL_SSL_CONNECTION_TIMEOUT_MS=
PORTAL_SSL_READ_TIMEOUT_MS=
PORTAL_API_VERIFY_MAX_RETRIES=
PORTAL_API_VERIFY_DELAY_MS=
```

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

### Retrieve topic details via cURL

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

Example of a GET request to retrieve specific topic details using basic authentication.

```bash
curl --location --request 
GET 'developer_portal_rest_base/topics/59d97968-7b25-4964-a0b7-d783ba910db2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic basic_auth' \
--data-raw ''
```

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

### GET /paymentgateway/user/signature

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

Retrieves the setup intent code used to initialize the UI for collecting card details in the 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
```

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

### Example registration output

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api

Sample output confirming successful application registration.

```text
app1    [state: enabled]   https://api.stagingexample.com/api/cloud/registrations/d2b7572f-3406-42a7-bdcc-85f177860df7
```

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

### Create and publish an API Product

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

Demonstrates the full workflow of creating APIs, bundling them into a Product, configuring the target catalog, authenticating, and publishing the result.

```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
```

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

### Verify Node.js Installation

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=caams-deploying-java-function-in-azure-that-uses-azure-cli

Checks if Node.js is installed on the system.

```bash
node –-version
```

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

### Install mkpasswd on macOS

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

Install the mkpasswd utility using RubyGems.

```bash
gem install mkpasswd
```

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

### Example user registry settings output

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

A sample response showing the structure of current user registry settings.

```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'
```

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

### Verify Azure CLI Installation

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=caams-deploying-java-function-in-azure-that-uses-azure-cli

Checks if the Azure CLI is installed on the system.

```bash
az –-version
```

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

### Example upgrade output

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

Sample output showing the status of the webMethods API Gateway subsystem after an upgrade.

```text
NAME                                                               READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE                   AGE
wmapigatewaycluster.wmapigateway.apiconnect.ibm.com/wmapigateway   4/4     Running   12.1.0.2   12.1.0.2-1573        WM API Gateway is ready   137m
```

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

### Install toolkit credentials

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=configuration-installing-toolkit

Configure the local toolkit with unique credentials downloaded from the API Connect UI.

```bash
apic client-creds:set toolkit_credentials_file_path/credentials.json
```

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

### Build all projects in a directory

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

Use the --all flag to bundle every project found within the specified local directory.

```bash
apic build --all --localDir local_dir_path 
--output build_output_path
```

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

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

### Configure Keystore Settings in YAML

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tokens-configuring-publicprivate-key-pairs

Example YAML file structure for configuring multiple token keystore URLs.

```yaml
access_token_keystore_urls:
  - >-
    https://mgmt_endpoint_url/api/orgs/1cdb71a1-b53c-4b66-b162-1b0f45ca8a54/keystores/de5298dd-a00b-45a0-9d08-96c5d93e1273
id_token_keystore_urls:
  - >-
    https://mgmt_endpoint_url/api/orgs/1cdb71a1-b53c-4b66-b162-1b0f45ca8a54/keystores/85a21745-8ac3-499d-929a-2d017bade815
temporary_token_keystore_urls:
  - >-
    https://mgmt_endpoint_url/api/orgs/1cdb71a1-b53c-4b66-b162-1b0f45ca8a54/keystores/63d6462f-c93d-439b-b422-0e604381e97a
```

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

### ManagementCluster warning response example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=integration-monitoring-postgres-disk-usage-cloud-pak

Example output showing a warning status for the ManagementCluster.

```text
NAME              READY   STATUS    VERSION        RECONCILED VERSION   AGE
production-mgmt   18/18   Warning   10.0.8.0-eus   10.0.8.0-3394-eus    43h

Current WAL disk usage of m1-ed60c42d-postgres is 61 percent. DATABASE SHUTDOWN starts at 80 percent utilization. Please contact IBM Support immediately
```

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

### Register an application

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api

Execute the registration command using the application configuration file.

```bash
apic registrations:create --server management_server app1.json
```

```bash
apic registrations:create --server api.stagingexample.com app1.json
```

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

### Example ManagementRestore Configuration

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

A populated example of the ManagementRestore CR using object-store settings.

```yaml
apiVersion: management.apiconnect.ibm.com/v1beta1
kind: ManagementRestore
metadata:
  generateName: management-
spec:
  subsystemName: management
  backup:
    protocol: objstore
    host: s3.ibm.com/us-west
    path: pic-mgmt-backups/impr-restore/m1-65288d1d-db-2023-09-14T01:30:40Z
    credentials: mgmt-backup-secret
  backupId: 20230914T013040
```

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

### List 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

Use the themes:list command to display all installed themes in the portal.

```bash
apic themes:list --mode portaladmin [flags]
```

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

### Publish Products with and without Configuration Variables

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

Comparison of publishing a product using explicit command-line options versus using a pre-configured catalog variable.

```bash
apic products publish climb-on.yaml --server mgmnthost.com --org climbon --catalog sandbox
```

```bash
apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
catalog: https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic products publish climb-on.yaml
```

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

### Daily backup cron example

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

Example cron string to trigger a backup at 1 AM daily.

```text
0 0 1 * * *
```

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

### Apply Portal Configuration

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-defining-multiple-portal-endpoints-environment

Set the extra-values file and install the portal subsystem configuration.

```bash
apicup subsys set <ptl_subsys> extra-values-file <path-to-ptl-extra-values-yaml-file>
```

```bash
apicup subsys install <ptl_subsys>
```

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

### View cluster status example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=subsystem-disabling-poddisruptionbudget-pdb-management-edb-database

Example output showing the status of a healthy Postgres cluster.

```text
NAME                       AGE   INSTANCES   READY   STATUS                     PRIMARY
apic-management-site1-db   95d   1           1       Cluster in healthy state   apic-management-site1-db-1
```

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

### Create API and Product definitions simultaneously

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

Combine API and Product creation in a single command execution.

```bash
apic create:api --title Routes --product "Climb On"
apic create:api --wsdl globalweather.wsdl --product "Weather Forecasting"
```

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

### JSON to XML conversion example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=policies-json-xml

Example of a JSON structure that the policy converts into XML format.

```json
{ "a" : "hello" }
```

```xml
<a>hello</a>
```

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

### Initialize API Connect project

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

Creates a new project directory and an empty configuration file for the API Connect deployment.

```bash
apicup init <apic project directory name>
```

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

### Export Status Response Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api

Example JSON response indicating the status of an export task.

```json
{
  "status": 200,
  "message": {
    "stdout": "The status of this task is: FINISHED and the artifact can now be streamed"
  },
  "errors": []
}
```

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

### Search all available documentation prompts

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=tools-documentation-searcher

Example queries for searching across both IBM and user-uploaded documentation.

```text
How do I manage an API lifecycle using API Connect?
```

```text
What should I do to learn API Connect / Get started
```

```text
What is a gateway? How does it relate to my API? Answer based on documentation
```

```text
According to user documents uploaded, what are the OOP concepts?
```

```text
Can API Connect work with my non-REST (SOAP/GraphQL) services according to all the documentation available?
```

```text
According to both user and IBM docs, how do I add custom JavaScript logic to my API flow?
```

```text
What are rate limits based on all the available documentation?
```

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

### Create an application with metadata

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

Use the apic CLI to create an application and define metadata keys in the configuration file.

```bash
apic apps:create myapp.yaml --server myserver.com 
--org myorg --catalog mycatalog --consumer-org mycorg
```

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

### Example Federated API Management secret name

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

Example of a specific secret name format.

```text
federatedapimanagement-admin-client
```

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

### LDAP Bind Suffix Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cluriam-using-cli-create-organization-specific-ldap-user-registry

Example format for the domain part of the user principal name.

```text
@acme.com
```

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

### Create a project

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=mcp-project-related-operations

Commands to create a new project with optional descriptions and tags.

```text
create project using name <xyz>
```

```text
create a studio project with name my-project1 that is managed by API Manager
```

```text
create project using name test-project and description "some description"
```

```text
create project using name test-project and description "some description" and tags tag1,tag2
```

```text
create a studio project with name my-project1 that is managed by API Manager and using tags tag1,tag2,tag3
```

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

### SOAP GetWeather Response Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=api-example-definition-globalweather-100yaml

Example of a SOAP envelope containing the response for the GetWeather operation.

```xml
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 <soapenv:Body>
  <tns:GetWeatherResponse xmlns:tns="http://www.webserviceX.NET">
   <tns:GetWeatherResult>string</tns:GetWeatherResult>
  </tns:GetWeatherResponse>
 </soapenv:Body>
</soapenv:Envelope>
```

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

### Create portal subsystem

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=steps-installing-target-system-vmware

Initializes the portal subsystem with the specified name.

```bash
apicup subsys create <portal subsystem name> portal
```

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

### Accessing script help

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=v12-migration-troubleshooting

Use this command to view available options and help documentation for migration scripts.

```bash
python3 <SCRIPT_FILE_NAME> --help
```

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

### List installed CMS Portal service

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=commands-using-service-command

Lists the installed CMS Portal service in JSON format.

```bash
apic --mode portaladmin service:list -s management_server --portal_service_name PORTAL-SERVICE-NAME --format json
```

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

### Dry run output examples

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=vmware-testing-new-configuration-against-current-cluster

Examples of success and failure messages returned by the dry run command.

```text
managementcluster.management.apiconnect.ibm.com/management configured (server dry run)
```

```text
Error: Failed to execute dry-run:....
```

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

### Example credentials.json structure

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=in-enabling-api-connect-plug-backstage

Reference structure for toolkit credentials used to populate configuration values.

```json
{
  "cloud_id": "<instance1-cloudID>",
  "toolkit": {
    "endpoint": "https://api.<instance1>com/api",
    "client_id": "<instance1-clientID>",
    "client_secret": "<instance1-clientSecret>"
  },
  "consumer_toolkit": {
    ...
  },
  ...
}
```
Tokens:
Raw