IBM API Connect Cloud Service

https://www.ibm.com/docs/en/api-connect/cloud
Admin
IBM API Connect Cloud Service is a cloud-based solution for creating, securing, managing, and...
Tokens:1,362,029
Snippets:7,770
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### API Connect Toolkit CLI - Login and Setup

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=data-analytics-cli

Instructions for installing the API Connect toolkit, logging in using the CLI, and setting the context.

```APIDOC
## Install and Login with API Connect Toolkit CLI

### Description
This section outlines the steps to install the API Connect toolkit and log in using the command-line interface (CLI).

### Steps
1.  **Install the toolkit**: Refer to the "Setting up the API Connect toolkit" documentation for installation instructions.
2.  **Log in with the CLI**:
    Use the `apic login` command with your platform API host name and optionally `--sso` for single sign-on.

    ```bash
    apic login --server <platform-api-host-name> --sso
    ```

    Replace `<platform-api-host-name>` with the hostname of your API Manager server. For example, if your API Manager URL is `https://platform-api.us-east-1.d-r01.apic.cloud.ibm.com/manager`, the hostname is `platform-api.us-east-1.d-r01.apic.cloud.ibm.com`.

3.  **Set the context**:
    When prompted for the context, enter `provider`.

    ```bash
    Context? provider
    ```

### Further Information
For more details on the toolkit CLI, see "Setting up the API Connect toolkit".
```

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

### HTML Block for Help Resources and Navigation

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=tutorials-tutorial-changing-front-page-your-developer-portal

This comprehensive HTML block consolidates help resources, including sections for getting started, a forum link, and contact information. It uses SVG icons and specific CSS classes for layout and visual elements.

```html
<div class="block-get-help">
<div class="get_help">
<div class="column col1">
<h3>Getting Help</h3>

<div>Be sure to check out these extra help resources.</div>
</div>

<div class="column col2">
<h4>Get Started</h4>

<div>Get started with our APIs by creating an account and exploring the documentation to find what's right for you.</div>

<div><a href="user/register"><svg height="24" id="Layer_1" space="preserve" version="1.1" viewbox="0 0 32 32" width="24" x="0px" xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" y="0px"> <g> <polygon points="15.293,10.707 19.586,15 8,15 8,17 19.586,17 15.293,21.293 16.707,22.707 23.414,16 16.707,9.293"></polygon> <path d="M16,2C8.269,2,2,8.269,2,16s6.269,14,14,14c7.731,0,14-6.269,14-14S23.731,2,16,2z M16,28C9.383,28,4,22.617,4,16S9.383,4,16,4c6.617,0,12,5.383,12,12S22.617,28,16,28z"></path> </g> </svg>Create an Account</a></div>
</div>

<div class="column col3">
<h4>Forum</h4>

<div>Ask a question in the forums or search to forum history to see if it's been asked before.</div>

<div><a href="forum"><svg height="24" id="Layer_1" space="preserve" version="1.1" viewbox="0 0 32 32" width="24" x="0px" xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" y="0px"> <g> <polygon points="15.293,10.707 19.586,15 8,15 8,17 19.586,17 15.293,21.293 16.707,22.707 23.414,16 16.707,9.293"></polygon> <path d="M16,2C8.269,2,2,8.269,2,16s6.269,14,14,14c7.731,0,14-6.269,14-14S23.731,2,16,2z M16,28C9.383,28,4,22.617,4,16S9.383,4,16,4c6.617,0,12,5.383,12,12S22.617,28,16,28z"></path> </g> </svg>Join the discussion</a></div>
</div>

<div class="column col4">
<h4>Contact Us</h4>

<div>Can't find the answer to your question? Need more help? Have some feedback? Let us know!</div>

<div><a href="contact"><svg height="24" id="Layer_1" space="preserve" version="1.1" viewbox="0 0 32 32" width="24" x="0px" xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" y="0px"> <g> <polygon points="15.293,10.707 19.586,15 8,15 8,17 19.586,17 15.293,21.293 16.707,22.707 23.414,16 16.707,9.293"></polygon> <path d="M16,2C8.269,2,2,8.269,2,16s6.269,14,14,14c7.731,0,14-6.269,14-14S23.731,2,16,2z M16,28C9.383,28,4,22.617,4,16S9.383,4,16,4c6.617,0,12,5.383,12,12S22.617,28,16,28z"></path> </g> </svg>Email us</a></div>
</div>
</div>
</div>
```

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

### GET /hello

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=xslt-policy-examples

This endpoint returns a simple 'Hello World!' message using an XSLT policy. It demonstrates a basic XSLT transformation.

```APIDOC
## GET /hello

### Description
This endpoint returns a "Hello World!" message using a basic XSLT policy. It showcases a straightforward XSLT transformation without external variable retrieval.

### Method
GET

### Endpoint
/xslt/hello

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (string) - The response body will contain an XML element 'APIc' with the text 'Hello World!'.

#### Response Example
```xml
<APIc>Hello World!</APIc>
```
```

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

### HTML Block for New Account Creation Link

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=tutorials-tutorial-changing-front-page-your-developer-portal

A simple HTML block designed to prompt users to create a new account and get started with the APIs. It includes a direct link for registration and is intended to be styled by the portal's theme.

```html
<div class="tutorial_block_3">
<p class="text-align-center"><a href="user/register">Create a new account</a> and get started with our APIs. It's free to join.</p>
</div>
```

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

### Getting Started with AI Gateway and Azure OpenAI

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=applications-using-ai-gateway-support-azure-openai-apis

Steps to get started with the AI Gateway and Azure OpenAI, including environment setup, API creation, and policy configuration.

```APIDOC
## Getting started with the AI Gateway and Azure OpenAI

To use the AI Gateway, complete the following steps:

1.  Set up your environment as explained in Prerequisites for using the AI Gateway with Azure OpenAI.
2.  Create an API to use as a reverse-proxy.
3.  Add the Azure OpenAI invoke policy to the API so it can access the Azure OpenAI platform.
4.  Review metrics on the API's performance in the AI usage dashboard, which tracks AI token and model usage.
```

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

### Example GET Request to Authentication URL Endpoint

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=registries-creating-authentication-url-user-registry

This example demonstrates a basic HTTP GET request made by API Connect to an Authentication URL endpoint for user authentication. It includes essential headers like 'Host' and 'Authorization'.

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

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

### Create APIs, Product, and Publish to Catalog using `apic` CLI

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=tool-publishing-apis-applications

This snippet demonstrates the workflow of creating APIs, composing them into an API Product, configuring the catalog, logging in, and finally publishing the API Product to an API Connect catalog using the `apic` CLI. It covers API and Product creation, configuration, authentication, and the publish command.

```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 GET Request with Additional Headers and Cookie

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=registries-creating-authentication-url-user-registry

This example shows an extended HTTP GET request to the Authentication URL endpoint. It includes additional headers like 'X-Forwarded-For' and 'X-Custom-Header-From-Customer', as well as a 'Cookie' header, which API Connect forwards to the identity provider.

```HTTP
GET /user/authenticate HTTP/1.1
 Host: myauthurl.example.com
 Authorization: Basic c3Bvb246Zm9yaw=
 X-Forwarded-For: 8.8.9.9
 X-Custom-Header-From-Customer: special
 Cookie: MyCookie=VGhpc0lzV2lja2VkQW1hemluZw==
```

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

### Example Catalog Creation Command and Response

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=domain-lightweight-gateway-tutorial

Demonstrates an example of creating a catalog using the API Connect CLI with specific platform endpoint and organization details. It includes the expected response format, which contains the catalog name and its API endpoint URL.

```bash
./apic -s platform-api.us-east-a.apiconnect.automation.ibm.com catalogs:create -o lwgw-demo catalog.yaml
previewcatalog https://platform-api.us-east-a.apiconnect.automation.ibm.com/api/catalogs/1273ce81-ef2c-4d01-96c4-5f33c1af119e/e80bfea1-bf1d-4af1-9d60-4fa1c16e836f
```

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

### GET /getQuery

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=xslt-policy-examples

A placeholder GET endpoint indicating an operation that is not implemented and will result in an error.

```APIDOC
## GET /getQuery

### Description
This endpoint is defined but has no associated assembly execution. Calls to this endpoint will trigger the 'otherwise' clause in the operation-switch policy, resulting in an 'Unsupported' error.

### Method
GET

### Endpoint
/xslt/getQuery

### Parameters

#### Query Parameters
None specified in the policy.

#### Request Body
None

### Request Example
```
GET /xslt/getQuery
Host: $(catalog.host)
X-IBM-Client-Id: YOUR_CLIENT_ID
```

### Response
#### Error Response (Unsupported)
- **message** (string) - Indicates that the requested operation is not supported.

#### Response Example
```xml
<error>Not Supported</error>
```
```

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

### API Connect Complete Sample Plans Section

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

A comprehensive example demonstrating the structure of a complete 'plans' section in API Connect, including default and custom plans with various rate limiting and API operation configurations.

```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: {}

```

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

### Create and Publish Initial API Product Version

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=tool-managing-api-products

Creates a new API definition and a corresponding Product, then publishes the initial version of the Product. It takes API definition and Product filenames as input.

```shell
apic create:api --title Routes --version 1.0.0 --filename routes100.yaml
apic create:product --title "Climb On" --version 1.0.0 --apis routes100.yaml --filename climbon100.yaml
apic products:publish climbon100.yaml
```

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

### GraphQL GET Request Examples

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=api-request-mechanisms-supported-by-graphql-endpoints

Demonstrates how to send GraphQL queries using the HTTP GET method. The query is provided as a URL parameter named 'query'. This example also shows how to include optional 'variables' and 'operationName' by URL encoding them.

```url
https://hostname/basepath/graphql?query={accounts(limit:100){name{first,last}}}
```

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

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

### GET /hello

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=xslt-policy-examples

A simple GET endpoint that returns a 'Hello World!' message using an XSLT policy.

```APIDOC
## GET /hello

### Description
This endpoint demonstrates a basic XSLT transformation to return a static 'Hello World!' message. It's a foundational example of applying XSLT within API Connect.

### Method
GET

### Endpoint
/xslt/hello

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A static greeting message.

#### Response Example
```xml
<APIc>Hello World!</APIc>
```
```

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

### Complete Sample Plans Section

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

An example of a comprehensive plans section in API Connect configuration, demonstrating various settings.

```APIDOC
## Complete Sample Plans Section

### Description
This is a full example of a `plans` section in API Connect configuration, illustrating the usage of default plans, custom plans with rate and burst limits, and operation-specific rate limits.

### Method
N/A (Configuration file structure)

### Endpoint
N/A (Configuration file structure)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **plans** (object) - Required - Contains definitions for one or more API plans.
  - **default** (object) - A predefined plan that can serve as a base or default.
    - **title** (string) - The display title for the plan.
    - **description** (string) - A description of the plan.
    - **approval** (boolean) - Toggles whether plan approval is required.
    - **rate-limits** (object) - Defines rate limiting for the plan.
      - **default** (object) - The default rate limit configuration.
        - **value** (string) - The rate limit value (e.g., "100/hour").
        - **hard-limit** (boolean) - Specifies if the rate limit is hard.
  - **my-plan** (object) - A custom API plan.
    - **title** (string) - The display title for the plan.
    - **rate-limits** (object) - Defines rate limiting for the plan.
      - **Default rate-limit** (object) - A specific rate limit configuration.
        - **value** (string) - The rate limit value (e.g., "50/1hour").
        - **hard-limit** (boolean) - Specifies if the rate limit is hard.
    - **burst-limits** (object) - Defines burst limits for the plan.
      - **Default burst-limit** (object) - A specific burst limit configuration.
        - **value** (string) - The burst limit value (e.g., "10/1second").
    - **apis** (object) - Associates APIs with the plan.
      - **api21.0.0** (object) - An API included in the plan.
        - **operations** (array) - Defines operations for this API.
          - (object) - Represents an operation.
            - **operation** (string) - The HTTP verb of the operation (e.g., "get").
            - **path** (string) - The path of the operation (e.g., "/path2").
      - **api31.0.0** (object) - Another API included in the plan.
        - **operations** (array) - Defines operations for this API.
          - (object) - Represents an operation.
            - **operation** (string) - The HTTP verb of the operation (e.g., "get").
            - **path** (string) - The path of the operation (e.g., "/path3").
            - **rate-limits** (object) - Defines operation-specific rate limits.
              - **limit3** (object) - A rate limit.
                - **value** (string) - The rate limit value (e.g., "10/1second").
                - **hard-limit** (boolean) - Specifies if the rate limit is hard.
              - **limit4** (object) - Another rate limit.
                - **value** (string) - The rate limit value (e.g., "100/1hour").
                - **hard-limit** (boolean) - Specifies if the rate limit is hard.
      - **api11.0.0** (object) - An API included in the plan without specific operations defined.

### Request Example
```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: {}
```

### Response
N/A (Configuration file structure)
```

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

### GET /getContextQueryVar

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=xslt-policy-examples

This GET endpoint retrieves the 'user-agent' header and the full query string using XSLT and context variables.

```APIDOC
## GET /getContextQueryVar

### Description
This endpoint utilizes an XSLT policy to dynamically retrieve and display the `request.headers.user-agent` context variable and the entire request query string.

### Method
GET

### Endpoint
/xslt/getContextQueryVar

### Parameters

#### Query Parameters
Any query parameters appended to this URL will be captured by the `request.querystring` context variable.

#### Request Body
None

### Request Example
```
GET /xslt/getContextQueryVar?param1=value1&param2=value2
Host: $(catalog.host)
X-IBM-Client-Id: YOUR_CLIENT_ID
User-Agent: PostmanRuntime/7.28.1
```

### Response
#### Success Response (200)
- **useragent** (string) - The value of the `request.headers.user-agent` context variable.
- **query** (string) - The complete query string from the request URL.

#### Response Example
```xml
<APIC>
  <apim:getVariable>
    <useragent>PostmanRuntime/7.28.1</useragent>
    <query>param1=value1&amp;param2=value2</query>
  </apim:getVariable>
</APIC>
```
```

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

### API Connect Toolkit CLI Help

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=cli-getting-started-portal-commands

View available commands and general help for the API Connect Toolkit CLI.

```APIDOC
## GET /apic/help

### Description
Displays the available commands and general usage information for the API Connect Toolkit CLI.

### Method
GET

### Endpoint
/apic

### Parameters

#### Query Parameters
* `--help` (boolean) - Optional - Show help for the apic command.
* `--mode` (string) - Optional - Toolkit operation mode (default "apim").

### Request Example
```bash
apic -h
```

### Response
#### Success Response (200)
- Output will show available flags and commands.

#### Response Example
```
Usage:
  apic [flags]
  apic [command]

Available Flags:
      --accept-license        Accept the license for API Connect
      --debug                 Enable debug output
      --debug-output string   Write debug output to file
  -h, --help                  Help for apic
      --live-help             Enable or disable tracking of limited usage information
  -m, --mode string           Toolkit operation mode (default "apim")

Available Commands:
  # ... (list of commands) ...

Additional help topics:

Use "apic [command] --help" for more information about a command.
```
```

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

### OIDC Redirect URI Example from Registry Details

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

Example snippet showing the structure of the output from the 'apic user-registries:get' command, specifically highlighting the location of the 'oidc_redirect_uri' within the 'consumer' section.

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

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

### Complete Sample Plans Section

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

A comprehensive example illustrating a complete 'plans' section in API Connect configuration, showcasing multiple plans with varied rate limits, burst limits, and API operation configurations.

```APIDOC
## Complete Sample Plans Section

### Description
This example provides a fully realized 'plans' configuration, demonstrating how to define multiple plans, each with its own set of rate limits, burst limits, and API/operation-specific configurations.

### Method
N/A (Configuration file structure)

### Endpoint
N/A (Configuration file structure)

### Parameters
N/A (This is a complete example, not a template)

### Request Example
```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: {}
```

### Response
N/A (This is a configuration structure)
```

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

### Gateway Request Example

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=tokens-token-revocation

This snippet shows an example of a GET request to a revocation URL for an API Connect gateway. It includes necessary headers like access-token, client-id, and resource-owner. This is used to initiate a request to the revocation service.

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

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

### POST /users

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=reference-api-product-definition-template-examples

Creates a new user.

```APIDOC
## POST /users

### Description
Create a new user.

### Method
POST

### Endpoint
/users

### Parameters

#### Request Body
(The request body schema is defined in `#/definitions/User`)

### Request Example
```json
{
  "example": "User object structure"
}
```

### Response
#### Success Response (201)
- **description** (string) - 'Success'
  schema: $ref: '#/definitions/User'
#### Response Example
```json
{
  "example": "Created User object structure"
}
```
#### Error Response (default)
- **description** (string) - 'Unexpected error'
  schema: $ref: '#/definitions/Error'
```

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

### Standard Scope Validation Example Request

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=connect-scope

This example demonstrates a standard GET request to access an API, requiring an access token with specific scopes. The `Authorization` header contains the Bearer token, and `X-IBM-Client-Id` identifies the client application.

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

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

### Create API Product and API

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=tool-managing-api-products

Creates a new API Product and an associated API. This command simplifies the initial setup of an API product. Requires a title for the API and the product name.

```bash
apic create:api --title Routes --product "ClimbOn"
```

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

### Control Developer Portal Examples with x-example

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=file-product-definition-schema

The `x-example` extension allows you to control the examples displayed in the Developer Portal for API operations, enhancing the user experience for developers integrating with your APIs.

```yaml
paths:
  /items:
    get:
      summary: Get a list of items
      x-example:
        - title: Basic request
          value: |
            GET /items
            HTTP/1.1 200 OK
            Content-Type: application/json

            {
              "items": [
                {"id": 1, "name": "Item 1"}
              ]
            }
```

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

### GET /movies

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=assist-profile-configuration

Retrieves a list of movies with an optional limit on the number of results.

```APIDOC
## GET /movies

### Description
Retrieves a list of movies. The `limit` query parameter can be used to set an upper bound on the number of movies returned.

### Method
GET

### Endpoint
/movies

#### Query Parameters
- **limit** (integer) - Optional - Sets an upper bound on the number of movies returned. Values can range from 0 to 500.

### Request Example
```
GET /movies?limit=50
```

### Response
#### Success Response (200)
- **movies** (array) - A list of movie objects.

#### Response Example
```json
{
  "movies": [
    {
      "id": "123",
      "title": "Inception",
      "director": "Christopher Nolan"
    },
    {
      "id": "456",
      "title": "The Matrix",
      "director": "The Wachowskis"
    }
  ]
}
```
```

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

### URL-encoded GET Request with Variables and OperationName

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=api-request-mechanisms-supported-by-graphql-endpoints

This example demonstrates a URL-encoded GET request that includes the 'query' parameter along with 'variables' and 'operationName' for more complex GraphQL operations. URL encoding is necessary for these parameters.

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

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

### CLI Output in French Example

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=tool-overview-command-line

Demonstrates the expected CLI output when the language is set to French. This example shows an error message displayed in French after attempting to get an invalid configuration variable.

```bash
apic config get invalid
Error: invalid n'est pas une variable de configuration valide
```

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

### Example API Connect Identity Providers List Output

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=cluriam-using-cli-create-organization-specific-ldap-user-registry

An example output from the `apic identity-providers:list` command, showing available identity providers with their titles and realms. This helps users identify the correct realm for login.

```text
total_results: 2
results:
  - title: API Manager User Registry
    realm: provider/default-idp-2
  - title: Corporate LDAP user registry
    realm: provider/corporate-ldap
```

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

### API Product Definition for Lightweight Gateway

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=domain-lightweight-gateway-tutorial

This YAML file defines an API product, bundling one or more APIs. It specifies the product's version, title, and the gateway it's intended for (lightweight-gateway). It also includes plan definitions, rate limits, API references, and visibility settings for the product.

```yaml
info:
  version: 1.0.0
  title: lwgw-product-demo
  name: lwgw-product-demo
gateways:
- lightweight-gateway
plans:
  default-plan:
    title: Default Plan
    description: Default Plan
    rateLimitMap:
      plan-limit: default
components:
  rateLimits:
    default:
    - max: 100
      intervalLen: 1
      intervalUnit: hour
apis:
  demo:
    $ref: demo.yaml
visibility:
  view:
    type: public
    orgs: []
    tags: []
    enabled: true
  subscribe:
    type: authenticated
    orgs: []
    tags: []
    enabled: true
product: 1.0.0

```

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

### GET /getQuery

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=xslt-policy-examples

This endpoint is defined but has an empty execution array, indicating it might be a placeholder or intentionally unhandled.

```APIDOC
## GET /getQuery

### Description
This endpoint is defined in the OpenAPI specification but has no associated policies configured for execution. It currently does not perform any actions.

### Method
GET

### Endpoint
/xslt/getQuery

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (string) - The response will likely be an empty body or a default gateway response as no processing is defined.

#### Response Example
```json
{}
```
```

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

### Default Activity Logging Example (YAML)

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=execute-activity-log

A basic example demonstrating the minimal configuration for the activity-log policy using default settings. It specifies the version and a title for the logging activity.

```yaml
# use defaults

- activity-log:
  version: 1.0.0
  title: default activity logging
```

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

### GET Request with GraphQL Query Parameter

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=api-request-mechanisms-supported-by-graphql-endpoints

This method uses an HTTP GET request where the GraphQL query is provided as a URL query parameter named 'query'. This is a simple way to send basic queries. The example shows a query for accounts with a limit.

```HTTP
https://hostname/basepath/graphql?query={accounts(limit:100){name{first,last}}}
```

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

### Stage Product to Catalog using API Connect CLI

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=domain-lightweight-gateway-tutorial

This command stages a product to a specified catalog in API Connect. It requires the catalog name, organization name, and the path to the product YAML file. The output, including the product URL, is captured in an environment variable.

```bash
PRODUCT_URL=$(./apic -s  products:publish -c <catalog_name> -o <org_name> --stage <path_to_product_yaml> --format json | jq -r '.url')
```

```bash
PRODUCT_URL=$(./apic -s platform-api.us-east-a.apiconnect.automation.ibm.com products:publish -c previewcatalog -o lwgw-demo --stage  lwgw-product-demo.yaml --format json | jq -r '.url')
```

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

### Platform API Connect LTE Commands

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=api-testing-local-test-environment

A collection of commands to manage the Local Test Environment (LTE) for API Connect. These commands allow users to initialize, start, stop, check status, and display version information. The `start` command includes an option to set the database max heap size.

```bash
platform-apic-lte help command
platform-apic-lte init
platform-apic-lte start
platform-apic-lte start --database-max-heap-size 4096M
platform-apic-lte start --database-max-heap-size 1G
platform-apic-lte start --database-max-heap-size 1048576K
platform-apic-lte start --database-max-heap-size 1073741824
platform-apic-lte start --keep-config
platform-apic-lte status
platform-apic-lte stop
platform-apic-lte version
```

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

### Get Runtime Variable (GatewayScript)

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=xslt-implementation-code-examples

Use the `apic.getvariable` function in GatewayScript to retrieve the value of a runtime variable.

```APIDOC
## Get Runtime Variable (GatewayScript)

### Description
Use the `apic.getvariable` function in GatewayScript to retrieve the value of a runtime variable.

### Method
GatewayScript

### Endpoint
N/A

### Parameters
#### Function Parameters
- **varName** (string) - Required - The name of the runtime variable to retrieve.

### Request Example
```javascript
var variableValue = apic.getvariable(varName);
```

### Response
#### Success Response
- **variableValue** (string) - The retrieved value of the runtime variable.

#### Response Example
```javascript
// Assuming 'serviceEndpoint' is set to 'https://endpoint.host.com/data'
var endpoint = apic.getvariable('serviceEndpoint');
console.log(endpoint); // Output: https://endpoint.host.com/data
```
```

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

### Get Help for 'apic create:product' Command

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

This command displays detailed help information and available options for the 'apic create:product' command. It's useful for understanding all configuration parameters and usage variations.

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

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

### GraphQL Request Formats

Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance_topic=policies-parse

Examples of how to format GraphQL queries for the Parse policy. This includes direct GraphQL in the body, a JSON string with query details, and URL-encoded queries for GET requests.

```json
{
  "me": {
    "name"
  }
}
```

```json
{
  "query": "query MyData ($idVar: Int!) { user (id: $idVar) { name }}",
  "operationName": "MyData",
  "variables": {"idVar": 123}
}
```

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

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

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

### Product API Reference Example (API Connect)

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=acra-example-using-platform-rest-apis-publish-product-containing-soap-api

Example of a product definition in API Connect, demonstrating the correct format for API references within the `apis` section. Each API reference must use the `name` property, not `$ref`.

```yaml
info:
  version: 1.0.0
  title: GlobalWeatherProduct
  name: globalweatherproduct
plans:
  ...
apis:
  globalweather1.0.0:
    name: globalweather:1.0.0
...
```

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

### Get Runtime Variable (XSLT)

Source: https://www.ibm.com/docs/en/api-connect/cloud/saas_topic=xslt-implementation-code-examples

This XSLT code block shows how to retrieve the value of a runtime variable using the `getVariable()` function.

```APIDOC
## Get Runtime Variable (XSLT)

### Description
This XSLT code block shows how to retrieve the value of a runtime variable using the `getVariable()` function.

### Method
XSLT Transformation

### Endpoint
N/A

### Parameters
#### XSLT Parameters
- **varName** (string) - Required - The name of the runtime variable to retrieve.

### Request Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0"
  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  xmlns:dp="http://www.datapower.com/extensions"
  xmlns:func="http://exslt.org/functions"
  xmlns:apim="http://www.ibm.com/apimanagement" 
  exclude-result-prefixes="dp func apim"
  extension-element-prefixes="dp func apim">

  <xsl:import href="local:///isp/policy/apim.custom.xsl" />
  <xsl:include href="store:///dp/apim.custom.xsl" />

  <xsl:template match="/">
    <xsl:variable name="varValue" select="apim:getVariable('serviceEndpoint')" />
    <dp:url-open target="{$varValue}" response="xml" http-method="get"/>
  </xsl:template>

</xsl:stylesheet>
```

### Response
#### Success Response
- **varValue** (string) - The retrieved value of the runtime variable.

#### Response Example
(Output depends on the variable's value, shown in console message)
```
Variable [serviceEndpoint] = [https://endpoint.host.com/data]
```
```
Tokens:
Raw