create new connection

Prerequisites

• The caller must provide a connection name and connector type.

Authorization

• API key (via the X-API-KEY header).

Parameters

Request Body

Field name	Description	Format
name	The name of the connection	String
connector	The type of connector	String
description	Connection description	String
profiles	Connection profiles	Map
modifiedAt	The date and time of modification	String
modifiedBy	Modified by	String
createdAt	The date and time of creation	String
createdBy	Created by	String

Response Body

Field name	Description	Format
id	Connection ID	UUID
name	The name of the connection	String
connector	The type of connector	String
description	Connector description	String
profiles	Connection profiles	Map
modifiedAt	The date and time of modification	String
createdAt	The date and time of creation	String
createdBy	Created by	String

Profile Structure

| Field name   | Description    | Format      |
| :----------- | :------------- | :---------- |
| profileName  | Key            | String      |
| profileValue | Profile config | JsonElement |

Examples

mainframe-rpc

    {
      "name": "connection-mainframe-rpc",
      "connector": "mainFrameRpc",
      "description": "example mainframe-rpc connection",
      "profiles": {
        "$default": {
          "baseUrl": "http://cics.example.internal",
          "uriMap": "/example/latest",
          "port": "12345",
          "codePage": "cp037"
        }
      },
      "modifiedBy": "John Doe",
      "modifiedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "John Doe",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
    ```
    ```json Response
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "connection-mainframe-rpc",
      "connector": "mainFrameRpc",
      "description": "example mainframe-rpc connection",
      "profiles": {
        "$default": {
          "baseUrl": "http://cics.example.internal",
          "uriMap": "/example/latest",
          "port": "12345",
          "codePage": "cp037"
        }
      },
      "modifiedAt": "2026-01-01T00:00:00.000000000Z",
      "createdAt": "2026-01-01T00:00:00.000000000Z",
      "createdBy": "John Doe"
    }
    ```

  

#### as400-rpc

```json Request
    {
      "name": "connection-as400-rpc",
      "connector": "as400Rpc",
      "description": "example as400-rpc connection",
      "profiles": {
        "$default": {
          "codePage": "037",
          "host": "ibmi.example.internal",
          "user": "example-user",
          "password": "example-password"
        }
      },
      "modifiedBy": "John Doe",
      "modifiedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "John Doe",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
    ```
    ```json Response
    {
      "id": "00000000-0000-0000-0000-000000000002",
      "name": "connection-as400-rpc",
      "connector": "as400Rpc",
      "description": "example as400-rpc connection",
      "profiles": {
        "$default": {
          "codePage": "037",
          "host": "ibmi.example.internal",
          "user": "example-user",
          "password": "'{cipher}a1b2c3d4e5f67890'"
        }
      },
      "modifiedAt": "2026-01-01T00:00:00.000000000Z",
      "createdAt": "2026-01-01T00:00:00.000000000Z",
      "createdBy": "John Doe"
    }
    ```

  

#### ims-rpc

```json Request
    {
      "name": "connection-ims-rpc",
      "connector": "imsRpc",
      "description": "example ims-rpc connection",
      "profiles": {
        "$default": {
          "host": "cics.example.internal",
          "username": "example-username",
          "password": "example-password",
          "groupName": "GROUP1",
          "dataStoreName": "IVP1",
          "port": 9999,
          "codePage": "cp037",
          "sslProperties": {
            "isSslEnabled": false
          },
          "transactionProperties": {
            "commitMode": "SEND_AND_COMMIT"
          }
        }
      },
      "modifiedBy": "John Doe",
      "modifiedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "John Doe",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
    ```
    ```json Response
    {
      "id": "00000000-0000-0000-0000-000000000003",
      "name": "connection-ims-rpc",
      "connector": "imsRpc",
      "description": "example ims-rpc connection",
      "profiles": {
        "$default": {
          "host": "cics.example.internal",
          "username": "example-username",
          "password": "'{cipher}a1b2c3d4e5f67890'",
          "groupName": "GROUP1",
          "dataStoreName": "IVP1",
          "port": 9999,
          "codePage": "cp037",
          "sslProperties": {
            "isSslEnabled": false
          },
          "transactionProperties": {
            "commitMode": "SEND_AND_COMMIT"
          }
        }
      },
      "modifiedAt": "2026-01-01T00:00:00.000000000Z",
      "createdAt": "2026-01-01T00:00:00.000000000Z",
      "createdBy": "John Doe"
    }
    ```