New Release
Guardian 3.7.0
Ctrlk
Release NotesCalendar
youtube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Modules

Reusable policy logic modules that can be composed into workflows.

Return a list of all modules.

get

Returns all modules. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
200

Successful operation.

application/json
get/modules
GET /api/v1/modules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T12:23:36.763Z",
    "updateDate": "2026-03-25T12:24:28.059Z",
    "uuid": "2abde099-08f6-4d75-9de3-d6f33d95bc72",
    "name": "New Module",
    "description": "New module description",
    "status": "PUBLISHED",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8370210",
    "messageId": "1774441459.171929000",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "contentFileId": "69c3d3e5462c9c1141de3074",
    "config": {
      "name": "New Module",
      "description": "New module description",
      "blockType": "module",
      "permissions": [],
      "id": "7d25fdf6-8fc4-4d01-b635-541b996415ce",
      "tag": "Module",
      "children": [],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    },
    "id": "69c3d3c8462c9c1141de3069"
  },
  {
    "createDate": "2026-03-25T12:23:29.549Z",
    "updateDate": "2026-03-25T12:23:53.759Z",
    "uuid": "e4ecf6f4-36fb-4872-99b8-9b592aac241d",
    "name": "Device configuration module",
    "description": "Part of devices flow",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "config": {
      "name": "Device configuration module",
      "description": "Part of devices flow",
      "blockType": "module",
      "permissions": [],
      "id": "3dc74d7b-eae8-49a5-84d5-c267c1fd8d06",
      "tag": "Module",
      "children": [],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    },
    "id": "69c3d3c1462c9c1141de3066"
  }
]

Creates a new module.

post

Creates a new module. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
201

Successful operation.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
post/modules
POST /api/v1/modules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "name": "New Module",
  "description": "New module description",
  "menu": "show",
  "config": {
    "blockType": "module"
  }
}
{
  "createDate": "2026-03-25T12:04:14.291Z",
  "updateDate": "2026-03-25T12:04:14.291Z",
  "uuid": "f0624944-02f0-4329-8cae-e871c1984bf4",
  "name": "New Module",
  "description": "New module description",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.3578734",
  "owner": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.3578734",
  "codeVersion": "1.0.0",
  "type": "CUSTOM",
  "config": {
    "blockType": "module",
    "permissions": [],
    "children": [],
    "events": [],
    "artifacts": [],
    "variables": [],
    "inputEvents": [],
    "outputEvents": [],
    "innerEvents": []
  },
  "id": "69c3cf3e462c9c1141de3052"
}

Return a list of all module schemas.

get

Returns all module schemas. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
topicIdstringOptional

Filter module schemas by topic id.

Example: 0.0.6046379
Responses
200

Successful operation.

application/json
get/modules/schemas
GET /api/v1/modules/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T12:40:32.586Z",
    "updateDate": "2026-03-25T12:40:59.908Z",
    "uuid": "b71c8b0e-b4aa-4d0b-ab63-639e306c02ea",
    "name": "Module schema 3",
    "description": "",
    "entity": "VC",
    "status": "PUBLISHED",
    "version": "3",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8370319",
    "messageId": "1774442456.657381000",
    "documentURL": "ipfs://bafkreifyyqurrnlxnhblm57qobo2ecv4wjm3o7i3axgscls3ydjn3fefaq",
    "contextURL": "ipfs://bafkreid6crdhdtk3mtusl4mqcrjlsan6o7eanyetko3k5nwykcvezndepy",
    "iri": "#b71c8b0e-b4aa-4d0b-ab63-639e306c02ea&3",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "MODULE",
    "codeVersion": "1.2.0",
    "document": "innerSchemaConfigurationInText",
    "context": "jsonLdContextInText",
    "topicCount": 1,
    "id": "69c3d7b9462c9c1141de309b"
  },
  {
    "createDate": "2026-03-25T12:29:13.470Z",
    "updateDate": "2026-03-25T12:29:13.470Z",
    "uuid": "5ff2b3dd-1ea0-44c1-a84d-7c68c0d55184",
    "name": "Module schema 2",
    "description": "",
    "entity": "NONE",
    "status": "DRAFT",
    "version": "1.0.1",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8370227",
    "documentURL": "",
    "contextURL": "schema:5ff2b3dd-1ea0-44c1-a84d-7c68c0d55184",
    "iri": "#5ff2b3dd-1ea0-44c1-a84d-7c68c0d55184&1.0.1",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "MODULE",
    "codeVersion": "1.2.0",
    "document": "innerSchemaConfigurationInText",
    "topicCount": 1,
    "id": "69c3d513462c9c1141de3091"
  },
  {
    "createDate": "2026-03-25T12:28:37.997Z",
    "updateDate": "2026-03-25T12:28:37.997Z",
    "uuid": "de840307-57f4-423b-9216-fb6f0e1f788e",
    "name": "Module schema 1",
    "description": "",
    "entity": "VC",
    "status": "DRAFT",
    "version": "1.0.1",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8370224",
    "documentURL": "",
    "contextURL": "schema:de840307-57f4-423b-9216-fb6f0e1f788e",
    "iri": "#de840307-57f4-423b-9216-fb6f0e1f788e&1.0.1",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "MODULE",
    "codeVersion": "1.2.0",
    "document": "innerSchemaConfigurationInText",
    "topicCount": 1,
    "id": "69c3d4ef462c9c1141de3087"
  }
]

Creates a new module schema.

post

Creates a new module schema. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
createDatestring · nullableOptionalExample: 2026-03-25T12:40:32.586Z
updateDatestring · nullableOptionalExample: 2026-03-25T12:40:59.908Z
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Schema name
descriptionstringRequiredExample: Description
entitystring · enumRequiredExample: POLICYPossible values:
iristringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
statusstring · enumRequiredExample: DRAFTPossible values:
topicIdstringRequiredExample: 0.0.6046379
versionstringRequiredExample: 1.0.0
creatorstring · nullableOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstring · nullableOptionalExample: 1773670900.819264517
categorystring · enumRequiredExample: POLICYPossible values:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
Responses
201

Created schema.

application/json
createDatestring · nullableOptionalExample: 2026-03-25T12:40:32.586Z
updateDatestring · nullableOptionalExample: 2026-03-25T12:40:59.908Z
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Schema name
descriptionstringRequiredExample: Description
entitystring · enumRequiredExample: POLICYPossible values:
iristringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
statusstring · enumRequiredExample: DRAFTPossible values:
topicIdstringRequiredExample: 0.0.6046379
versionstringRequiredExample: 1.0.0
creatorstring · nullableOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstring · nullableOptionalExample: 1773670900.819264517
categorystring · enumRequiredExample: POLICYPossible values:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
post/modules/schemas
POST /api/v1/modules/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1259

{
  "uuid": "d26a7a31-00ba-4c30-1314-3d9eecfd7eda",
  "hash": "",
  "name": "Module schema example",
  "description": "",
  "entity": "NONE",
  "status": "DRAFT",
  "readonly": false,
  "document": {
    "$id": "#d26a7a31-00ba-4c30-1314-3d9eecfd7eda",
    "$comment": "{ \"@id\": \"schema:d26a7a31-00ba-4c30-1314-3d9eecfd7eda#d26a7a31-00ba-4c30-1314-3d9eecfd7eda\", \"term\": \"d26a7a31-00ba-4c30-1314-3d9eecfd7eda\" }",
    "title": "Module schema example",
    "description": "",
    "type": "object",
    "properties": {
      "@context": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "type": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "id": {
        "type": "string",
        "readOnly": true
      },
      "field0": {
        "title": "field0",
        "description": "qweqwe",
        "readOnly": false,
        "type": "string",
        "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"availableOptions\":[],\"orderPosition\":0}"
      }
    },
    "required": [
      "@context",
      "type"
    ],
    "additionalProperties": false,
    "$defs": {}
  },
  "context": null,
  "version": "",
  "sourceVersion": "",
  "creator": "",
  "owner": "",
  "messageId": "",
  "documentURL": "",
  "contextURL": "schema:d26a7a31-00ba-4c30-1314-3d9eecfd7eda",
  "iri": "",
  "fields": [],
  "conditions": [],
  "active": false,
  "system": false,
  "category": "MODULE",
  "errors": [],
  "userDID": null,
  "codeVersion": ""
}
[
  {
    "createDate": "2026-03-25T13:43:28.481Z",
    "updateDate": "2026-03-25T13:43:28.481Z",
    "uuid": "d26a7a31-00ba-4c30-1314-3d9eecfd7eda",
    "name": "Module schema example",
    "description": "",
    "entity": "NONE",
    "status": "DRAFT",
    "version": "1.0.1",
    "sourceVersion": "",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8371271",
    "messageId": null,
    "documentURL": "",
    "contextURL": "schema:d26a7a31-00ba-4c30-1314-3d9eecfd7eda",
    "iri": "#d26a7a31-00ba-4c30-1314-3d9eecfd7eda&1.0.1",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "MODULE",
    "codeVersion": "1.2.0",
    "document": "innerSchemaConfigurationInText",
    "id": "69c3e679ae73da728c8d8eaf"
  }
]

Retrieves module configuration.

get

Retrieves module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Successful operation.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
get/modules/{uuid}
GET /api/v1/modules/{uuid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-25T12:23:29.549Z",
  "uuid": "e4ecf6f4-36fb-4872-99b8-9b592aac241d",
  "name": "Device configuration module",
  "description": "Part of devices flow",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "codeVersion": "1.0.0",
  "type": "CUSTOM",
  "config": {},
  "id": "69c3d3c1462c9c1141de3066"
}

Updates module configuration.

put

Updates module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
201

Successful operation.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
put/modules/{uuid}
PUT /api/v1/modules/{uuid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 936

{
  "createDate": "2026-03-25T14:29:09.327Z",
  "uuid": "f964f762-4e77-4f09-b98e-c1f12961ff17",
  "name": "UPDATED NAME",
  "description": "UPDATED DESCRIPTION",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "type": "CUSTOM",
  "config": {
    "name": "UPDATED NAME",
    "description": "UPDATED DESCRIPTION",
    "blockType": "module",
    "permissions": [],
    "id": "738b9162-a25c-43b9-a609-490a10af3bd6",
    "tag": "Module",
    "children": [
      {
        "id": "90debdfe-1f45-4704-8641-a957aef87f77",
        "blockType": "interfaceContainerBlock",
        "defaultActive": true,
        "permissions": [],
        "onErrorAction": "no-action",
        "uiMetaData": {
          "type": "blank",
          "title": "UPDATED TITLE"
        },
        "tag": "Module:UPDATED_BLOCK_NAME",
        "children": [],
        "events": [],
        "artifacts": []
      }
    ],
    "events": [],
    "artifacts": [],
    "variables": [],
    "inputEvents": [],
    "outputEvents": [],
    "innerEvents": []
  },
  "id": "69c3f135ae73da728c8d8f57"
}
{
  "createDate": "2026-03-25T14:29:09.327Z",
  "updateDate": "2026-03-25T14:33:42.812Z",
  "uuid": "f964f762-4e77-4f09-b98e-c1f12961ff17",
  "name": "UPDATED NAME",
  "description": "UPDATED DESCRIPTION",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "codeVersion": "1.0.0",
  "type": "CUSTOM",
  "config": {
    "name": "UPDATED NAME",
    "description": "UPDATED DESCRIPTION",
    "blockType": "module",
    "permissions": [],
    "id": "738b9162-a25c-43b9-a609-490a10af3bd6",
    "tag": "Module",
    "children": [
      {
        "id": "90debdfe-1f45-4704-8641-a957aef87f77",
        "blockType": "interfaceContainerBlock",
        "defaultActive": true,
        "permissions": [],
        "onErrorAction": "no-action",
        "uiMetaData": {
          "type": "blank",
          "title": "UPDATED TITLE"
        },
        "tag": "Module:UPDATED_BLOCK_NAME",
        "children": [],
        "events": [],
        "artifacts": []
      }
    ],
    "events": [],
    "artifacts": [],
    "variables": [],
    "inputEvents": [],
    "outputEvents": [],
    "innerEvents": []
  },
  "id": "69c3f135ae73da728c8d8f57"
}

Deletes the module.

delete

Deletes the module with the provided module ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Successful operation.

application/json
booleanOptional
delete/modules/{uuid}
DELETE /api/v1/modules/{uuid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Return a list of modules.

get

Returns modules menu. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Modules.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
get/modules/menu
GET /api/v1/modules/menu HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T12:23:36.763Z",
    "updateDate": "2026-03-25T12:24:28.059Z",
    "uuid": "2abde099-08f6-4d75-9de3-d6f33d95bc72",
    "name": "New Module",
    "description": "New module description",
    "status": "PUBLISHED",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8370210",
    "messageId": "1774441459.171929000",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "contentFileId": "69c3d3e5462c9c1141de3074",
    "config": {
      "name": "New Module",
      "description": "New module description",
      "blockType": "module",
      "permissions": [],
      "id": "7d25fdf6-8fc4-4d01-b635-541b996415ce",
      "tag": "Module",
      "children": [],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    },
    "id": "69c3d3c8462c9c1141de3069"
  },
  {
    "createDate": "2026-03-25T12:23:29.549Z",
    "updateDate": "2026-03-25T12:23:53.759Z",
    "uuid": "e4ecf6f4-36fb-4872-99b8-9b592aac241d",
    "name": "Device configuration module",
    "description": "Part of devices flow",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "config": {
      "name": "Device configuration module",
      "description": "Part of devices flow",
      "blockType": "module",
      "permissions": [],
      "id": "3dc74d7b-eae8-49a5-84d5-c267c1fd8d06",
      "tag": "Module",
      "children": [],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    },
    "id": "69c3d3c1462c9c1141de3066"
  }
]

Return module and its artifacts in a zip file format for the specified module.

get

Returns a zip file containing the published module and all associated artifacts, i.e. schemas and VCs. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Binary ZIP archive (Content-Type: application/zip, Content-Disposition: attachment). Not JSON.

application/zip
string · binaryOptional
get/modules/{uuid}/export/file
GET /api/v1/modules/{uuid}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Return Heder message ID for the specified published module.

get

Returns the Hedera message ID for the specified module published onto IPFS. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Message.

application/json
uuidstringRequired
namestringRequired
descriptionstringRequired
messageIdstringRequired
ownerstringRequired
get/modules/{uuid}/export/message
GET /api/v1/modules/{uuid}/export/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "2abde099-08f6-4d75-9de3-d6f33d95bc72",
  "name": "New Module",
  "description": "New module description",
  "messageId": "1774441459.171929000",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161"
}

Imports new module from IPFS.

post

Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequired

Hedera topic message id

Responses
201

Created module.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
post/modules/import/message
POST /api/v1/modules/import/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1774456966.828228000"
}
{
  "createDate": "2026-03-25T16:48:48.711Z",
  "updateDate": "2026-03-25T16:48:48.711Z",
  "uuid": "fd51a3a7-ad99-4699-8de8-0c0ccb300aab",
  "name": "Test Module with two blocks",
  "description": "Description for the test module",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "codeVersion": "1.0.0",
  "type": "CUSTOM",
  "config": {
    "name": "Test Module with two blocks",
    "description": "Description for the test module",
    "blockType": "module",
    "permissions": [],
    "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
    "tag": "Module",
    "children": [
      {
        "id": "4242c579-891b-437d-8cef-61696c2baf2a",
        "blockType": "interfaceContainerBlock",
        "defaultActive": true,
        "permissions": [],
        "onErrorAction": "no-action",
        "uiMetaData": {
          "type": "blank",
          "title": "Main page"
        },
        "tag": "Module:Main_container_block",
        "children": [
          {
            "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
            "blockType": "interfaceContainerBlock",
            "defaultActive": true,
            "permissions": [],
            "onErrorAction": "no-action",
            "uiMetaData": {
              "type": "blank",
              "title": "Child page"
            },
            "tag": "Module:Child_container_block",
            "children": [],
            "events": [],
            "artifacts": []
          }
        ],
        "events": [],
        "artifacts": []
      }
    ],
    "events": [],
    "artifacts": [],
    "variables": [],
    "inputEvents": [],
    "outputEvents": [],
    "innerEvents": []
  },
  "id": "69c411f0ae73da728c8d8f99"
}

Imports new module from a zip file.

post

Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
string · binaryOptional
Responses
201

Created module.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
post/modules/import/file
POST /api/v1/modules/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "createDate": "2026-03-25T16:34:31.456Z",
  "updateDate": "2026-03-25T16:34:31.456Z",
  "uuid": "70f318e1-d505-4b7b-ac9c-9184839f0072",
  "name": "Device configuration module",
  "description": "Part of devices flow",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "codeVersion": "1.0.0",
  "type": "CUSTOM",
  "config": {
    "name": "Device configuration module",
    "description": "Part of devices flow",
    "blockType": "module",
    "permissions": [],
    "id": "3dc74d7b-eae8-49a5-84d5-c267c1fd8d06",
    "tag": "Module",
    "children": [],
    "events": [],
    "artifacts": [],
    "variables": [],
    "inputEvents": [],
    "outputEvents": [],
    "innerEvents": []
  },
  "id": "69c40e97ae73da728c8d8f78"
}

Imports new module from IPFS.

post

Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequired

Hedera topic message id

Responses
200

Module preview.

application/json
messageIdstringRequired
schemasobject[] · nullableRequired
tagsobject[] · nullableRequired
moduleTopicIdstring · nullableRequired
post/modules/import/message/preview
POST /api/v1/modules/import/message/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1774456966.828228000"
}
{
  "module": {
    "updateDate": "2026-03-25T16:42:26.445Z",
    "name": "Test Module with two blocks",
    "description": "Description for the test module",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "config": {
      "name": "Test Module with two blocks",
      "description": "Description for the test module",
      "blockType": "module",
      "permissions": [],
      "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
      "tag": "Module",
      "children": [
        {
          "id": "4242c579-891b-437d-8cef-61696c2baf2a",
          "blockType": "interfaceContainerBlock",
          "defaultActive": true,
          "permissions": [],
          "onErrorAction": "no-action",
          "uiMetaData": {
            "type": "blank",
            "title": "Main page"
          },
          "tag": "Module:Main_container_block",
          "children": [
            {
              "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
              "blockType": "interfaceContainerBlock",
              "defaultActive": true,
              "permissions": [],
              "onErrorAction": "no-action",
              "uiMetaData": {
                "type": "blank",
                "title": "Child page"
              },
              "tag": "Module:Child_container_block",
              "children": [],
              "events": [],
              "artifacts": []
            }
          ],
          "events": [],
          "artifacts": []
        }
      ],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    }
  },
  "tags": [],
  "schemas": [],
  "messageId": "1774456966.828228000",
  "moduleTopicId": "0.0.8373989"
}

Imports new module from a zip file.

post

Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
string · binaryOptional
Responses
200

Module preview.

application/json
schemasobject[] · nullableRequired
tagsobject[] · nullableRequired
post/modules/import/file/preview
POST /api/v1/modules/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "module": {
    "updateDate": "2026-03-25T12:22:27.680Z",
    "name": "Device configuration module",
    "description": "Part of devices flow",
    "creator": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.3578734",
    "owner": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.3578734",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "config": {}
  },
  "tags": [],
  "schemas": []
}

Publishes the module onto IPFS.

put

Publishes the module with the specified (internal) module ID onto IPFS, sends a message featuring its IPFS CID into the corresponding Hedera topic. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
200

Successful operation.

application/json
isValidbooleanRequired

Whether validation passed and the module was published

put/modules/{uuid}/publish
PUT /api/v1/modules/{uuid}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "module": {
    "createDate": "2026-03-25T17:11:30.244Z",
    "updateDate": "2026-03-25T17:12:17.150Z",
    "uuid": "8310f001-8fdc-43bb-8ad0-bcd43ca17363",
    "name": "Test Module with two blocks",
    "description": "Description for the test module",
    "status": "PUBLISHED",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "topicId": "0.0.8375153",
    "messageId": "1774458729.161736000",
    "codeVersion": "1.0.0",
    "type": "CUSTOM",
    "contentFileId": "69c4175cae73da728c8d8fad",
    "config": {
      "name": "Test Module with two blocks",
      "description": "Description for the test module",
      "blockType": "module",
      "permissions": [],
      "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
      "tag": "Module",
      "children": [
        {
          "id": "4242c579-891b-437d-8cef-61696c2baf2a",
          "blockType": "interfaceContainerBlock",
          "defaultActive": true,
          "permissions": [],
          "onErrorAction": "no-action",
          "uiMetaData": {
            "type": "blank",
            "title": "Main page"
          },
          "tag": "Module:Main_container_block",
          "children": [
            {
              "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
              "blockType": "interfaceContainerBlock",
              "defaultActive": true,
              "permissions": [],
              "onErrorAction": "no-action",
              "uiMetaData": {
                "type": "blank",
                "title": "Child page"
              },
              "tag": "Module:Child_container_block",
              "children": [],
              "events": [],
              "artifacts": []
            }
          ],
          "events": [],
          "artifacts": []
        }
      ],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    },
    "id": "69c41742ae73da728c8d8fa6"
  },
  "isValid": true,
  "errors": {
    "errors": [],
    "blocks": [
      {
        "id": "4242c579-891b-437d-8cef-61696c2baf2a",
        "name": "interfaceContainerBlock",
        "errors": [],
        "warnings": [],
        "infos": [],
        "isValid": true
      },
      {
        "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
        "name": "interfaceContainerBlock",
        "errors": [],
        "warnings": [],
        "infos": [],
        "isValid": true
      }
    ],
    "tools": [],
    "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
    "isValid": true
  }
}

Validates selected module.

post

Validates selected module. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
200

Validation result.

application/json
post/modules/validate
POST /api/v1/modules/validate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1272

{
  "id": "69c411f0ae73da728c8d8f99",
  "uuid": "fd51a3a7-ad99-4699-8de8-0c0ccb300aab",
  "name": "Test Module with two blocks",
  "description": "Description for the test module",
  "status": "DRAFT",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
  "codeVersion": "1.0.0",
  "createDate": "2026-03-25T16:48:48.711Z",
  "config": {
    "name": "Test Module with two blocks",
    "description": "Description for the test module",
    "blockType": "module",
    "permissions": [],
    "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
    "tag": "Module",
    "children": [
      {
        "id": "4242c579-891b-437d-8cef-61696c2baf2a",
        "blockType": "interfaceContainerBlock",
        "defaultActive": true,
        "permissions": [],
        "onErrorAction": "no-action",
        "uiMetaData": {
          "type": "blank",
          "title": "Main page"
        },
        "tag": "Module:Main_container_block",
        "children": [
          {
            "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
            "blockType": "interfaceContainerBlock",
            "defaultActive": true,
            "permissions": [],
            "onErrorAction": "no-action",
            "uiMetaData": {
              "type": "blank",
              "title": "Child page"
            },
            "tag": "Module:Child_container_block",
            "children": [],
            "events": [],
            "artifacts": []
          }
        ],
        "events": [],
        "artifacts": []
      }
    ],
    "events": [],
    "artifacts": [],
    "variables": [],
    "inputEvents": [],
    "outputEvents": [],
    "innerEvents": []
  }
}
{
  "results": {
    "errors": [],
    "blocks": [
      {
        "id": "4242c579-891b-437d-8cef-61696c2baf2a",
        "name": "interfaceContainerBlock",
        "errors": [],
        "warnings": [],
        "infos": [],
        "isValid": true
      },
      {
        "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
        "name": "interfaceContainerBlock",
        "errors": [],
        "warnings": [],
        "infos": [],
        "isValid": true
      }
    ],
    "tools": [],
    "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
    "isValid": true
  },
  "module": {
    "id": "69c411f0ae73da728c8d8f99",
    "uuid": "fd51a3a7-ad99-4699-8de8-0c0ccb300aab",
    "name": "Test Module with two blocks",
    "description": "Description for the test module",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8361161",
    "codeVersion": "1.0.0",
    "createDate": "2026-03-25T16:48:48.711Z",
    "config": {
      "name": "Test Module with two blocks",
      "description": "Description for the test module",
      "blockType": "module",
      "permissions": [],
      "id": "cd87187f-26aa-4dfb-994f-12ad810dc952",
      "tag": "Module",
      "children": [
        {
          "id": "4242c579-891b-437d-8cef-61696c2baf2a",
          "blockType": "interfaceContainerBlock",
          "defaultActive": true,
          "permissions": [],
          "onErrorAction": "no-action",
          "uiMetaData": {
            "type": "blank",
            "title": "Main page"
          },
          "tag": "Module:Main_container_block",
          "children": [
            {
              "id": "e851686a-9cd6-4fb0-b3da-3a9e33c54af9",
              "blockType": "interfaceContainerBlock",
              "defaultActive": true,
              "permissions": [],
              "onErrorAction": "no-action",
              "uiMetaData": {
                "type": "blank",
                "title": "Child page"
              },
              "tag": "Module:Child_container_block",
              "children": [],
              "events": [],
              "artifacts": []
            }
          ],
          "events": [],
          "artifacts": []
        }
      ],
      "events": [],
      "artifacts": [],
      "variables": [],
      "inputEvents": [],
      "outputEvents": [],
      "innerEvents": []
    }
  }
}
PreviousTools
NextFormulas

Last updated

Was this helpful?