Prerequisites

The caller does not have to provide anything.

Authorization

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

Parameters

Query Parameters

Field name	Description	Format
usage	Include usage count for each connection	Boolean
offset	Number of items to skip for pagination	Integer
limit	Maximum number of items to return	Integer
connector_name	Filter connections by connector type	String
sort	Sort order for results.	String

Response Body

Field name	Description	Format
elements	List of connections	Array
total	Total amount of connections	Integer

Connection Structure

Field name	Description	Format
id	Connection ID	UUID
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
usage	Number of times the connection is used	Integer

Profile Structure

Field name	Description	Format
profileName	Key	String
profileValue	Profile config	JsonElement

Examples

{
  "elements": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "connection-mf-cics-cobol",
      "connector": "mainFrameRpc",
      "description": "example mf-cics-cobol connection",
      "profiles": {
        "$default": {
          "baseUrl": "http://cics.example.internal",
          "uriMap": "/example/latest",
          "port": "12345",
          "codePage": "cp037"
        }
      },
      "modifiedAt": "2026-01-01T00:00:00.000000Z",
      "modifiedBy": "John Doe",
      "createdAt": "2026-01-01T00:00:00.000000Z",
      "createdBy": "John Doe",
      "usage": 0
    }
  ],
  "total": 1
}