IBM API Connect

https://www.ibm.com/docs/en/api-connect
Admin
IBM API Connect is an API management solution that helps organizations create, secure, manage, and...
Tokens:669,158
Snippets:10,470
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### View API Connect installation help

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

Displays all available optional flags for the installation script.

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

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

### Single Project Build Example

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=studio-build

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

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

### Global policy preflow examples

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

Examples demonstrating the three available modes: after-builtin, before-builtin, and full-custom.

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

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

### 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 structure of ingress resources on a Kubernetes cluster.

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

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

### Complete Plans section example

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

A comprehensive example demonstrating multiple plans, including default settings, 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: {}
```

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

### Example export task creation

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

An example of exporting specific node entities and the resulting output.

```bash
apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog content:create-export --entity_type node --entity_ids 1,2
201 CREATED - Task ID: 8h86b8utjtw51

Response Code - 202:

Message(s) - 
The status of this task is: RUNNING

Response Code - 200:

Message(s) -
The status of this task is: FINISHED and the artifact can now be streamed

Saving File (Large files may take a while)...
Incoming project saved to content_createExport-20230627114023.tgz
```

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

### Query-String Parameter Examples

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

Examples showing URI construction with query parameters for filtering and API key authentication.

```text
/phones?features=androidosv4.3&cameraresolution=8MP
```

```text
http://pie-3HKYMH2:5555/gateway/PetstoreAPI/1.0.3/store/inventory?APIKey=faab7ac6-97a4-4228-908d-f1930faba470
```

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

### Example management server URL

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=environment-onboarding-new-admin-cloud-pak-integration

An example of the URL format returned by the management server query.

```text
apic-mgmt-admin-apic.deve-cip-hlag-8e86d3798137c73f524cf9-0000.eu-de.containers.appdomain.cloud
```

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

### Gateway Identity Provider Output Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cloud-reviewing-processing-status-downloading-gateway-logs

Example output showing the title and realm for an identity provider.

```yaml
total_results: 1
results:
  - title: Cloud Manager User Registry
    realm: admin/default-idp-1
```

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

### Define a parameter example using x-example

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=cvapdbuc-using-x-example-control-examples-displayed-in-cms-portal

Use this syntax within an OpenAPI parameter definition to provide a custom example value for the CMS Portal.

```yaml
 - name: city
   in: query
   required: false
   type: string
   maxLength: 50
   description: "Location"
   x-example: "New York"
```

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

### Resource-level GET request example

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

Demonstrates a GET request targeting a specific resource path for a phone review.

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

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

### Example GET request with introspection headers

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

A sample GET request showing the inclusion of custom x-Introspect headers and the Authorization bearer token.

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

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

### Viewing help for the deploy command

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

Example of retrieving help documentation for the deploy command.

```bash
apic help deploy
```

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

### GraphQL GET request with variables and operation name

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

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

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

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

### View help for create:product command

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

Displays available options and details for the product creation command.

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

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

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

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

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

### Create and publish an API Product

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

Demonstrates the sequence 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
```

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

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

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

### Call Analytics REST API

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

Examples of authenticated GET requests for provider and consumer 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": ...
    ...
```

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

### Analytics API Requests

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

Examples of GET requests to retrieve analytics events for providers, consumers, and cloud administration.

```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": [...]
```

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

### Create and deploy MCP server commands

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

Examples of prompts for generating and deploying MCP servers from OpenAPI files.

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

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

### Standard API Request with OAuth Token

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

Example of a GET request requiring an access token with valid scopes.

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

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

### Example REST API Call for Heartbeats

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

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

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

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

### Initialize API Connect project directory

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

Create a new project directory and generate the initial configuration file.

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

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

### Start the Developer Portal Docker container

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, replacing placeholders with your specific host and port numbers.

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

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

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

### Retrieve topic details using cURL

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

Example of a GET request to fetch details for a specific topic 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 ''
```

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

### Create a Catalog via stdin

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=tool-reading-input-from-command-line

Creates a new Catalog by providing configuration details via stdin.

```bash
apic catalogs:create --server platform-api.myserver.com --org myorg -
Reading CATALOG_FILE arg from stdin
name: production
title: Production Catalog
summary: Catalog containing APIs in production use
```

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

### Retrieve comments using cURL

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=apis-collaboration

Example of a GET request to retrieve a list of comments for a specific topic using basic authentication.

```bash
curl --location --request 
GET 'developer_portal_rest_base/topics/topic_Id/comments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic basic_auth' \
```

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

### Create API and Product definitions simultaneously

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

Generate an API and associate it with a Product in a single command execution.

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

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

### GET /paymentgateway/user/signature

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?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
```

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

### Analytics Operations

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

The Analytics tool supports four primary operations: Get analytics usage, Get analytics latency, Get analytics status, and Get analytics users. All operations share a common set of parameters for filtering and formatting.

```APIDOC
## Common Parameters

### Parameters
#### Query Parameters
- **userPrompt** (string) - Required - Natural language query input.
- **query** (string) - Optional - HTTP query string filters.
- **dateCategory** (string) - Optional - Time unit for relative queries (e.g., day, hour).
- **dateNum** (integer) - Optional - Number of units for relative queries.
- **startDay** (string) - Optional - Start date in YYYY-MM-DD format.
- **startTime** (string) - Optional - Start time in HH:mm:ss format.
- **endDay** (string) - Optional - End date in YYYY-MM-DD format.
- **endTime** (string) - Optional - End time in HH:mm:SS format.
- **timeZone** (string) - Optional - Override the default time zone.
- **catalog** (string) - Optional - Catalog name or ID.
- **space** (string) - Optional - Space name or ID.
- **analyticsService** (string) - Optional - Analytics service name or ID.
- **chart** (string) - Required - Chart type (bar, line, pie) or 'auto' for automatic selection.
```

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

### SOAP Response Example

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

Example of a GetCitiesByCountryResponse SOAP envelope.

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

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

### Create an application with metadata

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?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
```

```yaml
name: myapp
title: My test application
metadata:
  key1: value1
  key2: value2
  key3: value3
  key4: value4
  key5: value5
```

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

### Example 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 for Federated API Management.

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

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

### Example Identity Provider List Response

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=data-setting-environment-variables-config-sync

Sample output showing available realms for an API Connect deployment.

```yaml
apic identity-providers:list --scope provider --server <mgmt_endpoint_url> --fields title,realm

total_results: 2
results:
  - title: 'API Manager User Registry'
    realm: 'provider/default-idp-2'
  - title: 'Common Services User Registry'
    realm: 'provider/common-services'
```

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

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

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

### Create APIs and reference them in a new Product

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

Generate multiple API definitions and include them in a new Product definition by referencing their YAML files.

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

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

### Define Discovery Seed Hosts Example

Source: https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=configuration-configuring-high-availability

Example of listing multiple nodes in the discovery.seed_hosts property.

```yaml
discovery.seed_hosts: ["node1:9340","node2:9340","node3":"9340"]
```

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

### Example .info.yml Configuration for Drupal 9 Compatibility

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_reserved_instance?topic=portal-troubleshooting-guide-cms

A sample .info.yml file demonstrating the required core_version_requirement key for Drupal 8 and 9 compatibility.

```yaml
name: Example module
type: module
description: Purely an example
core: 8.x
core_version_requirement: '^8 || ^9'
package: Example module

# Information added by Drupal.org packaging script on 2020-05-31
version: '8.x-1.3'
project: 'example_module'
datestamp: 1590905415
```

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

### CORS Response Example

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_reserved_instance?topic=api-calling-by-using-cors

An example of the response headers returned by the gateway to authorize a CORS request.

```HTTP
HTTP/1.1 200 OK
X-Backside-Transport: FAIL FAIL 
Connection: Keep-Alive
Transfer-Encoding: chunked
Access-Control-Allow-Origin: https://example.com
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers:accept, accept-language, content-type, x-ibm-client-id
Access-Control-Allow-Methods: methods allowed on the resource
Vary: Origin
```

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

### YAML Configuration for Keystore URLs

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

Example of a YAML file structure for uploading multiple keystore configurations to the management server.

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

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

### Sample APIs section configuration

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

A complete example of an APIs section referencing three distinct APIs.

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

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

### Verify Operator Installation

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=gateway-deploying-remote-nano

Command to verify that the required CustomResourceDefinitions are installed, followed by the expected output.

```bash
oc get crd | grep -E 'NAME|cert-manager.io|ibm.com'
```

```text
certificaterequests.cert-manager.io
certificates.cert-manager.io
challenges.acme.cert-manager.io
clusterissuers.cert-manager.io
datapowermonitors.datapower.ibm.com
datapowermustgathermanagers.datapower.ibm.com
datapowermustgathers.datapower.ibm.com
datapowerrollouts.datapower.ibm.com
datapowerservicebindings.datapower.ibm.com
datapowerservices.datapower.ibm.com
gatewayclusters.gateway.apiconnect.ibm.com
issuers.cert-manager.io
orders.acme.cert-manager.io
```

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

### Create API or Product definition from template

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=cli-creating-using-api-product-definitions-templates

Use this command to generate an API or Product definition file from a specified .hbs template file.

```bash
apic create:[api | product] --template template_file --title [api_title | product_title] options
```

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

### Create a Product definition file via CLI

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

Use this command to generate a new Product definition file with specified name, title, filename, and associated APIs.

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

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

### Example Nano Gateway hostname

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

A concrete example of a generated hostname following the required hierarchical pattern.

```text
invokeproject-nanospec-1-product-cat5org1.nanogw.at-nov14.wonderwoman.dev.ciondemand.com
```

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

### Upgrade Portal Subsystem

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

Commands to prepare the environment, install the upgrade, and verify subsystem health.

```bash
for pkg in libpq5 shim shim-signed; do rm -f "/etc/apt/preferences.d/${pkg}-preferences"; done
```

```bash
apicup subsys install <subsystem_name> <subsystem_upgrade_tar_archive>
```

```bash
apicup subsys install <subsystem_name> <subsystem_upgrade_tar_archive> <path_to_control_plane_file_1> <path_to_control_plane_file_n> <other arguments>
```

```bash
apicup subsys health-check <subsystem_name>
```

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

### POST /programs

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_saas?topic=apis-programs

Create a program with the given details.

```APIDOC
## POST /programs

### Description
Create a program with the given details.

### Method
POST

### Endpoint
/programs
```

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

### OIDC redirect URI configuration example

Source: https://www.ibm.com/docs/en/api-connect/saas?topic=registries-creating-oidc-user-registry-in-api-manager

An example of the consumer section containing the OIDC redirect URI.

```yaml
consumer:
  oidc_redirect_uri: https://consumer.mycompany.com/consumer-api/oauth2/redirect
```

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

### CORS Preflight Request Example

Source: https://www.ibm.com/docs/en/api-connect/cloud/12.1.1_reserved_instance?topic=api-calling-by-using-cors

An example of an OPTIONS request sent by a browser to verify CORS permissions.

```HTTP
OPTIONS /org/env/api/resourceHTTP/1.1
User-Agent: useragent details
Access-Control-Request-Method: GET
Access-Control-Request-Headers: header names
Host: x.xx.xxx.xx
Origin: https://example.com
Accept: */*
```

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

### Prepare Ubuntu Upgrade

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

Copies the Ubuntu upgrade package to all subsystem VMs.

```bash
apicup subsys prepare-ubuntu-upgrade <subsystem name> ubuntu-noble-upgrade.tgz
```
Tokens:
Raw