read module

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Prerequisites

The caller must provide a module id.

Authorization

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

Parameters

Path Parameters

Field name	Description	Format
id	Module ID	UUID

Response Body

Field name	Description	Format
id	Module ID	UUID
name	The name of the module	String
modifiedAt	The date and time of last modification	String
modifiedBy	The user who last modified the module	String
description	Module description	String
bookmarked	Whether the module is bookmarked	Boolean
createdAt	The date and time of creation	String
createdBy	The user who created the module	String
connection	Module connection	Object
additionalInfo	Additional module info	Object

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	The user who last modified the connection	String
createdAt	The date and time of creation	String
createdBy	The user who created the connection	String

Profile Structure

Field name	Description	Format
profileName	Key	String
profileValue	Profile config	JsonElement

Additional Info Structure

Field name	Description	Format
numOfAssets	Number of assets in the module	Integer
numOfProjects	Number of projects using the module	Integer
type	The module connector type	String

Examples

{
  "id": "00000000-0000-0000-0000-000000000011",
  "name": "module-mainframe-rpc",
  "modifiedAt": "2026-01-01T00:00:00.000000Z",
  "modifiedBy": "John Doe",
  "description": "",
  "bookmarked": false,
  "createdAt": "2026-01-01T00:00:00.000000Z",
  "createdBy": "John Doe",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "module-mainframe-rpc-default-connection-1",
    "connector": "mainFrameRpc",
    "description": "Auto-generated connection for module module-mainframe-rpc",
    "profiles": {
      "$default": {
        "baseUrl": "http://cics.example.internal",
        "uriMap": "/example/latest",
        "port": "12345",
        "codePage": "cp037"
      }
    },
    "modifiedAt": "2026-01-01T00:00:00.000000000Z",
    "modifiedBy": "",
    "createdAt": "2026-01-01T00:00:00.000000000Z",
    "createdBy": ""
  },
  "additionalInfo": {
    "numOfAssets": 0,
    "numOfProjects": 0,
    "type": "mainFrameRpc"
  }
}

{
  "id": "00000000-0000-0000-0000-000000000022",
  "name": "module-as400-rpc",
  "modifiedAt": "2026-01-01T00:00:00.000000Z",
  "modifiedBy": "John Doe",
  "description": "",
  "bookmarked": false,
  "createdAt": "2026-01-01T00:00:00.000000Z",
  "createdBy": "John Doe",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000002",
    "name": "module-as400-rpc-default-connection-1",
    "connector": "as400Rpc",
    "description": "Auto-generated connection for module module-as400-rpc",
    "profiles": {
      "$default": {
        "codePage": "037",
        "host": "ibmi.example.internal",
        "user": "example-user",
        "password": "'{cipher}a1b2c3d4e5f67890'"
      }
    },
    "modifiedAt": "2026-01-01T00:00:00.000000000Z",
    "modifiedBy": "",
    "createdAt": "2026-01-01T00:00:00.000000000Z",
    "createdBy": ""
  },
  "additionalInfo": {
    "numOfAssets": 0,
    "numOfProjects": 0,
    "type": "as400Rpc"
  }
}

{
  "id": "00000000-0000-0000-0000-000000000033",
  "name": "module-ims-rpc",
  "modifiedAt": "2026-01-01T00:00:00.000000Z",
  "modifiedBy": "John Doe",
  "description": "",
  "bookmarked": false,
  "createdAt": "2026-01-01T00:00:00.000000Z",
  "createdBy": "John Doe",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000003",
    "name": "module-ims-rpc-default-connection-1",
    "connector": "imsRpc",
    "description": "Auto-generated connection for module module-ims-rpc",
    "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",
    "modifiedBy": "",
    "createdAt": "2026-01-01T00:00:00.000000000Z",
    "createdBy": ""
  },
  "additionalInfo": {
    "numOfAssets": 0,
    "numOfProjects": 0,
    "type": "imsRpc"
  }
}

Parameters

Examples

200