Museum logo
API docs by Redocly

Nodex (4.2.0)

Download OpenAPI specification:Download

Get DID by device name

query Parameters
device_name
required
string
Example: device_name=device-001

The name of the device to retrieve the associated DID

Responses

Response samples

Content type
application/json
{
  • "did": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678"
}

Create a DID

Responses

Response samples

Content type
application/json
{
  • "@context": [],
  • "id": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
  • "verificationMethod": [
    ]
}

Get a DID

Responses

Response samples

Content type
application/json
{
  • "@context": [],
  • "id": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
  • "verificationMethod": [
    ]
}

Create a didcomm message

Request Body schema: application/json
required
destination-did
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "destination-did": "did:webvh:QmAbc123DefGhi456JklMno789PqrStu012VwxYz345AbcDef:example.com:webvh:v1:12345678-1234-5678-9abc-def012345678",
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "ciphertext": "mWtb1lJCP...",
  • "iv": "lHZvdNm4bJt2eR9xoAA4pWMPuojvqZEb",
  • "protected": "eyJ0eXAiOi...",
  • "recipients": [
    ],
  • "tag": "uasZqeLyqI9kPObyHSFzeA"
}

Verify a didcomm message

Request Body schema: application/json
required
ciphertext
string
iv
string
protected
string
Array of objects
tag
string

Responses

Request samples

Content type
application/json
{
  • "ciphertext": "mWtb1lJCP...",
  • "iv": "lHZvdNm4bJt2eR9xoAA4pWMPuojvqZEb",
  • "protected": "eyJ0eXAiOi...",
  • "recipients": [
    ],
  • "tag": "uasZqeLyqI9kPObyHSFzeA"
}

Response samples

Content type
application/json
{
  • "created_at": "2025-05-29T12:34:56.789012345+00:00",
  • "message_id": "12345678-abcd-ef01-2345-6789abcdef01",
  • "payload": "{\"message\": {\"string\": \"example_value\", \"number\": 42, \"boolean\": false, \"array\": [\"alpha\", \"beta\", \"gamma\"], \"map\": {\"sample_key\": \"sample_value\"}}}"
}

Create events

Request Body schema: application/json
required
Array
key
required
string (Key)
detail
required
string (Detail) <= 255 characters
occurred_at
required
number <date-time> (Occurred At)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "key is required"
}

Create custom metrics

Request Body schema: application/json
required
Array
key
required
string (Key)
value
required
number <float> (Value)
occurred_at
required
number <date-time> (Occurred At)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "key is required"
}

Create logs

Request Body schema: application/json
required
Array
key
required
string (Key)
message
required
string (Message) <= 1048576 characters
occurred_at
required
number <date-time> (Occurred At)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "message is required"
}

Create an attribute

Request Body schema: application/json
required
key_name
required
string (Key name)
value
required
string (Value)

Responses

Request samples

Content type
application/json
{
  • "key_name": "test-key-name",
  • "value": "test-value"
}

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "key_name is required"
}

Execute device key operation

Triggers execution of any pending device key operations that have been reserved for this device. This can be used to manually trigger operations instead of waiting for the automatic polling mechanism.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": 1111,
  • "message": "Internal Server Error"
}