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

{
  "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"
}

{
  "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"
}